License Plate Replacer

curl --request POST \
  --url https://api.trycarhub.com/v1/render/plate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form images=@example-file \
  --form mode=blur \
  --form 'logo=<string>' \
  --form 'logo_ref=<string>' \
  --form 'plate_color=#F5F5F5' \
  --form blur_strength=60 \
  --form output_format=jpg

import requests

url = "https://api.trycarhub.com/v1/render/plate"

files = { "images": ("example-file", open("example-file", "rb")) }
payload = {
    "mode": "blur",
    "logo": "<string>",
    "logo_ref": "<string>",
    "plate_color": "#F5F5F5",
    "blur_strength": "60",
    "output_format": "jpg"
}
headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const form = new FormData();
form.append('images', '<string>');
form.append('mode', 'blur');
form.append('logo', '<string>');
form.append('logo_ref', '<string>');
form.append('plate_color', '#F5F5F5');
form.append('blur_strength', '60');
form.append('output_format', 'jpg');

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

options.body = form;

fetch('https://api.trycarhub.com/v1/render/plate', 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/render/plate",
  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=\"images\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mode\"\r\n\r\nblur\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo_ref\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"plate_color\"\r\n\r\n#F5F5F5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"blur_strength\"\r\n\r\n60\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format\"\r\n\r\njpg\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/render/plate"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mode\"\r\n\r\nblur\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo_ref\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"plate_color\"\r\n\r\n#F5F5F5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"blur_strength\"\r\n\r\n60\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format\"\r\n\r\njpg\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/render/plate")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mode\"\r\n\r\nblur\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo_ref\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"plate_color\"\r\n\r\n#F5F5F5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"blur_strength\"\r\n\r\n60\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format\"\r\n\r\njpg\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

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

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=\"images\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mode\"\r\n\r\nblur\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo_ref\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"plate_color\"\r\n\r\n#F5F5F5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"blur_strength\"\r\n\r\n60\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format\"\r\n\r\njpg\r\n-----011000010111000001101001--"

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

{
  "is_staging": false,
  "id": "job_3ZxK9pQr7TnW",
  "object": "job",
  "endpoint": "vehicle.pose",
  "status": "queued",
  "livemode": true,
  "created": 1755300000,
  "started_at": 1755300000,
  "completed_at": 1755300000,
  "model_version": "plate-reader@2026-08-27",
  "credits": {
    "reserved": 20,
    "charged": 20
  },
  "result": {
    "images": [
      {
        "input_index": 14,
        "status": "succeeded",
        "image": {
          "url": "<string>",
          "expires_at": 1755300000,
          "format": "jpg",
          "width": 2,
          "height": 2,
          "bytes": 1
        },
        "mode": "logo",
        "plates_replaced": 1,
        "regions": [
          {
            "bbox": {
              "x": 120,
              "y": 340,
              "width": 180,
              "height": 48
            },
            "confidence": 0.94
          }
        ],
        "error": {
          "code": "<string>",
          "message": "<string>",
          "billable": true
        }
      }
    ],
    "image_count": 15,
    "succeeded_count": 15,
    "failed_count": 15
  },
  "error": {
    "type": "processing_error",
    "code": "model_inference_failed",
    "message": "<string>"
  },
  "test_scenario": "low_confidence"
}

E — Image production

License Plate Replacer

Tool for covering a license plate with a logo.

Allows you to quickly hide license plates.
Offers plate masking and plate blurring functionalities.
Offers the possibility of hiding the license plate with a logo or a blur.

Detection is part of the job: the response tells you how many plates were covered and where, so an image that came back with plates_replaced: 0 can be routed for review rather than published blind.

POST

render

plate

License Plate Replacer

curl --request POST \
  --url https://api.trycarhub.com/v1/render/plate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form images=@example-file \
  --form mode=blur \
  --form 'logo=<string>' \
  --form 'logo_ref=<string>' \
  --form 'plate_color=#F5F5F5' \
  --form blur_strength=60 \
  --form output_format=jpg

import requests

url = "https://api.trycarhub.com/v1/render/plate"

files = { "images": ("example-file", open("example-file", "rb")) }
payload = {
    "mode": "blur",
    "logo": "<string>",
    "logo_ref": "<string>",
    "plate_color": "#F5F5F5",
    "blur_strength": "60",
    "output_format": "jpg"
}
headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const form = new FormData();
form.append('images', '<string>');
form.append('mode', 'blur');
form.append('logo', '<string>');
form.append('logo_ref', '<string>');
form.append('plate_color', '#F5F5F5');
form.append('blur_strength', '60');
form.append('output_format', 'jpg');

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

options.body = form;

fetch('https://api.trycarhub.com/v1/render/plate', 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/render/plate",
  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=\"images\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mode\"\r\n\r\nblur\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo_ref\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"plate_color\"\r\n\r\n#F5F5F5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"blur_strength\"\r\n\r\n60\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format\"\r\n\r\njpg\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/render/plate"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mode\"\r\n\r\nblur\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo_ref\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"plate_color\"\r\n\r\n#F5F5F5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"blur_strength\"\r\n\r\n60\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format\"\r\n\r\njpg\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/render/plate")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"images\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mode\"\r\n\r\nblur\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo_ref\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"plate_color\"\r\n\r\n#F5F5F5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"blur_strength\"\r\n\r\n60\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format\"\r\n\r\njpg\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

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

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=\"images\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mode\"\r\n\r\nblur\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"logo_ref\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"plate_color\"\r\n\r\n#F5F5F5\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"blur_strength\"\r\n\r\n60\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"output_format\"\r\n\r\njpg\r\n-----011000010111000001101001--"

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

{
  "is_staging": false,
  "id": "job_3ZxK9pQr7TnW",
  "object": "job",
  "endpoint": "vehicle.pose",
  "status": "queued",
  "livemode": true,
  "created": 1755300000,
  "started_at": 1755300000,
  "completed_at": 1755300000,
  "model_version": "plate-reader@2026-08-27",
  "credits": {
    "reserved": 20,
    "charged": 20
  },
  "result": {
    "images": [
      {
        "input_index": 14,
        "status": "succeeded",
        "image": {
          "url": "<string>",
          "expires_at": 1755300000,
          "format": "jpg",
          "width": 2,
          "height": 2,
          "bytes": 1
        },
        "mode": "logo",
        "plates_replaced": 1,
        "regions": [
          {
            "bbox": {
              "x": 120,
              "y": 340,
              "width": 180,
              "height": 48
            },
            "confidence": 0.94
          }
        ],
        "error": {
          "code": "<string>",
          "message": "<string>",
          "billable": true
        }
      }
    ],
    "image_count": 15,
    "succeeded_count": 15,
    "failed_count": 15
  },
  "error": {
    "type": "processing_error",
    "code": "model_inference_failed",
    "message": "<string>"
  },
  "test_scenario": "low_confidence"
}

Authorizations

Authorization

string

header

required

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

chk_live_… — production inference, live credits, livemode: true, is_staging: false.
chk_stg_… — real inference classified as staging, the same live credits, livemode: true, is_staging: 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

images

file[]

required

Repeat the images field once per file. 10 MB each.

Required array length: 1 - 30 elements

mode

enum<string>

default:blur

Available options:

logo,

blur,

solid

logo

string<uri> | null

Public HTTP(S) logo image to lay over the plate. Required when mode is logo.

logo_ref

string<uri> | null

deprecated

Deprecated alias of logo, retained for clients sending a public URL.

plate_color

string

default:#F5F5F5

Background colour used behind a logo or solid plate.

Pattern: ^#[0-9A-Fa-f]{6}$

blur_strength

integer

default:60

Only meaningful when mode is blur.

Required range: 1 <= x <= 100

output_format

enum<string>

default:jpg

Available options:

jpg,

png,

webp

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.

is_staging

boolean

default:false

required

Staging classification. Requires live mode and uses the organisation's shared live credits.

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.pose,

vehicle.segment,

vehicle.identify,

vin.read,

driver_license.read,

plate.read,

document.read,

dashboard.read,

engine.detect,

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,

render.hotspots

status

enum<string>

required

Lifecycle of a job. queued → processing → one of succeeded | partial | failed; expired when it was never picked up in time, canceled when it was cancelled before starting. Every state after processing is terminal.

Available options:

queued,

processing,

succeeded,

partial,

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-27"

credits

object

required

Credit accounting for the job. One thousand credits equal one USD. reserved is held at admission and charged is the real cost after settlement; unused credits are released.

Show child attributes

result

render.plate result · object | null

required

The image with every plate covered, and where the covering was applied. An image that comes back with plates_replaced: 0 should be routed for review rather than published.

Show child attributes

error

object | null

required

Populated when status is failed or expired, null otherwise.

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"

Get started

Build your integration

API reference

License Plate Replacer

Authorizations

Headers

Query Parameters

Body

Response