Skip to main content
GET
List jobs

Authorizations

Authorization
string
header
required

Organisation API key, sent as Authorization: Bearer chk_live_….

  • chk_live_… — real inference, real credits, livemode: true.
  • chk_test_… — identical pipeline against the fixture backend, test credits, livemode: false.

Keys are stored hashed; only the prefix (chk_live_a1b2…) is ever displayed again. A key may be scoped to a subset of endpoint families — calling outside its scopes is a 403.

Query Parameters

limit
integer
default:20

Page size.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor from the next_cursor of the previous page. Do not construct or parse it.

Maximum string length: 255
status
enum<string>[]

Keep only jobs in this status. Repeat the parameter to accept several.

Maximum array length: 6

Lifecycle of a job. queuedprocessing → one of succeeded | failed; expired when it was never picked up in time, canceled when it was cancelled before starting. The three settled states are terminal.

Available options:
queued,
processing,
succeeded,
failed,
expired,
canceled
endpoint
enum<string>

Keep only rows for this endpoint, given as its dotted slug. Dotted slug of a CarHub endpoint, the identifier used for jobs and usage.

Available options:
vehicle.analyse,
vehicle.segment,
vehicle.identify,
vin.read,
plate.read,
document.read,
dashboard.read,
engine.detect,
video.onboard,
damage.detect,
damage.severity,
tire.read,
tire.detect,
parts.recognize,
parts.segment,
parts.decompose,
pricing.vehicle,
pricing.repair,
render.background,
render.enhance,
render.plate,
render.360,
render.video,
viewer.hotspots,
inspections
created_after
integer<int64>

Keep records created strictly after this epoch second.

created_before
integer<int64>

Keep records created strictly before this epoch second.

Response

A page of jobs.

Cursor pagination, used by every list in this API. Ask for the next page by passing next_cursor back as cursor; stop when has_more is false. Cursors are opaque and stable across inserts — never build one yourself.

data
Job · object[]
required
has_more
boolean
required
next_cursor
string | null
required

Cursor of the next page, null on the last one.