> ## 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.

# Referência da API

> Cada endpoint do Croma, com um playground interativo.

Cada endpoint desta referência é uma solicitação `POST` para `https://api.croma.run`,
autenticada com uma chave de API do tipo bearer. Escolha um endpoint na barra lateral para ver
seu esquema completo, uma solicitação de exemplo e um playground de "experimente".

## Países suportados

Os endpoints são agrupados por país, e cada país tem seu próprio prefixo de rota:

| País                     | Prefixo de rota |
| ------------------------ | --------------- |
| Colômbia                 | `/co/…`         |
| Peru                     | `/pe/…`         |
| México                   | `/mx/…`         |
| Global (ferramentas web) | `/global/…`     |

`GET /jobs/{id}` não depende do país: retorna o estado de qualquer
[trabalho assíncrono](/pt/async-jobs).

## Convenções

* **Auth**: `Authorization: Bearer <key>` em cada endpoint. Consulte [Autenticação](/pt/authentication).
* **Sucesso**: as respostas envolvem a carga útil sob `data`: `{ "data": … }`.
* **Erros**: `{ "error": { "type", "code", "message" } }` com um status diferente de 2xx. Consulte [Erros](/pt/errors).
* **Sem correspondência**: um registro consultado que não existe é um `200`, não um `404`: as consultas de um único registro retornam `found: false` e as consultas de lista retornam um array vazio.
* **Limites de taxa**: são reportados por meio dos cabeçalhos de resposta `X-RateLimit-*`. Consulte [Limites de taxa](/pt/rate-limits).
* **Trabalhos assíncronos**: as consultas de longa duração podem retornar um `202` com um trabalho que você pode acompanhar por polling ou receber via callback. Consulte a lista em [Trabalhos assíncronos](/pt/async-jobs).

<CardGroup cols={2}>
  <Card title="Comece" icon="bolt" href="/pt/introduction">
    Obtenha uma chave e faça sua primeira solicitação.
  </Card>

  <Card title="Trabalhos assíncronos" icon="clock" href="/pt/async-jobs">
    Espere de forma síncrona, faça polling ou receba um callback para consultas de longa duração.
  </Card>
</CardGroup>
