Quickstart - CarHub Documentation

You need

A test organisation API key beginning with chk_test_.
curl and jq.

1

Set your API key

Create a test API key in the CarHub dashboard.

export CARHUB_API_URL=https://api.trycarhub.com
export CARHUB_API_KEY=chk_test_replace_me

2

Submit a request

curl -sS -X POST "$CARHUB_API_URL/v1/plate/read?wait=true" \
  -H "Authorization: Bearer $CARHUB_API_KEY" \
  -H "Idempotency-Key: 8b1f1c2e-9d3a-4a51-9f0c-1c9a2f6d7b44" \
  -F "image=@plate.jpg" | jq

3

Retrieve a queued job

If the response is 202, save its id and poll it until it finishes.

curl -sS "$CARHUB_API_URL/v1/jobs/job_3ZxK9pQr7TnW" \
  -H "Authorization: Bearer $CARHUB_API_KEY" | jq

Send an Idempotency-Key on every POST. Reuse it only when retrying the same request.

Next steps

Test errors and retries in test mode.
Use uploads for videos, batches and reusable files.
Check endpoint availability in the API reference.