analyzeAsync > batches

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}

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

Successful response

Changes