v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
analyzeAsync > batches

Delete a batch

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.

delete/analyze/batches/{batch_id}

Path parameters

batch_idstring required

The unique identifier of the batch.

Headers

x-api-keystring required

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>

Response

Successful response