Skip to content
cadenya
Get started
API Reference
Uploads

Get an upload by ID

uploads.retrieve(id, **kwargs) -> Upload { info, metadata, spec }
GET/v1/workspaces/{workspaceId}/uploads/{id}

Retrieves the current state of an upload, including its lifecycle status

ParametersExpand Collapse
workspace_id: String
id: String
ReturnsExpand Collapse
class Upload { info, metadata, spec }

A 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.

info: UploadInfo { created_by, status, upload_url, upload_url_expires_at }
created_by: Profile { metadata, spec }

A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces.

metadata: AccountResourceMetadata { id, account_id, 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…”)

account_id: String

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

name: String

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

profile_id: String
external_id: String

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

labels: Hash[Symbol, String]

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

spec: ProfileSpec { type, email, name }

Configuration for a profile.

type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM

Whether this profile represents a human user, an API key, or a system principal.

formatenum
One of the following:
:PROFILE_TYPE_UNSPECIFIED
:PROFILE_TYPE_USER
:PROFILE_TYPE_API_KEY
:PROFILE_TYPE_SYSTEM
email: String

Email address of the profile. Required and unique within an account for user profiles.

name: String

Display name (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
upload_url: 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.

upload_url_expires_at: Time

Absolute time at which upload_url stops working.

formatdate-time
metadata: ResourceMetadata { id, account_id, created_at, 6 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…”)

account_id: String

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

created_at: Time

Timestamp when this resource was created

formatdate-time
name: String

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

profile_id: String

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

workspace_id: String

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

bundle_key: String

Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply.

external_id: String

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

labels: Hash[Symbol, String]

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

spec: UploadSpec { content_type, filename, size_bytes }
content_type: 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.

size_bytes: String

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

Get an upload by ID

require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

upload = cadenya.uploads.retrieve("id", workspace_id: "workspaceId")

puts(upload)
{
  "info": {
    "createdBy": {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "name": "name",
        "profileId": "profileId",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "spec": {
        "type": "PROFILE_TYPE_UNSPECIFIED",
        "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",
    "bundleKey": "bundleKey",
    "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_UNSPECIFIED",
        "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",
    "bundleKey": "bundleKey",
    "externalId": "externalId",
    "labels": {
      "foo": "string"
    }
  },
  "spec": {
    "contentType": "contentType",
    "filename": "filename",
    "sizeBytes": "sizeBytes"
  }
}