Autenticação
Todas as requisições da API requerem autenticação via chave de API. As chaves de API usam o prefixo aqn_ e são gerenciadas na página Chaves de API.
Chaves de API
Existem dois tipos de chaves de API:
| Tipo | Descrição | Caso de uso |
|---|---|---|
| Acesso total | Pode ver todas as suas coleções (próprias + assinadas) | Integração MCP, automação pessoal |
| Restrita | Pode ver apenas coleções explicitamente concedidas; cada concessão tem um read ou write nível de permissão |
Desenvolvedores externos, integrações de terceiros |
Chaves restritas suportam dois níveis de permissão por concessão de coleção: read (pesquisar e recuperar) e write (pesquisar, recuperar e enviar documentos). Acesso de escrita é necessário para usar o endpoint de envio de documentos (POST /api/v1/collections/{id}/documents/). Chaves de acesso total podem enviar documentos para qualquer coleção pertencente ao proprietário da chave sem uma concessão separada.
Criando uma Chave
- Vá para Chaves de API na barra lateral (ou visite
/keys/) - Clique em Criar Chave
- Escolha um nome e se deve ser acesso total ou restrita
- Copie a chave imediatamente — ela não será exibida novamente
- Para chaves restritas, clique em Gerenciar para conceder acesso a coleções específicas
Usando Sua Chave
Inclua a chave no cabeçalho Authorization de todas as requisições:
Authorization: Bearer aqn_your_api_key_here
Exemplo:
curl -X POST https://your-instance/api/v1/search/ \
-H "Authorization: Bearer aqn_your_api_key" \
-H "Content-Type: application/json" \
-d '{"query": "your search"}'
As chaves podem ser rotacionadas ou revogadas na página Chaves de API a qualquer momento.