Visão geral da API

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; mantenha-as no seu servidor
Corpos	JSON, snake_case; campos desconhecidos dão `400`
Especificação	api.conare.ai/openapi.yaml

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

{
  "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 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
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 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	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)
`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)
`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).

Response

{ "status": "ok", "checkedAt": "2026-10-21T21:39:16.729996745Z" }

Visão geral

Namespaces

Documentos

Busca

Arquivos

Conversão

Fontes

Fontes personalizadas

Modelos

Usuários

Eventos

Organizações

Integridade

Visão geral da API

Erros

Novas tentativas

Limites de taxa

Headers

Saúde

​Erros

​Novas tentativas

​Limites de taxa

​Headers

​Saúde

Erros

Novas tentativas

Limites de taxa

Headers

Saúde