Skip to main content
GET
Get Job Status

Authorizations

Authorization
string
header
required

Use Authorization: Bearer YOUR_API_KEY

Path Parameters

id
string
required

Job id returned as job.id / X-Job-Id when the job was created.

Response

Job envelope (pending, completed, or failed).

Returned by async-capable endpoints (202) and by GET /jobs/{id}. data holds the endpoint's normal result once status is completed; error is populated once status is failed.

job
object
required
data
object | null
required

The endpoint's normal result object once completed; null until then.

error
object | null
required

Populated once the job has failed; null otherwise.