Use this method to request cancellation for a batch with the `pending` or `processing` status.
When you invoke this method, the platform performs the following steps:
- Cancels the items in the `queued` status.
- Finishes the analysis for the items in the `processing` status.
The batch status changes to `canceling` immediately, and to `canceled` after every item reaches `ready`, `failed`, or `canceled`. You are not billed for canceled or failed items.
Response
The platform accepted the cancellation request. Items already in the `processing` status continue until processing finishes. The batch status is `canceling` until every item reaches `ready`, `failed`, or `canceled`, then becomes `canceled`. The response shows the batch state at the time of the request. To confirm the batch is fully canceled, use the [`GET`](/v1.3/api-reference/analyze-videos/batch-analysis/retrieve-batch-status) method of the `/analyze/batches/{batch_id}` endpoint.
analysis_modeenum
The analysis mode applied to every item in this batch.
batch_idstring
The unique identifier of the batch. Use this value to retrieve the batch status or results.
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.
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.
failed_itemsinteger
The number of items that failed.
model_namestring
The model used for every item in this batch.
processing_itemsinteger
The number of items in the processing status.
queued_itemsinteger
The number of items in the queued status.
ready_itemsinteger
The number of items that completed successfully.
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.
canceled_atstringformat: "date-time"
The date and time, in the RFC 3339 format, when the batch status became canceled. Present only when the status is canceled.
completed_atstringformat: "date-time"
The date and time, in the RFC 3339 format, when the batch status became completed. Present only when the status is completed.
expired_atstringformat: "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 objects
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.
