Tasks
Task object
Definition
Some endpoints do not return a direct response. Instead they return a task_id
which will contain the results once ready. In most cases you will need to get the task until the status is not pending
. The status will then either be:
success
: in which case you can read thedata
field to access the expected response.error
: in which case theerror
field will contain an error message and thedata
field will be null.
Response
Get single task status
Definition
This endpoint retrieves the state of a given task.
Arguments
Code sample
Response
It returns a task object.
Get multiple task status
Definition
Retrieve several tasks status given their IDs.
Arguments
Code sample
Response
A paginated list of task objects.
Last updated