multipartUpload

Report uploaded chunks

Changed on

This method reports successfully uploaded chunks to the platform. The platform finalizes the upload after you report all chunks.

For optimal performance, report chunks in batches and in any order.

post/assets/multipart-uploads/{upload_id}

Request

  • Base URL: https://api.twelvelabs.io/v1.3
  • URL: https://api.twelvelabs.io/v1.3/assets/multipart-uploads/{upload_id}
  • Auth: API key in header x-api-key

Path parameters

upload_idstring required

The unique identifier of the upload session.

Request body

Response

The completion of this batch has been successfully reported.

urlstring uri

The URL for accessing your asset. The platform returns this field only when all chunks are reported and the upload is complete. If absent, continue uploading and reporting the remaining chunks.

asset_idstring

The unique identifier of this asset.

processed_chunksinteger

The number of chunks accepted from this specific request. This equals the number of chunks in your completed_chunks array minus any duplicates.

duplicate_chunksinteger

The number of chunks in this request that were already reported. Duplicates are ignored and don't affect your upload.

total_completedinteger

The cumulative count of all unique chunks successfully reported across all requests. When this equals total_chunks, the upload is complete.

Changes

  • b8591e05c0baRevision changes
    • warning

      deleted the header request parameter x-api-key

    • info

      the endpoint scheme security x-api-key was added to the API

  • 6205c7327cdeRevision changes
    • info

      api operation id report-chunk-batch removed and replaced with multipartUpload_report_chunk_batch