Retrieve an upload
/uploads/{upload_id}Retrieves an upload session by its public ID, including its current status and expiration time. When the session is completed, the response includes the resulting file.
To see which parts the storage service has already received, use the list upload parts operation.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Public ID of the upload, prefixed with upl_.
Header Parameters
Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.
length <= 64Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/uploads/string"{ "data": { "expires_at": "2019-08-24T14:15:22Z", "failure_reason": "string", "file": { "checksum": { "md5": "string", "sha256": "string" }, "content_type": "string", "created_at": "2019-08-24T14:15:22Z", "extension": "string", "filename": "string", "id": "string", "object": "file", "purpose": "string", "size_bytes": 0, "status": "ready" }, "filename": "string", "id": "string", "object": "upload", "part_size": 0, "parts_total": 0, "purpose": "string", "size_bytes": 0, "status": "open" }}Create an upload POST
Opens a multipart upload session and returns the upload plan: the part size (`part_size`) and the number of parts (`parts_total`). The API never receives file content. Request presigned URLs through the upload parts operation and send each part directly to the storage service, then complete the upload to obtain the file. Files with `purpose` set to `import` must be Excel spreadsheets in the `.xlsx` format. Other formats, such as `.csv` or `.xls`, are rejected with `422 validation_failed`. This operation requires an `Idempotency-Key` header. The `Location` header points to the created upload session.
Cancel an upload PATCH
Cancels an open upload session. Set `status` to `cancelled`; no other change is supported. Sessions that are already completed, cancelled, failed, or expired cannot be cancelled and return `state_conflict`. To remove a file produced by a completed upload, use the delete file operation.