Create an upload

client.uploads.create(, ?): Upload { info, metadata, spec }

POST/v1/uploads

Issues a short-lived presigned URL for direct upload to object storage. The returned id is used to reference the upload from resources that accept binary content.

ParametersExpand Collapse

body: UploadCreateParams { metadata, spec }

metadata: CreateResourceMetadata { name, externalId, labels }

CreateResourceMetadata contains the user-provided fields for creating a workspace-scoped resource. Read-only fields (id, account_id, workspace_id, profile_id, created_at) are excluded since they are set by the server.

Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool")

externalId?: string

External ID for the resource (e.g., a workflow ID from an external system)

labels?: Record<string, string>

Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}

spec: UploadSpec { contentType, filename, sizeBytes }

contentType: string

MIME type the client will send. Baked into the presigned URL's signature — the PUT must match exactly or object storage will reject it.

filename: string

Client-supplied filename. Used for audit and display only; does not control the object's storage path.

sizeBytes: string

Expected size of the upload in bytes. Baked into the presigned URL as a Content-Length constraint.

ReturnsExpand Collapse

Upload { info, metadata, spec }

Upload is a workspace-scoped handle representing a single file upload flow. Clients call CreateUpload to receive a short-lived presigned URL, PUT the file directly to object storage, then reference the upload by id when creating or updating resources that accept binary content.

Uploads are one-shot: once consumed by a creating or updating resource, the upload transitions to UPLOAD_STATUS_CONSUMED and cannot be reused. Unused uploads expire and are garbage-collected by the runtime.

info: UploadInfo { createdBy, status, uploadUrl, uploadUrlExpiresAt }

createdBy?: Profile { metadata, spec }

Profile represents a human user at the account level. Profiles are account-scoped resources that can be associated with multiple workspaces through the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).

metadata: AccountResourceMetadata { id, accountId, name, 3 more }

AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

id: string

Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...")

accountId: string

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly

profileId: string

externalId?: string

External ID for the resource (e.g., a workflow ID from an external system)

labels?: Record<string, string>

Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}

spec: ProfileSpec { type, email, name }

ProfileSpec contains the profile-specific fields

type: "PROFILE_TYPE_USER" | "PROFILE_TYPE_API_KEY" | "PROFILE_TYPE_SYSTEM"

Type is the type of profile. User's are humans, API keys are computers. You know the deal.

formatenum

One of the following:

"PROFILE_TYPE_USER"

"PROFILE_TYPE_API_KEY"

"PROFILE_TYPE_SYSTEM"

email?: string

Email address of the user (required, unique per account)

name?: string

Display name for the user (e.g., "Bobby Tables")

status?: "UPLOAD_STATUS_UNSPECIFIED" | "UPLOAD_STATUS_PENDING" | "UPLOAD_STATUS_COMPLETE" | 2 more

Lifecycle state. Transitions PENDING → COMPLETE (storage confirms the object exists) → CONSUMED (a resource referenced this upload), or → EXPIRED (URL elapsed without a PUT).

formatenum

One of the following:

"UPLOAD_STATUS_UNSPECIFIED"

"UPLOAD_STATUS_PENDING"

"UPLOAD_STATUS_COMPLETE"

"UPLOAD_STATUS_CONSUMED"

"UPLOAD_STATUS_EXPIRED"

uploadUrl?: string

Presigned PUT URL. Short-lived. The client must PUT with the exact Content-Type declared in the spec, and the body length must match size_bytes.

uploadUrlExpiresAt?: string

Absolute time at which upload_url stops working.

formatdate-time

metadata: ResourceMetadata { id, accountId, createdAt, 5 more }

Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

id: string

Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...")

accountId: string

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

createdAt: string

Timestamp when this resource was created

formatdate-time

Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly

profileId: string

ID of the actor (user or service account) that created this resource

workspaceId: string

Workspace this resource belongs to for organizational grouping (prefixed ULID)

externalId?: string

External ID for the resource (e.g., a workflow ID from an external system)

labels?: Record<string, string>

Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}

spec: UploadSpec { contentType, filename, sizeBytes }

contentType: string

MIME type the client will send. Baked into the presigned URL's signature — the PUT must match exactly or object storage will reject it.

filename: string

Client-supplied filename. Used for audit and display only; does not control the object's storage path.

sizeBytes: string

Expected size of the upload in bytes. Baked into the presigned URL as a Content-Length constraint.

Create an upload

import Cadenya from '@cadenya/cadenya';

const client = new Cadenya({
  apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted
});

const upload = await client.uploads.create({
  metadata: { name: 'name' },
  spec: {
    contentType: 'contentType',
    filename: 'filename',
    sizeBytes: 'sizeBytes',
  },
});

console.log(upload.info);

{
  "info": {
    "createdBy": {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "name": "name",
        "profileId": "profileId",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "spec": {
        "type": "PROFILE_TYPE_USER",
        "email": "email",
        "name": "name"
      }
    },
    "status": "UPLOAD_STATUS_UNSPECIFIED",
    "uploadUrl": "uploadUrl",
    "uploadUrlExpiresAt": "2019-12-27T18:11:19.117Z"
  },
  "metadata": {
    "id": "id",
    "accountId": "accountId",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "profileId": "profileId",
    "workspaceId": "workspaceId",
    "externalId": "externalId",
    "labels": {
      "foo": "string"
    }
  },
  "spec": {
    "contentType": "contentType",
    "filename": "filename",
    "sizeBytes": "sizeBytes"
  }
}

Returns Examples

{
  "info": {
    "createdBy": {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "name": "name",
        "profileId": "profileId",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "spec": {
        "type": "PROFILE_TYPE_USER",
        "email": "email",
        "name": "name"
      }
    },
    "status": "UPLOAD_STATUS_UNSPECIFIED",
    "uploadUrl": "uploadUrl",
    "uploadUrlExpiresAt": "2019-12-27T18:11:19.117Z"
  },
  "metadata": {
    "id": "id",
    "accountId": "accountId",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "name": "name",
    "profileId": "profileId",
    "workspaceId": "workspaceId",
    "externalId": "externalId",
    "labels": {
      "foo": "string"
    }
  },
  "spec": {
    "contentType": "contentType",
    "filename": "filename",
    "sizeBytes": "sizeBytes"
  }
}