> ## Documentation Index
> Fetch the complete documentation index at: https://docs.trycarhub.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API overview

> Shared conventions for the CarHub HTTP API.

Base URL: `https://api.trycarhub.com`

The generated API reference is the source of truth for every operation, field and schema.

<Card title="Browse API endpoints" icon="code" href="/api-reference">Use Mintlify's generated OpenAPI reference, including schemas, examples and request playgrounds.</Card>

## Find the right endpoint

Use the API reference's tag groups to browse by capability:

| You need to…                                    | Look under                     |
| ----------------------------------------------- | ------------------------------ |
| Identify, read or understand a vehicle          | **A — Understand the vehicle** |
| Find damage, assess severity or inspect tires   | **B — Damage & condition**     |
| Recognise, segment or decompose components      | **C — Parts**                  |
| Price a vehicle or repair                       | **D — Money**                  |
| Improve, generate or compose imagery            | **E — Image production**       |
| Anchor condition hotspots across vehicle images | **E — Image production**       |
| Process a complete inspection                   | **Inspections**                |

## Inference endpoints

CarHub provides 24 `POST` inference endpoints across vehicle understanding, condition, parts, pricing and image production. It also offers the inspection bundle, jobs, uploads and an endpoint catalogue.

All `/v1/*` calls use an API key. Requests normally respond `202 Accepted` with a job. Fast endpoints may return `200 OK` when called with `wait=true`.

## Request conventions

* Use JSON unless an endpoint accepts a file directly; use `multipart/form-data` for direct binary input.
* Send `Idempotency-Key` with every `POST`.
* Read `Request-Id` from every response and include it in support requests.
* Honor `Retry-After` and the `RateLimit-*` headers after `429` responses.
* Keep opaque IDs (`job_…`, `upl_…`, `key_…`, `whe_…`) intact; never parse or fabricate them.

Use the generated reference for endpoint-specific request bodies and responses. The [error guide](/api-reference/errors) explains shared failure handling, and the [jobs guide](/guides/jobs) explains how to retrieve results.