Create an upload
/uploadsOpens 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.
This operation requires an Idempotency-Key header. The Location header points to the created upload session.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/uploads" \ -H "Content-Type: application/json" \ -d '{ "filename": "string", "purpose": "string", "size_bytes": 0 }'{ "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" }}Uploads
Uploads in API v3: create an upload, retrieve an upload, cancel an upload, complete an upload, list upload parts, create upload part urls.
Retrieve an upload GET
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.