Delete a batch | TwelveLabs

Use this method to delete a batch and all the tasks associated with it. You can only delete batches with status completed, canceled, or expired.

Deleting a batch does not affect billing. You are billed for every completed analysis regardless of whether you delete the batch afterward.

To stop a batch with the pending or processing status, use the POST method of the /analyze/batches/{batch_id}/cancel endpoint.

Batches are deleted 30 days after creation.

Use this method to delete a batch and all the tasks associated with it. You can only delete batches with status `completed`, `canceled`, or `expired`. Deleting a batch does not affect billing. You are billed for every completed analysis regardless of whether you delete the batch afterward. To stop a batch with the `pending` or `processing` status, use the [`POST`](/v1.3/api-reference/analyze-videos/batch-analysis/cancel-batch) method of the `/analyze/batches/{batch_id}/cancel` endpoint. Batches are deleted 30 days after creation.

Authentication

x-api-keystring

Your API key.

Note

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

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

Path parameters

batch_idstringRequiredformat: "^[0-9a-fA-F]{24}$"

The unique identifier of the batch.

Response

If successful, this method returns a 204 No Content response code. It does not return anything in the response body.

Errors

404

Not Found Error

409

Conflict Error