Skip to navigation

Read the current state of a job

Returns the current state of a job owned by the calling environment. This is the single polling surface for every product operation.

Honour Retry-After while the job is queued or running, and send the previous ETag back as If-None-Match to get 304 Not Modified instead of an unchanged body. A 404 means the job never existed in this environment or its retention window has passed; a 503 means ask again.

Authentication

X-API-Keystring

API key for one environment of your account. Keep server-side; never expose in browser clients.

Path parameters

job_idstringRequired

Headers

If-None-Matchstring or nullOptional

Response headers

Cache-ControlstringOptional
API responses are private to the caller and not cacheable
ETagstringOptional
Opaque version of the current job representation
Retry-AfterstringOptional

Delay before retrying, expressed as delta-seconds

X-Request-IdstringOptional
Request correlation identifier

Response

Current job state
completed_atdatetime or null
created_atdatetime
errorobject or null
expires_atdatetime or null
idstring
inputslist of objects
operationenum

What a job does: the operation’s authorization scope.

An operation is not its output’s type: OPERATION_OUTPUT_TYPE is the one place the two meet.

Allowed values:
outputobject or null
statusenum
Allowed values:
updated_atdatetime
livemodebooleanOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error