Skip to navigation

Get Job

View as Markdown

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 for Retry-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_id from 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_idstringRequiredformat: "uuid"

The job_id returned when the job was created.

Response

Successful Response
job_idstringformat: "uuid"
job_stateenum
  • Accepted: saved and in the queue.
  • Pending: back in the queue after a temporary internal problem.
  • Running: a worker is processing it.
  • Completed: result is ready.
  • Failed: error tells why.
Allowed values:
created_atstringformat: "date-time"
UTC time, RFC 3339.
completed_atstring or nullformat: "date-time"

Set when the job is Completed or Failed.

expires_atstring or nullformat: "date-time"

Set when the job is Completed or Failed: 7 days after completion. After this, GET returns 404.

errorobject or null

Set when the job is Failed.

resultobject or null

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