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

> ## Agent Instructions
> Conare's API is at https://api.conare.ai. Authenticate with `Authorization: Bearer $CONARE_API_KEY`.
> The full OpenAPI spec is at https://api.conare.ai/openapi.yaml; each endpoint has a page under /api-reference, and appending .md to any page URL returns its Markdown.
> Embed with model conare-embed-1; send input_type "query" for search queries. Rerank with conare-rerank-1.
> Prefer the TypeScript SDK (`npm install conare`) or plain HTTP in examples.
> Install the Conare skill with `npx skills add https://docs.conare.ai`; search these docs over MCP at https://docs.conare.ai/mcp; the whole site is at https://docs.conare.ai/llms-full.txt.

# Visão geral da API

> URL base, autenticação, erros, novas tentativas, limites de taxa e headers da API da Conare.

A API da Conare é JSON sobre HTTPS. Todo endpoint tem uma página nesta aba, com um playground.

| | |
| - | - |
| URL base | `https://api.conare.ai` |
| Autenticação | `Authorization: Bearer $CONARE_API_KEY` |
| Chaves | Criadas no [console](https://docs.conare.ai/pt-BR/console.md#chaves); mantenha-as no seu servidor |
| Corpos | JSON, snake\_case; campos desconhecidos dão `400` |
| Especificação | [api.conare.ai/openapi.yaml](https://api.conare.ai/openapi.yaml) |

```bash theme={null}
curl https://api.conare.ai/namespaces \
  -H "Authorization: Bearer $CONARE_API_KEY"
```

As rotas compatíveis com OpenAI e Cohere (`/v1`, `/v2`) ignoram campos desconhecidos.

## Erros

```json theme={null}
{
  "error": {
    "code": "invalid_request",
    "message": "documents[0].text is required",
    "request_id": "45ea7c7353368cb646e5cc2303008072"
  }
}
```

| Status | Significado |
| - | - |
| 400 | A requisição é inválida; `message` diz por quê |
| 401 | A chave está ausente, incorreta ou revogada |
| 403 | A chave não tem acesso a este namespace ou rota |
| 404 | Não encontrado |
| 409 | Um conflito de versão, ou uma gravação concorrente venceu |
| 413 | O corpo, um documento ou um arquivo é grande demais |
| 415 | O tipo de [arquivo](https://docs.conare.ai/pt-BR/files.md) não é suportado |
| 422 | O arquivo não pode ser lido, ou um `Idempotency-Key` foi reutilizado para outra requisição |
| 429 | Acima de um [limite de taxa](#limites-de-taxa) |
| 5xx | Um problema do nosso lado |

## Novas tentativas

| Caso | O que fazer |
| - | - |
| `429`, `503` | Tente de novo após os segundos do header `Retry-After` |
| Outros 5xx | Tente de novo com backoff |
| Gravações e exclusões | Envie um `Idempotency-Key` (um UUID); uma repetição em até 24 horas retorna a primeira resposta com `Idempotent-Replayed: true` e não altera nada |

O [SDK](https://docs.conare.ai/pt-BR/sdk.md) faz as novas tentativas e envia o `Idempotency-Key` por você.

## Limites de taxa

Por organização. Picos equivalentes a até 10 segundos são aceitos; acima de um limite, a API retorna `429` com `Retry-After`.

| Chamadas | Por segundo | Simultâneas |
| - | - | - |
| Busca | 100 | 128 |
| Gravação | 100 documentos | 64 |
| Embed | 100 textos | 16 |
| Rerank | 20 | 16 |
| Consultas da [turbopuffer API](https://docs.conare.ai/pt-BR/turbopuffer.md) | 1.000 | |
| Todo o resto | 100 | |

## Headers

| Header | Direção | Significado |
| - | - | - |
| `Authorization` | Requisição | `Bearer` e sua chave |
| `Idempotency-Key` | Requisição | Torna segura a nova tentativa de uma gravação |
| `X-Conare-Org` | Requisição | A organização em nome da qual agir, com uma chave multiorganização ([liste-as](https://docs.conare.ai/pt-br/api-reference/organizations/list-organizations.md)) |
| `Content-Encoding: gzip` | Requisição | Um corpo comprimido; os limites o contam descomprimido |
| `X-Request-Id` | Resposta | Em toda resposta; inclua-o ao contatar o suporte |
| `Retry-After` | Resposta | Segundos de espera, em `429` e `503` |
| `Conare-Degraded` | Resposta | A requisição teve sucesso sem parte do trabalho, como o reranking ([valores](https://docs.conare.ai/pt-BR/query.md#resultados-degradados)) |
| `Idempotent-Replayed` | Resposta | `true` quando uma nova tentativa recebeu a primeira resposta |

## Saúde

`GET /health/deep` não exige chave: `status` é `ok`, `degraded` (ambos HTTP 200) ou `down` (HTTP 503).

```json Response theme={null}
{ "status": "ok", "checkedAt": "2026-10-21T21:39:16.729996745Z" }
```


## Related topics

- [turbopuffer API](https://docs.conare.ai/pt-BR/turbopuffer.md)
- [Connect a source](https://docs.conare.ai/pt-br/api-reference/sources/connect-a-source.md)
- [Disconnect a source](https://docs.conare.ai/pt-br/api-reference/sources/disconnect-a-source.md)
- [Add documents](https://docs.conare.ai/pt-br/api-reference/documents/add-documents.md)
- [Delete a document](https://docs.conare.ai/pt-br/api-reference/documents/delete-a-document.md)


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