Jobs
This page describes the jobs
endpoint.
Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.
Get job status and output
POST
/jobs/statuses
Get the status and output of the provided jobs.
Payload parameters
jobIds
string
List of job IDs.
Yes
wait
integer
Number of seconds to wait before returning if all jobs have not yet completed. Use -1
to wait indefinitely. The default is 0
.
No
pollInterval
integer
Number of seconds to wait between subsequent polls. Ignored if not using wait
. The default is 1
. The minimum is 1
.
No
Response parameters
id
string
The job's globally unique identifier.
state
array[string]
The job state: active
, cancelled
, completed
, created
, expired
, failed
, or retry
.
output
string
The output of the job, if it exists.
Request example
The following request checks the status of the job specified in the payload.
Payload example
Response example
Last updated