Skip to navigation
Models and searchAnalyze and segment videosBatch analysis

Retrieve batch status

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.

Authentication

x-api-keystring

Your API key.

Note

You can find your API key on the API Keys page.

Path parameters

batch_idstringRequiredformat: "^[0-9a-fA-F]{24}$"
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
The unique identifier of the batch. Use this value to retrieve the batch status or results.
analysis_modeenum
The analysis mode applied to every item in this batch.
Allowed values:
model_namestring
The model used for every item in this batch.
statusenum

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

total_itemsinteger
The number of items submitted in the batch.
created_atstringformat: "date-time"
The date and time, in the RFC 3339 format, when the batch was created.
expires_atstringformat: "date-time"

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.

queued_itemsinteger

The number of items in the queued status.

processing_itemsinteger

The number of items in the processing status.

ready_itemsinteger
The number of items that completed successfully.
failed_itemsinteger
The number of items that failed.
canceled_itemsinteger

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.

completed_atstringOptionalformat: "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_atstringOptionalformat: "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_atstringOptionalformat: "date-time"

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

webhookslist of objectsOptional

The delivery status of each webhook endpoint for the batch completion notification. Present only after the platform sends the webhook notifications. To register webhooks, see the Webhooks page.

Errors

404
Not Found Error