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

# Início rápido

> Obtenha uma chave e faça sua primeira chamada à API da Croma em três passos.

<Steps>
  <Step title="Obtenha uma chave de API">
    As chaves da Croma são emitidas por **organização** em
    [platform.usecroma.com](https://platform.usecroma.com). Uma chave se parece com
    `croma_live_…` (ou `croma_test_…` fora de produção). Trate-a como um
    segredo. Ela concede o acesso completo da sua organização à API.

    <Note>
      Chaves pessoais são rejeitadas. A API só aceita chaves com escopo
      de organização. Consulte [Autenticação](/pt/authentication) para mais
      detalhes.
    </Note>
  </Step>

  <Step title="Chame um endpoint">
    Cada endpoint de dados é uma rota `POST` versionada (por exemplo
    `/co/rama-judicial/cases-by-entity/v1`) em `https://api.croma.run`. Ele recebe
    um corpo JSON pequeno e a chave em um cabeçalho `Authorization: Bearer`.

    <CodeGroup>
      ```bash cURL theme={"dark"}
      curl https://api.croma.run/co/rama-judicial/cases-by-entity/v1 \
        -H "Authorization: Bearer $CROMA_API_KEY" \
        -H "Content-Type: application/json" \
        -d '{ "name": "PEDRO CIFUENTES", "entity_type": "natural", "page": 1 }'
      ```

      ```ts TypeScript theme={"dark"}
      const res = await fetch("https://api.croma.run/co/rama-judicial/cases-by-entity/v1", {
        method: "POST",
        headers: {
          Authorization: `Bearer ${process.env.CROMA_API_KEY}`,
          "Content-Type": "application/json",
        },
        body: JSON.stringify({ name: "PEDRO CIFUENTES", entity_type: "natural", page: 1 }),
      });

      const { data } = await res.json();
      ```

      ```python Python theme={"dark"}
      import os, requests

      res = requests.post(
          "https://api.croma.run/co/rama-judicial/cases-by-entity/v1",
          headers={"Authorization": f"Bearer {os.environ['CROMA_API_KEY']}"},
          json={"name": "PEDRO CIFUENTES", "entity_type": "natural", "page": 1},
      )
      body = res.json()
      ```
    </CodeGroup>
  </Step>

  <Step title="Leia a resposta">
    As respostas bem-sucedidas envolvem o conteúdo em `data`:

    ```json theme={"dark"}
    {
      "data": { }
    }
    ```

    O status do limite de taxa e um id de solicitação chegam como cabeçalhos de
    resposta; não há objeto `meta` no corpo:

    ```
    X-RateLimit-Limit: 100
    X-RateLimit-Remaining: 99
    X-RateLimit-Reset: 2026-05-23T18:00:00.000Z
    X-Request-Id: req_8f3c…
    ```

    As consultas longas são resolvidas como [trabalhos
    assíncronos](/pt/async-jobs): a mesma solicitação pode aguardar de forma síncrona,
    ser consultada por polling ou notificar você por callback ao terminar. As falhas
    compartilham um mesmo [formato de erro](/pt/errors) em todos os endpoints.
  </Step>
</Steps>

## Próximos passos

<CardGroup cols={2}>
  <Card title="Servidor MCP" icon="plug" href="/pt/mcp-server">
    Conecte qualquer cliente MCP a todas as ferramentas da Croma com uma
    única URL.
  </Card>

  <Card title="Referência da API" icon="code" href="/pt/api-reference/overview">
    Referência completa de endpoints com um playground interativo.
  </Card>
</CardGroup>
