> ## Documentation Index
> Fetch the complete documentation index at: https://cadenya.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Get an upload
> Poll an upload's status before you reference it, or re-fetch its signed URL to retry the PUT.
Read one [upload](/docs/api-reference/uploadservice/create-an-upload). Its two jobs: tell you whether the bytes have landed, and hand back the signed URL if you need to retry.
```typescript TypeScript theme={null}
const upload = await client.uploads.retrieve(uploadId, { workspaceId });
console.log(upload.info.status); // 'UPLOAD_STATUS_PENDING'
```
```go Go theme={null}
upload, err := client.Uploads.Get(ctx, uploadID,
cadenya.UploadGetParams{WorkspaceID: cadenya.String(workspaceID)})
fmt.Println(upload.Info.Status) // UPLOAD_STATUS_PENDING
```
```ruby Ruby theme={null}
upload = cadenya.uploads.retrieve(upload_id, workspace_id: workspace_id)
puts upload.info.status # UPLOAD_STATUS_PENDING
```
```bash cURL theme={null}
curl "https://api.cadenya.com/v1/workspaces/${WORKSPACE_ID}/uploads/${UPLOAD_ID}" \
-H "Authorization: Bearer ${CADENYA_API_KEY}"
```
## Poll for `COMPLETE` before referencing
If your create and your reference are decoupled, this is the endpoint you poll. A resource rejects an upload until its bytes are in, so wait for `UPLOAD_STATUS_COMPLETE`:
```typescript theme={null}
async function waitForUpload(uploadId: string) {
for (;;) {
const { info } = await client.uploads.retrieve(uploadId, { workspaceId });
if (info.status === 'UPLOAD_STATUS_COMPLETE') return;
if (info.status === 'UPLOAD_STATUS_EXPIRED') throw new Error('signed URL lapsed; create a new upload');
await new Promise((r) => setTimeout(r, 1000));
}
}
```
## The signed URL is not returned here. Capture it at create.
`info.uploadUrl` is a **field on the read, but its value is empty**. The signed URL, and `uploadUrlExpiresAt`, come back only on the [create](/docs/api-reference/uploadservice/create-an-upload) response. Measured: create returns a 1,018-character URL; a later `GET` returns the same field blank.
So there is no re-fetch. Hold the URL from create until the PUT succeeds. Lose it, or let it expire, and your only move is a new upload, not a `GET`. This endpoint tells you the *status* of an upload, never how to write to it.
## There is no download
The response carries `spec` (`filename`, `contentType`, `sizeBytes`), `info.status`, `info.createdBy`, and the empty `info.uploadUrl`. It does **not** carry a download URL. An upload is a way to get bytes *into* Cadenya and reference them by `upload_id`; it is not a file store you read back out. The resource that consumed the upload is what serves the content (a memory entry through `get_memory`, a tool result through its own read path).
A missing or wrong ID is a `404`.
## Related
The three-step flow, and the status lifecycle in full.
Where a completed `upload_id` gets referenced.
## OpenAPI
````yaml get /v1/workspaces/{workspaceId}/uploads/{id}
openapi: 3.1.0
info:
title: Cadenya API
description: API for the Cadenya Agent Runtime platform.
version: '1.0'
servers:
- url: https://api.cadenya.com
description: Production server
security:
- bearerAuth: []
tags:
- name: AIProviderKeyService
- name: APIKeyService
description: |-
Issue, rotate, disable, and revoke a workspace's API keys. Every key
belongs to exactly one workspace; the system-managed global account key is
managed via GlobalAPIKeyService instead.
- name: AccountService
description: >-
Manage the authenticated account. Accounts are the top-level
organizational
unit and contain one or more workspaces.
- name: AgentScheduleService
description: >-
Manage recurring schedules attached to agents. Schedules trigger
objectives
on a cadence defined by AgentScheduleSpec.Schedule.
- name: AgentService
description: >-
Manage AI agents within a workspace. Agents define AI behavior and tool
access.
- name: AgentVariationService
description: >-
Manage variations of an agent and their tool, sub-agent, and memory layer
assignments.
- name: GlobalAPIKeyService
description: |-
Manage the account's system-provisioned global API key. The global key is
the only key that spans every workspace; it is created by the system and
cannot be deleted, so the surface is retrieve, rotate, and the
disable/enable kill switch.
- name: MemoryService
description: >-
Manage memory layers and their entries. Layers are named containers that
can
be composed into an objective's memory cascade; entries are the keyed values
within a layer. System-managed layers (e.g., episodic layers created by the
runtime) cannot be mutated through this API.
- name: ModelService
description: |-
Manage LLM models available to a workspace. Models represent provider and
family pairs (e.g., "anthropic/claude-sonnet-4.6"). Workspaces are seeded
with the supported models and you can enable or disable each one.
- name: ObjectiveEventStreamsService
- name: ObjectiveService
- name: ProfilesService
description: |-
Operations on profiles, the account-level principals (users, API keys,
system) that authenticate against the API.
- name: SearchService
- name: TenantService
description: >-
Read and erase tenants and the subjects under them. Tenants and subjects
are
created by assertion — on objective creation or widget session mint — never
directly, so this service has no create or update: it exists to enumerate what
assertions have produced, and to destroy it on request.
- name: ToolService
description: >-
Manage tool sets and the tools they contain. Tool sets group related
tools,
and tools define specific capabilities available to agents.
When a tool set is managed, only API key actors can modify its tools; human
(profile) actors cannot.
- name: UploadService
description: |-
Issue short-lived presigned URLs for direct client-to-object-storage
uploads. Created uploads can be referenced by id when creating or updating
resources that accept binary content (e.g., MemoryEntry).
- name: WidgetService
description: |-
Manage embeddable chat widgets. A widget binds an agent to a globally
unique hostname with a per-widget origin allowlist; browsers reach it with
session tokens minted via WidgetSessionService.
- name: WidgetSessionService
description: >-
Mint and manage widget sessions. Session creation is server-to-server
only:
the customer's backend authenticates its visitor, asserts tenant/subject
context, attaches any per-visitor secrets, and receives a short-lived
bearer token the browser uses against the widget host.
- name: WorkspaceAdminService
description: >-
Administer workspaces across the account: create and archive workspaces
and
manage their membership. These operations are account-scoped and require the
admin role (a token whose profile holds the WorkOS admin role); they live
under /v1/account/workspaces rather than the workspace-scoped /v1/workspaces
tree so an admin can manage any workspace in the account, including ones they
are not themselves a member of.
- name: WorkspaceSecretService
- name: WorkspaceService
description: |-
Manage workspaces within an account. Workspaces provide organizational
grouping and isolation for resources such as agents, tools, and API keys.
This is the workspace-scoped, end-user surface. Administrative operations
(create / archive workspaces, manage members) live in WorkspaceAdminService
under /v1/account/workspaces and require the admin role.
paths:
/v1/workspaces/{workspaceId}/uploads/{id}:
get:
tags:
- UploadService
- Uploads
summary: Get an upload by ID
description: Retrieves the current state of an upload, including its lifecycle status
operationId: UploadService_GetUpload
parameters:
- name: workspaceId
in: path
description: Workspace ID.
required: true
schema:
type: string
example: workspace_01HXKD2E5NQM3T9AYWCF133E3Q
- name: id
in: path
required: true
schema:
example: upload_01HXKD2E5NQM3T9AYWCFZ05DNK
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Upload'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
x-codeSamples:
- lang: JavaScript
source: >-
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.retrieve('upload_01HXKD2E5NQM3T9AYWCFZ05DNK', {
workspaceId: 'workspace_01HXKD2E5NQM3T9AYWCF133E3Q',
});
console.log(upload.info);
- lang: Python
source: |-
import os
from cadenya import Cadenya
client = Cadenya(
api_key=os.environ.get("CADENYA_API_KEY"), # This is the default and can be omitted
)
upload = client.uploads.retrieve(
id="upload_01HXKD2E5NQM3T9AYWCFZ05DNK",
workspace_id="workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
)
print(upload.info)
- lang: Go
source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\t\"go.cadenya.com/cadenya-go\"\n\t\"go.cadenya.com/cadenya-go/option\"\n)\n\nfunc main() {\n\tclient := cadenya.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tupload, err := client.Uploads.Get(\n\t\tcontext.TODO(),\n\t\t\"upload_01HXKD2E5NQM3T9AYWCFZ05DNK\",\n\t\tcadenya.UploadGetParams{\n\t\t\tWorkspaceID: cadenya.String(\"workspace_01HXKD2E5NQM3T9AYWCF133E3Q\"),\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", upload.Info)\n}\n"
- lang: Ruby
source: |-
require "cadenya"
cadenya = Cadenya::Client.new(api_key: "My API Key")
upload = cadenya.uploads.retrieve(
"upload_01HXKD2E5NQM3T9AYWCFZ05DNK",
workspace_id: "workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
)
puts(upload)
- lang: CLI
source: |-
cadenya uploads retrieve \
--api-key 'My API Key' \
--workspace-id workspace_01HXKD2E5NQM3T9AYWCF133E3Q \
--id upload_01HXKD2E5NQM3T9AYWCFZ05DNK
components:
schemas:
Upload:
required:
- metadata
- spec
- info
type: object
properties:
metadata:
$ref: '#/components/schemas/ResourceMetadata'
spec:
$ref: '#/components/schemas/UploadSpec'
info:
$ref: '#/components/schemas/UploadInfo'
description: >-
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.
Status:
type: object
properties:
code:
type: integer
description: >-
The status code, which should be an enum value of
[google.rpc.Code][google.rpc.Code].
format: int32
message:
type: string
description: >-
A developer-facing error message, which should be in English. Any
user-facing error message should be localized and sent in the
[google.rpc.Status.details][google.rpc.Status.details] field, or
localized by the client.
details:
type: array
items:
$ref: '#/components/schemas/GoogleProtobufAny'
description: >-
A list of messages that carry the error details. There is a common
set of message types for APIs to use.
description: >-
The `Status` type defines a logical error model that is suitable for
different programming environments, including REST APIs and RPC APIs. It
is used by [gRPC](https://github.com/grpc). Each `Status` message
contains three pieces of data: error code, error message, and error
details. You can find out more about this error model and how to work
with it in the [API Design
Guide](https://cloud.google.com/apis/design/errors).
ResourceMetadata:
required:
- id
- accountId
- workspaceId
- name
- profileId
- createdAt
type: object
properties:
id:
readOnly: true
type: string
description: >-
Unique identifier for the resource (prefixed ULID, e.g.,
"agent_01HXK...")
accountId:
readOnly: true
example: account_01HXKD2E5NQM3T9AYWCFTJHJVF
type: string
description: >-
Account this resource belongs to for multi-tenant isolation
(prefixed ULID)
workspaceId:
readOnly: true
example: workspace_01HXKD2E5NQM3T9AYWCF133E3Q
type: string
description: >-
Workspace this resource belongs to for organizational grouping
(prefixed ULID)
name:
type: string
description: >-
Human-readable name for the resource (e.g., "Customer Support
Agent", "Email Tool")
Required for resources that users interact with directly
externalId:
type: string
description: >-
External ID for the resource (e.g., a workflow ID from an external
system)
labels:
type: object
additionalProperties:
type: string
description: |-
Key-value pairs for categorization and filtering. Values are 0-63
alphanumeric characters with "-", "_", or "." allowed between; keys
follow the same shape and additionally accept an optional DNS-subdomain
prefix (e.g. "cadenya.com/") of at most 253 characters.
Examples: {"environment": "production", "team": "platform", "version": "v2"}
profileId:
readOnly: true
example: profile_01HXKD2E5NQM3T9AYWCFS0AP08
type: string
description: ID of the actor (user or service account) that created this resource
createdAt:
readOnly: true
type: string
description: Timestamp when this resource was created
format: date-time
updatedAt:
readOnly: true
type: string
description: Timestamp when this resource was last updated
format: date-time
description: >-
Standard metadata for persistent, named resources (e.g., agents, tools,
prompts)
UploadSpec:
required:
- filename
- contentType
- sizeBytes
type: object
properties:
filename:
type: string
description: |-
Client-supplied filename. Used for audit and display only; does not
control the object's storage path.
contentType:
type: string
description: >-
MIME type the client will send. Baked into the presigned URL's
signature
— the PUT must match exactly or object storage will reject it.
sizeBytes:
type: string
description: >-
Expected size of the upload in bytes. Baked into the presigned URL
as a
Content-Length constraint.
UploadInfo:
type: object
properties:
uploadUrl:
readOnly: true
type: string
description: |-
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:
readOnly: true
type: string
description: Absolute time at which upload_url stops working.
format: date-time
status:
readOnly: true
enum:
- UPLOAD_STATUS_UNSPECIFIED
- UPLOAD_STATUS_PENDING
- UPLOAD_STATUS_COMPLETE
- UPLOAD_STATUS_CONSUMED
- UPLOAD_STATUS_EXPIRED
type: string
description: >-
Lifecycle state. Transitions PENDING → COMPLETE (storage confirms
the
object exists) → CONSUMED (a resource referenced this upload), or
→ EXPIRED (URL elapsed without a PUT).
format: enum
createdBy:
$ref: '#/components/schemas/Profile'
GoogleProtobufAny:
type: object
properties:
'@type':
type: string
description: The type of the serialized message.
additionalProperties: true
description: >-
Contains an arbitrary serialized message along with a @type that
describes the type of the serialized message.
Profile:
required:
- metadata
- spec
type: object
properties:
metadata:
$ref: '#/components/schemas/AccountResourceMetadata'
spec:
$ref: '#/components/schemas/ProfileSpec'
description: |-
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.
AccountResourceMetadata:
required:
- id
- accountId
- name
- profileId
type: object
properties:
id:
readOnly: true
type: string
description: >-
Unique identifier for the resource (prefixed ULID, e.g.,
"apikey_01HXK...")
accountId:
readOnly: true
example: account_01HXKD2E5NQM3T9AYWCFTJHJVF
type: string
description: >-
Account this resource belongs to for multi-tenant isolation
(prefixed ULID)
name:
type: string
description: >-
Human-readable name for the resource (e.g., "Customer Support
Agent", "Email Tool")
Required for resources that users interact with directly
externalId:
type: string
description: >-
External ID for the resource (e.g., a workflow ID from an external
system)
labels:
type: object
additionalProperties:
type: string
description: |-
Key-value pairs for categorization and filtering. Values are 0-63
alphanumeric characters with "-", "_", or "." allowed between; keys
follow the same shape and additionally accept an optional DNS-subdomain
prefix (e.g. "cadenya.com/") of at most 253 characters.
Examples: {"environment": "production", "team": "platform", "version": "v2"}
profileId:
readOnly: true
example: profile_01HXKD2E5NQM3T9AYWCFS0AP08
type: string
createdAt:
readOnly: true
type: string
format: date-time
description: >-
AccountResourceMetadata is used to represent a resource that is
associated to an account but not to a workspace.
ProfileSpec:
required:
- type
type: object
properties:
email:
type: string
description: >-
Email address of the profile. Required and unique within an account
for
user profiles.
name:
type: string
description: Display name (e.g., "Bobby Tables").
type:
enum:
- PROFILE_TYPE_UNSPECIFIED
- PROFILE_TYPE_USER
- PROFILE_TYPE_API_KEY
- PROFILE_TYPE_SYSTEM
type: string
description: >-
Whether this profile represents a human user, an API key, or a
system
principal.
format: enum
description: Configuration for a profile.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
````