Skip to content

Fetch a job's current state

GET
/jobs/{id}
id
required
string format: uuid

The job

object
id
required
string format: uuid
type
required
string
Example
preview.raster
payload
object
key
additional properties
any
status
required
string
Allowed values: pending running done failed cancelled
priority
required
integer
attempts
required
integer
max_attempts
required
integer
claimed_by
string
nullable
claimed_at
string format: date-time
nullable
lease_expires_at
string format: date-time
nullable
last_error
string
nullable
result
object
key
additional properties
any
origin_server_id
string format: uuid
nullable
scheduled_for
string format: date-time
nullable
enqueued_at
required
string format: date-time
started_at
string format: date-time
nullable
finished_at
string format: date-time
nullable

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed