Sign in
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

Changes

Changed in 2 of the 9 revisions of this API.21

  • fd9d80e384a81See the full diff
    • ▲

      added the pattern ^[0-9a-fA-F]{24}$ to the path request parameter batch_id

      request-parameter-pattern-added

  • c0926990c66211See the full diff
    • ▲

      removed the success response with the status 204

      response-success-status-removed

    • ○

      added the success response with the status 200

      response-success-status-added

    This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog