Cancel a task
Stop a running task and refund what its unfinished requests reserved. Rows that already finished keep their results, so poll the task afterwards to collect them. A task that has already reached a terminal status returns 409.
data array holds only the finished rows, so unlike a completed bulk run it is not aligned to your inputs and cannot be joined back by position.Headers
API Key for authentication
Path Parameters
The unique identifier of the task to cancel.
Response
The task was cancelled.
Unique identifier of the task.
Current status of the request. Can be 'processing', 'completed', 'partially_completed', 'failed' or 'cancelled'.
Deprecated: use task_id instead. Same value as task_id.
How far a bulk run has got: total, completed, failed and processing counts of inputs. failed covers every finished input that produced no data, clean misses included. Omitted for single (non-bulk) runs.
Resulting data once completed. For bulk runs this is an array aligned to the inputs: one element per input, in the same order they were submitted, with null for inputs that returned no data (len(data) equals the number of inputs, and data[i] is the result for input i). A single (non-bulk) run returns the result object directly.
Error message if the request has failed.
Total credits spent for this request.