Car Segmentation

curl --request POST \
  --url https://api.trycarhub.com/v1/vehicle/segment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form image='@example-file' \
  --form all_vehicles=false \
  --form return_cutout=false \
  --form mask_format=polygon

import requests

url = "https://api.trycarhub.com/v1/vehicle/segment"

files = { "image": ("example-file", open("example-file", "rb")) }
payload = {
    "all_vehicles": "false",
    "return_cutout": "false",
    "mask_format": "polygon"
}
headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const form = new FormData();
form.append('image', '<string>');
form.append('all_vehicles', 'false');
form.append('return_cutout', 'false');
form.append('mask_format', 'polygon');

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

options.body = form;

fetch('https://api.trycarhub.com/v1/vehicle/segment', 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/vehicle/segment",
  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=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"all_vehicles\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"return_cutout\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mask_format\"\r\n\r\npolygon\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/vehicle/segment"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"all_vehicles\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"return_cutout\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mask_format\"\r\n\r\npolygon\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/vehicle/segment")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"all_vehicles\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"return_cutout\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mask_format\"\r\n\r\npolygon\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

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

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=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"all_vehicles\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"return_cutout\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mask_format\"\r\n\r\npolygon\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": {
    "image": {
      "width": 2,
      "height": 2
    },
    "instances": [
      {
        "id": "veh_1",
        "bbox": {
          "x": 120,
          "y": 340,
          "width": 180,
          "height": 48
        },
        "mask": {
          "format": "polygon",
          "polygon": [
            [
              123
            ]
          ],
          "rle": {
            "size": [
              123
            ],
            "counts": "<string>"
          }
        },
        "area_ratio": 0.5,
        "is_primary": true,
        "confidence": 0.94
      }
    ],
    "cutout": {
      "url": "<string>",
      "expires_at": 1755300000,
      "format": "jpg",
      "width": 2,
      "height": 2,
      "bytes": 1
    }
  },
  "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"
}

A — Understand the vehicle

Car Segmentation

Tool to perfectly segment the car.

Allows vehicle segmentation to get only the vehicle.
Proposes to recover the vehicle and remove the elements around the vehicle as well as the bottom.
Offers the possibility of recovering only the vehicle in photos with many vehicles.

Returns geometry (masks) and, when return_cutout is set, a transparent PNG of the isolated vehicle. Background replacement is a separate endpoint (/v1/render/background).

POST

vehicle

segment

Car Segmentation

curl --request POST \
  --url https://api.trycarhub.com/v1/vehicle/segment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form image='@example-file' \
  --form all_vehicles=false \
  --form return_cutout=false \
  --form mask_format=polygon

import requests

url = "https://api.trycarhub.com/v1/vehicle/segment"

files = { "image": ("example-file", open("example-file", "rb")) }
payload = {
    "all_vehicles": "false",
    "return_cutout": "false",
    "mask_format": "polygon"
}
headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const form = new FormData();
form.append('image', '<string>');
form.append('all_vehicles', 'false');
form.append('return_cutout', 'false');
form.append('mask_format', 'polygon');

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

options.body = form;

fetch('https://api.trycarhub.com/v1/vehicle/segment', 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/vehicle/segment",
  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=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"all_vehicles\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"return_cutout\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mask_format\"\r\n\r\npolygon\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/vehicle/segment"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"all_vehicles\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"return_cutout\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mask_format\"\r\n\r\npolygon\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/vehicle/segment")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"all_vehicles\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"return_cutout\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mask_format\"\r\n\r\npolygon\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

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

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=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"all_vehicles\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"return_cutout\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mask_format\"\r\n\r\npolygon\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": {
    "image": {
      "width": 2,
      "height": 2
    },
    "instances": [
      {
        "id": "veh_1",
        "bbox": {
          "x": 120,
          "y": 340,
          "width": 180,
          "height": 48
        },
        "mask": {
          "format": "polygon",
          "polygon": [
            [
              123
            ]
          ],
          "rle": {
            "size": [
              123
            ],
            "counts": "<string>"
          }
        },
        "area_ratio": 0.5,
        "is_primary": true,
        "confidence": 0.94
      }
    ],
    "cutout": {
      "url": "<string>",
      "expires_at": 1755300000,
      "format": "jpg",
      "width": 2,
      "height": 2,
      "bytes": 1
    }
  },
  "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"

Query Parameters

wait

boolean

default:false

Hold the connection until the job settles and answer 200 with the completed job instead of 202 with a queued one. Available on fast endpoints only; the ceiling is 30 s, after which the job keeps running and the call answers 202 as usual.

Body

image

file

required

JPEG, PNG or WebP, 10 MB maximum. Larger files must go through /v1/uploads.

all_vehicles

boolean

default:false

Segment every vehicle in frame instead of only the primary one — the case of a photo taken on a busy forecourt.

return_cutout

boolean

default:false

Also render the primary vehicle on transparency.

mask_format

enum<string>

default:polygon

Representation of returned masks. none omits them and shrinks the payload.

Available options:

polygon,

rle_coco,

none

Response

Job completed synchronously (wait=true).

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.

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

vehicle.segment result · object | null

required

Pixel-accurate outline of every vehicle in the frame, plus an optional transparent cutout of the primary one.

Show child attributes

error

object | null

required

Populated when status is failed or expired, null otherwise.

Show child attributes

stages

Inspection stage · object[]

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

Car Segmentation

Authorizations

Headers

Query Parameters

Body

Response