API ReferenceUpload contentMultipart uploads

Retrieve the status of an upload session

This method provides information about an upload session, including its current status, chunk-level progress, and completion state. Use this endpoint to: - Verify upload completion (`status` = `completed`) - Identify any failed chunks that require a retry - Monitor the upload progress by comparing `uploaded_size` with `total_size` - Determine if the session has expired - Retrieve the status information for each chunk You must call this method after reporting chunk completion to confirm the upload has transitioned to the `completed` status before using the asset.

Authentication

x-api-keystring
Your API key. <Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-key" target="_blank">API Key</a> page. </Note>

Path Parameters

upload_idstringRequired
The unique identifier of the upload session.

Query Parameters

pageintegerOptionalDefaults to 1

A number that identifies the page to retrieve.

Default: 1.

page_limitintegerOptionalDefaults to 10

The number of items to return on each page.

Default: 10. Max: 50.

Response

The status of your upload session has been successfully retrieved.
upload_idstring or null
The unique identifier of your upload session.
statusenum or null
The status of your upload session. This field can take one of the following values: - `active`: The upload session is currently in progress. Continue uploading and reporting the completion of each chunk. - `completed`: The upload session is finished, and your asset is now ready for use. - `failed`: The upload session has failed. You must restart with a new session. - `expired`: The upload session has expired after 24 hours, and you must create a new session.
Allowed values:
uploaded_chunkslist of objects or null
Detailed status for each chunk.
chunks_completedinteger or null

The number of chunks successfully uploaded and reported. When this value equals total_chunks, the status of your upload session transitions to completed.

chunks_failedinteger or null

The number of chunks that failed to upload. If the number is greater than 0, check the uploaded_chunks array for specific failures and retry those chunks.

chunks_pendinginteger or null

The number of chunks not yet successfully uploaded. This value is calculated as: total_chunks - chunks_completed - chunks_failed.

page_infoobject or null
An object that provides information about pagination.
total_sizeinteger or null
The size of your file in bytes. You provided this value when you created the upload session.
uploaded_sizeinteger or null
The number of bytes successfully uploaded
created_atstring or nullformat: "date-time"

A string representing the date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the resource was created.

updated_atstring or nullformat: "date-time"

A string representing the date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the resource was last updated.

Errors