Skip to content

User read upload

GET
/api/v1/uploads/{upload_id}

Inspect the original reservation and refresh temporary transfer instructions.

Credential scopes: uploads:read

Resource authority: Authenticated creator; private reservation ownership does not grant model or connector authority.

Retry: Reservation: retry original Idempotency-Key and body. Completion: retry original version_id or multipart:true intent. Current views may refresh temporary instructions; committed receipts retain their identities.

Guards: New reservations select multipart strictly above 64 MiB. Single-PUT ceiling, per-file policy, declaration and aggregate quotas are independent. Existing reservations retain transport and expiry.

Retain: Same account/assignment, source checksum and unchanged source bytes, original request/key, upload/artifact UUIDs, completion intent and confirmed parts.

Specific failures: 400 bad_request; 404 not_found: missing or unauthorized upload; 503 upload_unavailable

Next action: Preserve the original operation; inspect to reconcile uncertainty; use completed artifact identity after verification. Worked workflow

upload_id
required
string format: uuid

Creator-owned upload reservation.

Current pending/expired/completed state. Pending uploads can receive renewed PUT instructions. Completed uploads include their immutable completion receipt and issue no further transfer authority; expired uploads remain inspectable.

Media typeapplication/json
object
completion
One of:
null
reservation
required

Immutable creation receipt. Kept independently of renewable transfer secrets and current state so the same user/key continues to identify the same upload.

object
artifact_id
required

Reserved identity. Readiness requires a separate successful completion.

string format: uuid
checksum
required
object
algorithm
required

Only sha256 is supported.

string
Allowed values: sha256
checksum_type
required

Only full_object is supported; multipart checksums are not accepted.

string
Allowed values: full_object
value
required

Canonical base64 of the 32-byte SHA-256 digest.

string
>= 44 characters <= 44 characters /^[A-Za-z0-9+/]{42}[AEIMQUYcgkosw048]=$/
created_at
required
string format: date-time
expected_size_bytes
required
integer format: int64
expires_at
required
string format: date-time
logical_name
required
string
media_type
required
string
scientific_metadata
required
storage_destination_id
required
string
upload_id
required
string format: uuid
state
required
string
Allowed values: pending expired completed
transfer
required
One of:
object
expires_at
required
string format: date-time
request
required

Send exactly this method, URL, and headers. Contains temporary authorization; serialize only for the authorized transfer recipient and never log it.

object
expires_in_seconds
required
integer format: int64
headers
required
Array<array>
method
required
string
url
required
string
status
required
string
Allowed values: available
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Invalid path or query parameters.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Active user credential required.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

The credential does not permit this operation (insufficient_scope).

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Unknown and other-user upload IDs are indistinguishable.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

413: the request body exceeds the configured size limit.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Upload status could not be read before its deadline.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

An HTTP request failed; inspect the stable error code and request ID.

Media typeapplication/json

The common JSON body for errors returned by the HTTP application.

object
code
required

Stable machine-readable error code.

string
details
One of:
null
message
required

Safe explanation without internal errors or submitted input values.

string
request_id
required

Matches the response’s x-request-id header.

string
Cache-Control
string

No-store

x-request-id
string

Always present. A fresh server-generated UUID for this request; incoming IDs are ignored. On errors, this equals the response body’s request_id.

Documentation 205dcb3116ea · public sources 8c70356d340f · built .Download documentation identity.