get
/api/v2/jobs/{id}
Python SDK method:
client.jobs.get_job_status(job_id)

Get job status

Returns the current status of an async job. Returns 200 for in-progress (PENDING, QUEUED, RUNNING), terminal (FAILED, CANCELED), and DONE jobs. When the job is DONE, the result URL is available in the response body.

Input Parameters

NameLocationTypeValuesDescriptionValue Required
idpathstring-Resource identifier.Y

Success Responses

200 response: object

Current job status.

NameTypeDescription
errorobjectDetails about why the job failed (RFC 7807 format), or null if it succeeded.
idstringUnique job identifier.
linksobjectNavigation URLs for polling and result retrieval.
statusstringCurrent job lifecycle state: PENDING, QUEUED, RUNNING, DONE, FAILED, CANCELED, or NOT_FOUND.

Response Errors

HTTP Status CodeReason
400Problem Details error.
401Problem Details error.
429The request rate limit has been exceeded.
500Problem Details error.