Get Job
Returns the state of a job and, when it is Completed, the result. A Failed job still returns 200, with the reason in error.
- Poll every 5 seconds or more, or use a callback. Each read counts in the key’s rate limit at the gateway: on
429, wait forRetry-After. - Results are kept for 7 days after completion. After that, this returns
404. - Any key of the organisation that created the job can read it.
- There is no route to list jobs, so keep the
job_idfrom Create Job.
Authentication
api-subscription-keystring
API Key authentication via header
OR
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
job_id
The job_id returned when the job was created.
Response
Successful Response
job_id
job_state
Accepted: saved and in the queue.Pending: back in the queue after a temporary internal problem.Running: a worker is processing it.Completed:resultis ready.Failed:errortells why.
Allowed values:
created_at
UTC time, RFC 3339.
completed_at
Set when the job is Completed or Failed.
expires_at
Set when the job is Completed or Failed: 7 days after completion. After this, GET returns 404.
error
Set when the job is Failed.
result
Set when the job is Completed.
Errors
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error