Developers
Uploads6

Complete an upload

POST/uploads/{upload_id}/completions

Completes a multipart upload after all parts have been sent to the storage service. Provide every part number together with the ETag returned by the storage service for that part.

The storage service verifies the integrity of the assembled content. On success, the session moves to completed and the response includes the resulting file.

If the content does not match the declared size, checksum, or content type, the API returns upload_integrity_mismatch with the exact cause in details[].reason. The session is then permanently marked as failed, and a new upload session is required.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

upload_id*string

Public ID of the upload, prefixed with upl_.

Header Parameters

Idempotency-Key*string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

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.

Lengthlength <= 64

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

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/uploads/string/completions" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "parts": [      {        "etag": "string",        "part_number": 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"  }}

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.

List upload parts GET

Lists the parts that the storage service has already received for the upload session. Use this operation to resume an interrupted upload without resending parts that were already received. The result always reflects the current state reported by the storage service.