Skip to main content
GET
Get task data or status
While a bulk task is running the response carries a progress object with total, completed, failed and processing counts of inputs, so you can tell a task that is advancing from one that is stuck. failed covers every finished input that produced no data, clean misses included. It is omitted for single (non-bulk) runs.
Pass include_partial=true to also get back the rows that have already finished, without waiting for the rest. It is off by default because it makes every poll read the whole result set. Partial data covers only the finished rows, so it is not aligned to your inputs.
A task that is going nowhere can be stopped with Cancel a task, which also refunds what its unfinished requests reserved.

Headers

x-apikey
any
required

API Key for authentication

Path Parameters

task_id
string
required

The unique identifier of the task whose status you are querying.

Query Parameters

include_partial
boolean
default:false

While a bulk task is still running, also return the rows that have already finished. Off by default: it makes every poll read the whole result set.

Response

The task status along with any associated data or errors.

task_id
string
required

Unique identifier of the task.

status
string
required

Current status of the request. Can be 'processing', 'completed', 'partially_completed', 'failed' or 'cancelled'.

request_id
string | null
deprecated

Deprecated: use task_id instead. Same value as task_id.

progress
Progress · object | null

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.

data

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

Error message if the request has failed.

credits_spent
number
default:0

Total credits spent for this request.