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

# API Reference

> The complete Croma API reference: every endpoint with its request schema, response shape, error codes and an interactive playground to try calls live.

Every endpoint in this reference is a `POST` request to `https://api.croma.run`,
authenticated with a bearer API key. Pick an endpoint from the sidebar to see
its full schema, example request, and a "try it" playground.

## Supported countries

Endpoints are grouped by country, and each country has its own path prefix:

| Country | Path prefix |
| - | - |
| Colombia | `/co/…` |
| Peru | `/pe/…` |
| México | `/mx/…` |
| Global (web tools) | `/global/…` |

`GET /jobs/{id}` is country-independent: it returns the status of any
[async job](/async-jobs).

## Conventions

* **Auth**: `Authorization: Bearer <key>` on every endpoint. See [Authentication](/authentication).
* **Success**: responses wrap the payload under `data`: `{ "data": … }`.
* **Errors**: `{ "error": { "type", "code", "message" } }` with a non-2xx status. See [Errors](/errors).
* **No match**: a queried record that doesn't exist is a `200`, not a `404`: single-record lookups return `found: false`, list lookups return an empty array.
* **Rate limits**: reported via `X-RateLimit-*` response headers. See [Rate limits](/rate-limits).
* **Async jobs**: longer-running lookups may return a `202` with a job you can poll or receive via callback. See [Async jobs](/async-jobs) for the list.
* **Datasets vs live**: every endpoint is either a [live lookup](/live-lookups) (reads the source at request time) or a [dataset endpoint](/datasets) (answers from the whole source in milliseconds and carries `as_of`); `/catalog` says which via `served_from`.

<CardGroup cols={2}>
  <Card title="Get started" icon="bolt" href="/introduction">
    Get a key and make your first request.
  </Card>

  <Card title="Async jobs" icon="clock" href="/async-jobs">
    Wait inline, poll, or get a callback for long-running lookups.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.