Full vehicle inspection (bundle)

curl --request POST \
  --url https://api.trycarhub.com/v1/inspections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form video='@example-file' \
  --form 'images=<string>' \
  --form 'vehicle={
  "make": "<string>",
  "model": "<string>",
  "version": "<string>",
  "year": 123,
  "mileage_km": 1,
  "vin": "<string>",
  "plate": "<string>"
}' \
  --form 'currency=<string>' \
  --form 'country=<string>' \
  --form labour_rate=1 \
  --form tax_rate_pct=1 \
  --form background=studio_white \
  --form hotspot_parts=front_bumper \
  --form images.items='@example-file'

import requests

url = "https://api.trycarhub.com/v1/inspections"

files = {
    "video": ("example-file", open("example-file", "rb")),
    "images.items": ("example-file", open("example-file", "rb"))
}
payload = {
    "images": "<string>",
    "vehicle": "{
  \"make\": \"<string>\",
  \"model\": \"<string>\",
  \"version\": \"<string>\",
  \"year\": 123,
  \"mileage_km\": 1,
  \"vin\": \"<string>\",
  \"plate\": \"<string>\"
}",
    "currency": "<string>",
    "country": "<string>",
    "labour_rate": "1",
    "tax_rate_pct": "1",
    "background": "studio_white",
    "hotspot_parts": "front_bumper"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('video', '<string>');
form.append('images', '<string>');
form.append('vehicle', '{
  "make": "<string>",
  "model": "<string>",
  "version": "<string>",
  "year": 123,
  "mileage_km": 1,
  "vin": "<string>",
  "plate": "<string>"
}');
form.append('currency', '<string>');
form.append('country', '<string>');
form.append('labour_rate', '1');
form.append('tax_rate_pct', '1');
form.append('background', 'studio_white');
form.append('hotspot_parts', 'front_bumper');
form.append('images.items', '{
  "fileName": "example-file"
}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.trycarhub.com/v1/inspections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.trycarhub.com/v1/inspections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"vehicle\"\r\n\r\n{\r\n  \"make\": \"<string>\",\r\n  \"model\": \"<string>\",\r\n  \"version\": \"<string>\",\r\n  \"year\": 123,\r\n  \"mileage_km\": 1,\r\n  \"vin\": \"<string>\",\r\n  \"plate\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"currency\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labour_rate\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tax_rate_pct\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nstudio_white\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"hotspot_parts\"\r\n\r\nfront_bumper\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trycarhub.com/v1/inspections"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"vehicle\"\r\n\r\n{\r\n  \"make\": \"<string>\",\r\n  \"model\": \"<string>\",\r\n  \"version\": \"<string>\",\r\n  \"year\": 123,\r\n  \"mileage_km\": 1,\r\n  \"vin\": \"<string>\",\r\n  \"plate\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"currency\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labour_rate\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tax_rate_pct\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nstudio_white\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"hotspot_parts\"\r\n\r\nfront_bumper\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.trycarhub.com/v1/inspections")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"vehicle\"\r\n\r\n{\r\n  \"make\": \"<string>\",\r\n  \"model\": \"<string>\",\r\n  \"version\": \"<string>\",\r\n  \"year\": 123,\r\n  \"mileage_km\": 1,\r\n  \"vin\": \"<string>\",\r\n  \"plate\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"currency\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labour_rate\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tax_rate_pct\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nstudio_white\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"hotspot_parts\"\r\n\r\nfront_bumper\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trycarhub.com/v1/inspections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"vehicle\"\r\n\r\n{\r\n  \"make\": \"<string>\",\r\n  \"model\": \"<string>\",\r\n  \"version\": \"<string>\",\r\n  \"year\": 123,\r\n  \"mileage_km\": 1,\r\n  \"vin\": \"<string>\",\r\n  \"plate\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"currency\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labour_rate\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tax_rate_pct\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nstudio_white\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"hotspot_parts\"\r\n\r\nfront_bumper\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "id": "job_3ZxK9pQr7TnW",
  "object": "job",
  "endpoint": "vehicle.analyse",
  "status": "queued",
  "livemode": true,
  "created": 1755300000,
  "started_at": 1755300000,
  "completed_at": 1755300000,
  "model_version": "plate-reader@2026-08-01",
  "credits": {
    "reserved": 20,
    "charged": 20
  },
  "result": {
    "coverage": {
      "captured_steps": 1,
      "total_steps": 1,
      "missing_steps": [
        "<string>"
      ]
    },
    "condition": {
      "overall_grade": "A",
      "damage_count": 1,
      "severity_breakdown": {
        "minor": 1,
        "moderate": 1,
        "severe": 1
      }
    },
    "parts": [
      {
        "code": "front_bumper",
        "label": "<string>",
        "damaged": true
      }
    ],
    "damages": [
      {
        "id": "dmg_1",
        "part": {
          "code": "front_bumper",
          "label": "Front bumper"
        },
        "type": "dent",
        "severity": "minor",
        "recommended_action": "none",
        "image_index": 1,
        "bbox": {
          "x": 120,
          "y": 340,
          "width": 180,
          "height": 48
        },
        "confidence": 0.94
      }
    ],
    "repair_estimate": {
      "currency": "<string>",
      "parts_total": {
        "amount": 149900,
        "currency": "EUR"
      },
      "labour_total": {
        "amount": 149900,
        "currency": "EUR"
      },
      "paint_total": {
        "amount": 149900,
        "currency": "EUR"
      },
      "total": {
        "amount": 149900,
        "currency": "EUR"
      },
      "labour_hours": 1,
      "line_count": 1
    },
    "listing_images": [
      {
        "url": "<string>",
        "expires_at": 1755300000,
        "format": "jpg",
        "width": 2,
        "height": 2,
        "bytes": 1
      }
    ],
    "hotspots": [
      {
        "part": {
          "code": "front_bumper",
          "label": "Front bumper"
        },
        "image_index": 1,
        "point": {
          "x": 123,
          "y": 123
        },
        "confidence": 0.94
      }
    ]
  },
  "error": {
    "type": "processing_error",
    "code": "model_inference_failed",
    "message": "<string>"
  },
  "stages": [
    {
      "stage": 4,
      "endpoint": "vehicle.analyse",
      "name": "onboard_walkaround",
      "status": "queued",
      "started_at": 1755300000,
      "completed_at": 1755300000,
      "job_id": "job_3ZxK9pQr7TnW",
      "error": {
        "type": "processing_error",
        "code": "model_inference_failed",
        "message": "<string>"
      },
      "model": "video-onboarding",
      "result": {},
      "skipped": false
    }
  ],
  "test_scenario": "low_confidence"
}

Inspections

Full vehicle inspection (bundle)

Chains the full pipeline in one call and bills as a single blended inspection rather than as separate metered calls.

#	Stage	Model
1	Onboard walkaround	`video-onboarding`
2	Isolate the vehicle	`car-segmentation`
3	Decompose parts	`parts-decomposition`
4	Detect damage	`damage-detection`
5	Grade severity	`severity-estimation`
6	Price the repair	`reparation-pricing`
7	Render for listing	`image-backgrounding`
8	Anchor hotspots	`viewer-hotspoter`

The returned job carries a stages[] array — the only endpoint that does — so progress is observable long before the aggregated result exists. Each stage also emits an inspection.stage_completed webhook.

Minutes-long by construction: wait=true is rejected.

POST

inspections

Full vehicle inspection (bundle)

curl --request POST \
  --url https://api.trycarhub.com/v1/inspections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form video='@example-file' \
  --form 'images=<string>' \
  --form 'vehicle={
  "make": "<string>",
  "model": "<string>",
  "version": "<string>",
  "year": 123,
  "mileage_km": 1,
  "vin": "<string>",
  "plate": "<string>"
}' \
  --form 'currency=<string>' \
  --form 'country=<string>' \
  --form labour_rate=1 \
  --form tax_rate_pct=1 \
  --form background=studio_white \
  --form hotspot_parts=front_bumper \
  --form images.items='@example-file'

import requests

url = "https://api.trycarhub.com/v1/inspections"

files = {
    "video": ("example-file", open("example-file", "rb")),
    "images.items": ("example-file", open("example-file", "rb"))
}
payload = {
    "images": "<string>",
    "vehicle": "{
  \"make\": \"<string>\",
  \"model\": \"<string>\",
  \"version\": \"<string>\",
  \"year\": 123,
  \"mileage_km\": 1,
  \"vin\": \"<string>\",
  \"plate\": \"<string>\"
}",
    "currency": "<string>",
    "country": "<string>",
    "labour_rate": "1",
    "tax_rate_pct": "1",
    "background": "studio_white",
    "hotspot_parts": "front_bumper"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('video', '<string>');
form.append('images', '<string>');
form.append('vehicle', '{
  "make": "<string>",
  "model": "<string>",
  "version": "<string>",
  "year": 123,
  "mileage_km": 1,
  "vin": "<string>",
  "plate": "<string>"
}');
form.append('currency', '<string>');
form.append('country', '<string>');
form.append('labour_rate', '1');
form.append('tax_rate_pct', '1');
form.append('background', 'studio_white');
form.append('hotspot_parts', 'front_bumper');
form.append('images.items', '{
  "fileName": "example-file"
}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.trycarhub.com/v1/inspections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.trycarhub.com/v1/inspections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"vehicle\"\r\n\r\n{\r\n  \"make\": \"<string>\",\r\n  \"model\": \"<string>\",\r\n  \"version\": \"<string>\",\r\n  \"year\": 123,\r\n  \"mileage_km\": 1,\r\n  \"vin\": \"<string>\",\r\n  \"plate\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"currency\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labour_rate\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tax_rate_pct\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nstudio_white\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"hotspot_parts\"\r\n\r\nfront_bumper\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.trycarhub.com/v1/inspections"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"vehicle\"\r\n\r\n{\r\n  \"make\": \"<string>\",\r\n  \"model\": \"<string>\",\r\n  \"version\": \"<string>\",\r\n  \"year\": 123,\r\n  \"mileage_km\": 1,\r\n  \"vin\": \"<string>\",\r\n  \"plate\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"currency\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labour_rate\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tax_rate_pct\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nstudio_white\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"hotspot_parts\"\r\n\r\nfront_bumper\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.trycarhub.com/v1/inspections")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"vehicle\"\r\n\r\n{\r\n  \"make\": \"<string>\",\r\n  \"model\": \"<string>\",\r\n  \"version\": \"<string>\",\r\n  \"year\": 123,\r\n  \"mileage_km\": 1,\r\n  \"vin\": \"<string>\",\r\n  \"plate\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"currency\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labour_rate\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tax_rate_pct\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nstudio_white\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"hotspot_parts\"\r\n\r\nfront_bumper\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trycarhub.com/v1/inspections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"vehicle\"\r\n\r\n{\r\n  \"make\": \"<string>\",\r\n  \"model\": \"<string>\",\r\n  \"version\": \"<string>\",\r\n  \"year\": 123,\r\n  \"mileage_km\": 1,\r\n  \"vin\": \"<string>\",\r\n  \"plate\": \"<string>\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"currency\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"country\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"labour_rate\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tax_rate_pct\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"background\"\r\n\r\nstudio_white\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"hotspot_parts\"\r\n\r\nfront_bumper\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "id": "job_3ZxK9pQr7TnW",
  "object": "job",
  "endpoint": "vehicle.analyse",
  "status": "queued",
  "livemode": true,
  "created": 1755300000,
  "started_at": 1755300000,
  "completed_at": 1755300000,
  "model_version": "plate-reader@2026-08-01",
  "credits": {
    "reserved": 20,
    "charged": 20
  },
  "result": {
    "coverage": {
      "captured_steps": 1,
      "total_steps": 1,
      "missing_steps": [
        "<string>"
      ]
    },
    "condition": {
      "overall_grade": "A",
      "damage_count": 1,
      "severity_breakdown": {
        "minor": 1,
        "moderate": 1,
        "severe": 1
      }
    },
    "parts": [
      {
        "code": "front_bumper",
        "label": "<string>",
        "damaged": true
      }
    ],
    "damages": [
      {
        "id": "dmg_1",
        "part": {
          "code": "front_bumper",
          "label": "Front bumper"
        },
        "type": "dent",
        "severity": "minor",
        "recommended_action": "none",
        "image_index": 1,
        "bbox": {
          "x": 120,
          "y": 340,
          "width": 180,
          "height": 48
        },
        "confidence": 0.94
      }
    ],
    "repair_estimate": {
      "currency": "<string>",
      "parts_total": {
        "amount": 149900,
        "currency": "EUR"
      },
      "labour_total": {
        "amount": 149900,
        "currency": "EUR"
      },
      "paint_total": {
        "amount": 149900,
        "currency": "EUR"
      },
      "total": {
        "amount": 149900,
        "currency": "EUR"
      },
      "labour_hours": 1,
      "line_count": 1
    },
    "listing_images": [
      {
        "url": "<string>",
        "expires_at": 1755300000,
        "format": "jpg",
        "width": 2,
        "height": 2,
        "bytes": 1
      }
    ],
    "hotspots": [
      {
        "part": {
          "code": "front_bumper",
          "label": "Front bumper"
        },
        "image_index": 1,
        "point": {
          "x": 123,
          "y": 123
        },
        "confidence": 0.94
      }
    ]
  },
  "error": {
    "type": "processing_error",
    "code": "model_inference_failed",
    "message": "<string>"
  },
  "stages": [
    {
      "stage": 4,
      "endpoint": "vehicle.analyse",
      "name": "onboard_walkaround",
      "status": "queued",
      "started_at": 1755300000,
      "completed_at": 1755300000,
      "job_id": "job_3ZxK9pQr7TnW",
      "error": {
        "type": "processing_error",
        "code": "model_inference_failed",
        "message": "<string>"
      },
      "model": "video-onboarding",
      "result": {},
      "skipped": false
    }
  ],
  "test_scenario": "low_confidence"
}

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.

Headers

Idempotency-Key

string

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.

Required string length: 8 - 255

X-Carhub-Test-Scenario

string

Steers the fixture backend. Ignored by live keys, 400 test_scenario_not_supported if the scenario is unknown to the endpoint. Common catalogue:

Scenario	Effect
(absent)	Deterministic success — the endpoint's `default` fixture.
`empty_result`	Success with nothing detected: empty lists, null readings.
`low_confidence`	Success with every confidence below 0.5.
`model_error`	Job settles `failed`; the reservation is released.
`slow`	Completion after ~30 s — makes `wait=true` time out.
`insufficient_credits`	`402` at admission, no job created.

Some endpoints add their own scenarios; unsupported common scenarios (for example empty_result on a generation endpoint) are rejected rather than silently ignored.

Examples:

"empty_result"

"low_confidence"

"model_error"

"slow"

"insufficient_credits"

Body

Supply either a walkaround video (stage 1 indexes it into frames) or a set of images — at least one of the two is required.

Supply a walkaround video, a set of images, or both.

video

file

images

file[]

Maximum array length: 30

stages

enum<string>[]

Restrict the pipeline to these stages. Omitted, all eight run. Excluded stages are reported as skipped and are not billed.

Available options:

onboard_walkaround,

isolate_vehicle,

decompose_parts,

detect_damage,

grade_severity,

price_repair,

render_listing,

anchor_hotspots

vehicle

object | null

What you already know about the vehicle. Every field is optional.

Show child attributes

currency

string

Pattern: ^[A-Z]{3}$

country

string

Pattern: ^[A-Z]{2}$

labour_rate

integer

Workshop hourly rate in minor units, for the repair pricing stage.

Required range: x >= 0

tax_rate_pct

number

Required range: x >= 0

background

enum<string>

default:studio_white

Background preset for the listing renders of stage 7.

Available options:

studio_white,

studio_grey,

studio_gradient,

showroom,

outdoor,

transparent,

blur

hotspot_parts

string[]

Parts to anchor in stage 8.

Stable identifier of a vehicle part, shared by every endpoint that names one. Snake case, side-suffixed where a vehicle has two (door_front_left). The list grows with the part taxonomy, so treat an unknown code as opaque rather than rejecting it.

Response

Inspection accepted; the eight stages are queued.

An inspection job. Unlike every other job it carries stages, and its result only materialises when the eighth stage settles.

string

required

Job identifier — job_ followed by a base58 string.

Pattern: ^job_[1-9A-HJ-NP-Za-km-z]{8,32}$

Example:

"job_3ZxK9pQr7TnW"

object

string

required

Allowed value: "job"

endpoint

enum<string>

required

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

status

enum<string>

required

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.

Available options:

queued,

processing,

succeeded,

failed,

expired,

canceled

livemode

boolean

required

false when the job was created with a chk_test_ key: fixture result, test credits.

created

integer<int64>

required

Epoch seconds, UTC.

Example:

1755300000

started_at

integer<int64> | null

required

When the job left the queue. Null while queued.

Example:

1755300000

completed_at

integer<int64> | null

required

When the job settled. Null until then.

Example:

1755300000

model_version

string | null

required

Exact model build that produced the result, as <model>@<release date>. Null until the job starts. Pin your regression tests to it.

Example:

"plate-reader@2026-08-01"

credits

object

required

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.

Show child attributes

result

inspections result · object | null

required

The aggregated outcome of the eight stages: what was captured, what the vehicle is made of, what is wrong with it, what fixing it costs, and the assets to publish it with. Each stage's raw output stays readable on its own child job.

Show child attributes

error

object | null

required

Populated when status is failed or expired, null otherwise.

Show child attributes

stages

Inspection stage · object[]

required

Per-stage progress. Present on inspections jobs only, absent everywhere else.

Show child attributes

test_scenario

string

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.

Example:

"low_confidence"

⌘I

Start here

Integration guides

SDK

API reference

Full vehicle inspection (bundle)

Authorizations

Headers

Body

Response