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

# Visor Public API

> Vehicle inventory, facets, VIN lookup, and dealer data for customer integrations.

The Visor Public API is available at `https://api.visor.vin/v1`.

Use the guides for integration behavior that sits around the API contract: authentication, how the data works, glossary terms, filter discovery, pagination, usage headers, billing semantics, rate limits, and common errors. Use the API reference for endpoint-level parameters and response schemas generated from the OpenAPI source in this repo.

The OpenAPI document is generated from the Worker route definitions and published at `/v1/openapi.json`. Do not hand-edit `openapi.json`; run `bun run public-api:docs:sync` after changing public API schemas or generated docs.

## Start here

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/docs/quickstart">
    Make authenticated listing, facet, VIN, dealer, and usage requests.
  </Card>

  <Card title="Authentication" icon="key" href="/docs/authentication">
    Create scoped keys and send bearer tokens safely.
  </Card>

  <Card title="Filters and facets" icon="filter" href="/docs/filters-and-facets">
    Discover valid vehicle values before building precise searches.
  </Card>

  <Card title="Common examples" icon="copy" href="/docs/examples">
    Copyable workflows for listings, facets, VINs, dealers, and usage.
  </Card>

  <Card title="Errors and retries" icon="triangle-exclamation" href="/docs/errors-and-retries">
    Handle validation, billing, rate-limit, and platform responses.
  </Card>

  <Card title="Connect an AI agent" icon="robot" href="/docs/mcp-setup">
    Add the hosted MCP server to Claude, ChatGPT, Codex, and other clients.
  </Card>
</CardGroup>

## Contract notes

* Public endpoints live under `/v1`.
* Private app/mobile endpoints under `/api/v1` are separate and are not part of this public contract.
* API keys use `Authorization: Bearer <api_key>`.
* Query-string API keys are rejected.
* Successful paid requests include usage and pricing headers.
* Unknown VIN and dealer detail records return `404 not_found_error`; known VINs can still return `status: "missing"`.

For data semantics, start with [How the Data Works](/docs/data-works). For field and filter definitions, use the [Glossary](/docs/glossary).