Skip to main content
GET
Get a job

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Path Parameters

jobId
string
required

The job's id, as the call that started it answered.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$

Response

The job.

id
string
required
type
enum<string>
required

What the job does.

Available options:
email_verification
status
enum<string>
required

running until the job ends as succeeded, failed or cancelled.

Available options:
running,
succeeded,
failed,
cancelled
units
object[]
required

What the job produced so far, by price item.

createdAt
string<date-time>
required
progress
object

How far the job got. Absent until it reports progress.

chargedUsd
string

What the job was charged, in US dollars as an exact six-decimal string. Present once it ended.

finishedAt
string<date-time>

When the job ended. Absent while it runs.