Cancel an async analysis task
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.
Authentication
x-api-keystring
Your API key.
Note
You can find your API key on the API Keys page.
Path parameters
task_id
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_id
The unique identifier of the analysis task.
status
The final status of the task.
Allowed values:
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error