Retrieve a job
The canonical way to collect a result. result is populated once status is succeeded;
on failed it stays null and error explains why. Inspection jobs additionally expose
stages[].
Poll no faster than once per second; webhooks exist precisely so you do not have to.
Authorizations
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.
Path Parameters
Job identifier.
Job identifier — job_ followed by a base58 string.
^job_[1-9A-HJ-NP-Za-km-z]{8,32}$"job_3ZxK9pQr7TnW"
Response
The job.
The unit of work of the API. Every inference call creates one, and every result is read
back from one — synchronously through wait=true, or later through GET /v1/jobs/{id}
or a webhook.
result is populated only in succeeded, error only in failed / expired.
stages is present on inspection jobs only.
Job identifier — job_ followed by a base58 string.
^job_[1-9A-HJ-NP-Za-km-z]{8,32}$"job_3ZxK9pQr7TnW"
"job"Dotted slug of a CarHub endpoint, the identifier used for jobs and usage.
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 Lifecycle of a job. queued → processing → 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.
queued, processing, succeeded, failed, expired, canceled false when the job was created with a chk_test_ key: fixture result, test credits.
Epoch seconds, UTC.
1755300000
When the job left the queue. Null while queued.
1755300000
When the job settled. Null until then.
1755300000
Exact model build that produced the result, as <model>@<release date>. Null until the job starts. Pin your regression tests to it.
"plate-reader@2026-08-01"
Credit accounting for the job. One credit equals one USD cent. reserved is held at
admission and charged is the real cost after settlement; unused credits are released.
Endpoint-specific payload, null until the job succeeds. See each endpoint's 200 / 202 schema for its exact shape.
Populated when status is failed or expired, null otherwise.
Per-stage progress. Present on inspections jobs only, absent everywhere else.
The X-Carhub-Test-Scenario that produced this job. Present on test-mode jobs that were steered by one, absent otherwise — a live job never carries it.
"low_confidence"