Video Onboarding
Tool to illustrate in real time the progress of the inspection of a vehicle.
- Allows to guide the user in the use of the video.
- Shows the user’s progress through the vehicle estimation process.
- Offers the possibility of obtaining an improved video thanks to AI.
Upload the walkaround with POST /v1/uploads, then submit its reference here. The clip is
indexed into the capture steps of a walkaround, each step resolving to its best usable
frame — those frames are what the rest of the pipeline consumes. wait=true is not
supported.
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.
Headers
Client-generated key (a UUID is ideal) making this POST safe to retry. The first request
is executed and its response stored for 24 h; any replay with the same key returns that
stored response with Idempotent-Replayed: true and bills nothing. Reusing a key with a
different payload is a 409 idempotency_key_reuse.
8 - 255Steers the fixture backend. Ignored by live keys, 400 test_scenario_not_supported if the
scenario is unknown to the endpoint. Common catalogue:
Some endpoints add their own scenarios; unsupported common scenarios (for example
empty_result on a generation endpoint) are rejected rather than silently ignored.
"empty_result"
"low_confidence"
"model_error"
"slow"
"insufficient_credits"
Body
MP4 or MOV, 10 MB maximum inline — walkarounds are almost always larger, so prefer /v1/uploads and the JSON encoding.
Capture steps to look for. Defaults to the eight exterior angles.
front, front_left, left, rear_left, rear, rear_right, right, front_right, dashboard, interior_front, interior_rear, boot, engine_bay Also return a stabilised, colour-corrected version of the clip.
Response
Job accepted, credits reserved, work queued.
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.analyze, 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.
A walkaround clip indexed into the capture steps of an inspection: which steps are covered, which are missing, and the single best frame for each — those frames are what every downstream model consumes.
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"