analyzeAsync > batches

Retrieve batch status

Changed on

Use this method to monitor a batch. The response includes the current batch status and counts for queued, processing, ready, failed, and canceled items.

Poll this method until the batch reaches the completed, canceled, or expired status. To retrieve the results, call the GET method of the /analyze/batches/{batch_id}/results endpoint.

Do not treat the completed status as a success signal. It means processing has finished for every item, not that every analysis succeeded. To see how many items succeeded, failed, or were canceled, check the ready_items, failed_items, and canceled_items fields. A batch never has the failed status.

get/analyze/batches/{batch_id}

Request

  • Base URL: https://api.twelvelabs.io/v1.3
  • URL: https://api.twelvelabs.io/v1.3/analyze/batches/{batch_id}
  • Auth: API key in header x-api-key

Path parameters

batch_idstring required

The unique identifier of the batch.

Response

Batch status retrieved successfully. The response includes batch details and item counts for each item status.

batch_idstring required

The unique identifier of the batch. Use this value to retrieve the batch status or results.

analysis_mode'general' | 'time_based_metadata' required

The analysis mode applied to every item in this batch.

model_namestring required

The model used for every item in this batch.

status'pending' | 'processing' | 'canceling' | 'canceled' | 'completed' | 'expired' required

The status of a batch. For the meaning of each value, see the Batch statuses section on the The batch object page.

total_itemsinteger required

The number of items submitted in the batch.

created_atstring date-time required

The date and time, in the RFC 3339 format, when the batch was created.

expires_atstring date-time required

The date and time, in the RFC 3339 format, when the batch expires (the created_at field value plus 24 hours). Unfinished items at expiration are canceled. Items that finished before then remain retrievable for 30 days after creation, when the batch and its results are deleted.

completed_atstring date-time

The date and time, in the RFC 3339 format, when the batch status became completed. Present only when the status is completed.

canceled_atstring date-time

The date and time, in the RFC 3339 format, when the batch status became canceled. Present only when the status is canceled.

expired_atstring date-time

The date and time, in the RFC 3339 format, when the batch status became expired. Present only when the status is expired.

queued_itemsinteger required

The number of items in the queued status.

processing_itemsinteger required

The number of items in the processing status.

ready_itemsinteger required

The number of items that completed successfully.

failed_itemsinteger required

The number of items that failed.

canceled_itemsinteger required

The number of items that were canceled, either because the batch was canceled while the item was in the queued status, or because the batch expired before the item finished processing.

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 retrieve removed and replaced with analyzeAsync_batches_retrieve