@radzor/s3-upload — LLM & AI Component | Radzor Registry

@radzor/s3-upload

Upload, download, and manage files on S3-compatible storage (AWS S3, MinIO, R2, DigitalOcean Spaces) using raw fetch with AWS Signature V4 signing.

Storagev0.1.0typescriptpythonServers3uploadstorageawsminior2filesby Radzor

Install

View source on GitHub →

$npx radzor@latest add s3-upload

⚠ Constraints: No external dependencies — implements AWS Signature V4 using Node.js crypto. For non-AWS providers, set the endpoint parameter. Object keys should not start with /. Maximum single PUT upload size is 5GB (use multipart for larger files).

Inputs

Name	Type	Default	Description
accessKeyId*	string	—	AWS access key ID.AWS_ACCESS_KEY_ID
secretAccessKey*	string	—	AWS secret access key.AWS_SECRET_ACCESS_KEY
region*	string	—	AWS region (e.g. us-east-1).AWS_REGION
bucket*	string	—	S3 bucket name.
endpoint	string	—	Custom S3-compatible endpoint URL (for MinIO, R2, Spaces, etc.).

Outputs

Name	Type	Description
uploadResult	{ key: string; etag: string; url: string }	Result of an upload operation. .keystring .etagstring .urlstring

uploadResult{ key: string; etag: string; url: string }

Result of an upload operation.

.keystring

.etagstring

.urlstring

radzor.manifest.json

{
  "llm": {
    "constraints": "No external dependencies — implements AWS Signature V4 using Node.js crypto. For non-AWS providers, set the endpoint parameter. Object keys should not start with /. Maximum single PUT upload size is 5GB (use multipart for larger files).",
    "usageExamples": "llm/examples.md",
    "integrationPrompt": "llm/integration.md"
  },
  "name": "@radzor/s3-upload",
  "tags": [
    "s3",
    "upload",
    "storage",
    "aws",
    "minio",
    "r2",
    "files"
  ],
  "events": [
    {
      "name": "onUploadComplete",
      "payload": {
        "key": "string",
        "etag": "string",
        "size": "number",
        "bucket": "string"
      },
      "description": "Fired when a file upload completes successfully."
    }
  ],
  "inputs": [
    {
      "name": "accessKeyId",
      "type": "string",
      "envVar": "AWS_ACCESS_KEY_ID",
      "required": true,
      "description": "AWS access key ID."
    },
    {
      "name": "secretAccessKey",
      "type": "string",
      "envVar": "AWS_SECRET_ACCESS_KEY",
      "required": true,
      "description": "AWS secret access key."
    },
    {
      "name": "region",
      "type": "string",
      "envVar": "AWS_REGION",
      "required": true,
      "description": "AWS region (e.g. us-east-1)."
    },
    {
      "name": "bucket",
      "type": "string",
      "required": true,
      "description": "S3 bucket name."
    },
    {
      "name": "endpoint",
      "type": "string",
      "required": false,
      "description": "Custom S3-compatible endpoint URL (for MinIO, R2, Spaces, etc.)."
    }
  ],
  "radzor": "1.0.0",
  "actions": [
    {
      "name": "upload",
      "params": [
        {
          "name": "key",
          "type": "string",
          "description": "Object key (path within bucket)."
        },
        {
          "name": "body",
          "type": "Buffer | string | ReadableStream",
          "description": "File content."
        },
        {
          "name": "contentType",
          "type": "string",
          "required": false,
          "description": "MIME type (default: application/octet-stream)."
        },
        {
          "name": "metadata",
          "type": "Record<string, string>",
          "required": false,
          "description": "Custom metadata headers (x-amz-meta-*)."
        }
      ],
      "returns": "Promise<{ key: string; etag: string; url: string }>",
      "description": "Upload a file to S3."
    },
    {
      "name": "download",
      "params": [
        {
          "name": "key",
          "type": "string",
          "description": "Object key to download."
        }
      ],
      "returns": "Promise<{ body: Buffer; contentType: string; etag: string }>",
      "description": "Download a file from S3."
    },
    {
      "name": "delete",
      "params": [
        {
          "name": "key",
          "type": "string",
          "description": "Object key to delete."
        }
      ],
      "returns": "Promise<void>",
      "description": "Delete an object from S3."
    },
    {
      "name": "listObjects",
      "params": [
        {
          "name": "prefix",
          "type": "string",
          "required": false,
          "description": "Key prefix to filter by."
        },
        {
          "name": "maxKeys",
          "type": "number",
          "required": false,
          "description": "Maximum number of results (default: 1000)."
        }
      ],
      "returns": "Promise<Array<{ key: string; size: number; lastModified: string }>>",
      "description": "List objects in the bucket with an optional prefix filter."
    },
    {
      "name": "getSignedUrl",
      "params": [
        {
          "name": "key",
          "type": "string",
          "description": "Object key."
        },
        {
          "name": "expiresIn",
          "type": "number",
          "required": false,
          "description": "URL validity in seconds (default: 3600)."
        }
      ],
      "returns": "Promise<string>",
      "description": "Generate a pre-signed URL for temporary access to a private object."
    }
  ],
  "outputs": [
    {
      "name": "uploadResult",
      "type": "{ key: string; etag: string; url: string }",
      "fields": [
        {
          "name": "key",
          "type": "string",
          "description": "Object key in the bucket."
        },
        {
          "name": "etag",
          "type": "string",
          "description": "ETag of the uploaded object."
        },
        {
          "name": "url",
          "type": "string",
          "description": "Public URL of the object."
        }
      ],
      "description": "Result of an upload operation."
    }
  ],
  "runtime": "server",
  "version": "0.1.0",
  "category": "storage",
  "languages": [
    "typescript",
    "python"
  ],
  "description": "Upload, download, and manage files on S3-compatible storage (AWS S3, MinIO, R2, DigitalOcean Spaces) using raw fetch with AWS Signature V4 signing.",
  "dependencies": {
    "radzor": [],
    "packages": {}
  },
  "composability": {
    "connectsTo": [
      {
        "output": "uploadResult",
        "mapField": "url",
        "compatibleWith": [
          "@radzor/email-send.action.send.message",
          "@radzor/slack-bot.action.sendMessage.text",
          "@radzor/notification-hub.action.send.body"
        ]
      },
      {
        "event": "onUploadComplete",
        "description": "Log upload completions",
        "compatibleWith": [
          "@radzor/log-aggregator.action.info.message",
          "@radzor/event-tracker.action.track.eventName"
        ]
      }
    ]
  }
}

@radzor/s3-upload

Install

Inputs

Outputs

Actions

Events

Composability

radzor.manifest.json