analyzeAsync > tasks

Cancel an async analysis task

Changed on

Use this method to cancel an asynchronous analysis task in your account. To cancel a task created as part of a batch, use the POST method of the /analyze/batches/{batch_id}/cancel endpoint.

You can cancel a task with the queued, pending, or processing status. This action cannot be undone.

Processing that has already started can continue briefly after cancellation.

When you cancel a task, the platform can send an analyze.task.canceled webhook. Delivery is best-effort: a 200 response is not a delivery guarantee. When you receive the event, retrieve the task for its current state.

post/analyze/tasks/{task_id}/cancel

Request

  • Base URL: https://api.twelvelabs.io/v1.3
  • URL: https://api.twelvelabs.io/v1.3/analyze/tasks/{task_id}/cancel
  • Auth: API key in header x-api-key

Path parameters

task_idstring required

The unique identifier of the analysis task you want to cancel.

Response

The task is canceled. This response is also returned when the task was canceled by a previous request.

task_idstring required

The unique identifier of the analysis task.

status'canceled' required

The final status of the task.

Changes