Pular para o conteúdo
openapi.yaml ↓

Documentação para agentes

Texto puro, curto e sem navegação — feito para caber no contexto de um modelo. Aponte o seu agente para um destes endereços.

/llms.txt
# Abeesys RAG

> Conhecimento com citação — insira texto curto e pergunte; cada resposta diz de onde veio.

Endereço público: `https://api.rag.abeesys.com`.

## Autenticação

- `apiKey`: http bearer — `Authorization: Bearer <key>`. API key do tenant, guardada só como hash. A do CLI e as geradas pela pessoa usam o mesmo esquema. Revogada, a próxima chamada é 401, o mesmo de uma key que nunca existiu.
- `session`: http bearer — `Authorization: Bearer <key>`. Sessão de pessoa. Só vale em `Authorization: Bearer`. O cabeçalho `Cookie` é ignorado: sozinho ou junto de um bearer inválido, não autentica.
- `assistantToken`: oauth2. Access token opaco emitido por esta API ao assistente (prefixo `rag_mcp_at_`), depois do consentimento de uma pessoa da conta. Vale 1 h e **só autentica `/mcp`**: em qualquer rota REST é 401. API key e sessão não autenticam `/mcp`.
- Sem API key: `GET /v1/health`, `GET /v1/health/ready`, `POST /v1/entrar`, `POST /v1/entrar/link`, `POST /v1/convites/aceitar`, `GET /.well-known/oauth-protected-resource/mcp`, `GET /.well-known/oauth-protected-resource`, `GET /.well-known/oauth-authorization-server`, `GET /oauth/authorize`, `POST /oauth/register`, `POST /oauth/token`, `GET /mcp`, `GET /openapi.yaml`, `GET /openapi.json`, `GET /llms.txt`, `GET /llms-full.txt`.

## Rotas

Os caminhos abaixo — inclusive `/openapi.json` — são relativos ao endereço da API (`https://api.rag.abeesys.com`).

- `GET /v1/health`: O processo está de pé (sem API key)
- `GET /v1/health/ready`: Pronto para receber tráfego (sem API key)
- `POST /v1/conhecimento`: Insere ou revisa um conhecimento
- `GET /v1/conhecimento`: Lista o conhecimento do tenant
- `GET /v1/conhecimento/{id}`: Lê a versão atual de um conhecimento
- `PUT /v1/conhecimento/{id}`: Edita um conhecimento por id (substituição completa)
- `GET /v1/conhecimento/{id}/versoes`: Lista as versões de um conhecimento, da mais nova para a mais antiga
- `GET /v1/conhecimento/{id}/versoes/{versao}`: Abre o texto inserido numa versão — é o caminho da origem de um trecho
- `PUT /v1/conhecimento/{id}/veto`: O tenant segura o próprio conhecimento
- `DELETE /v1/conhecimento/{id}/veto`: Tira o veto — o conhecimento volta sem reinserir
- `PUT /v1/conhecimento/{id}/arquivo`: Arquiva — tira o conhecimento da base sem apagar
- `DELETE /v1/conhecimento/{id}/arquivo`: Desarquiva — o conhecimento volta sem reinserir
- `GET /v1/conhecimento/{id}/rastro`: Rastro de arquivamento e desarquivamento
- `PUT /v1/conhecimento/{id}/sobreposicao`: O escopo escreve a versão dele de um conhecimento da base
- `GET /v1/conhecimento/{id}/sobreposicao`: Lê a sobreposição do escopo para um conhecimento da base
- `DELETE /v1/conhecimento/{id}/sobreposicao`: Desfaz a sobreposição — a base volta ao escopo
- `GET /v1/credenciais`: Lista as credenciais de modelo do tenant, na ordem de preferência
- `GET /v1/credenciais/{nome}`: Lê uma credencial de modelo do tenant, sem o segredo
- `PUT /v1/credenciais/{nome}`: Cadastra ou troca uma credencial de modelo do tenant
- `DELETE /v1/credenciais/{nome}`: Remove uma credencial de modelo do tenant
- `PUT /v1/credenciais/{nome}/ligada`: Liga a credencial
- `DELETE /v1/credenciais/{nome}/ligada`: Desliga a credencial
- `PUT /v1/ordem-das-credenciais`: Muda a ordem de preferência das credenciais
- `GET /v1/rastro-das-credenciais`: O rastro das mudanças nas credenciais do tenant
- `POST /v1/perguntas`: Pergunta ao conhecimento do tenant que pergunta
- `POST /v1/entrar`: Pede o link de entrada (sem API key)
- `POST /v1/entrar/link`: Abre a sessão com o link de uso único (sem API key)
- `POST /v1/convites/aceitar`: Aceita um convite e cria a pessoa nesta conta (sem API key)
- `POST /v1/convites`: Convida um e-mail para a conta
- `GET /v1/sessao`: Diz de quem é a sessão deste bearer
- `POST /v1/sessao/encerrar`: Encerra a sessão deste bearer
- `GET /v1/pessoas`: Lista as pessoas da conta
- `DELETE /v1/pessoas/{id}`: Remove uma pessoa da conta
- `POST /v1/chaves`: Gera uma API key da conta
- `GET /v1/chaves`: Lista as API keys da conta
- `DELETE /v1/chaves/{id}`: Revoga uma API key da conta
- `GET /v1/rastro-da-conta`: Rastro da conta
- `GET /.well-known/oauth-protected-resource/mcp`: Metadados do recurso MCP (RFC 9728) (sem API key)
- `GET /.well-known/oauth-protected-resource`: Metadados do recurso MCP (RFC 9728), no caminho sem sufixo (sem API key)
- `GET /.well-known/oauth-authorization-server`: Metadados do servidor de autorização (RFC 8414) (sem API key)
- `GET /oauth/authorize`: Início da autorização — aberto pelo navegador, por navegação (sem API key)
- `POST /oauth/register`: Registro dinâmico restrito (RFC 7591) — cliente público (sem API key)
- `POST /oauth/token`: Troca o código ou o refresh por access e refresh (sem API key)
- `POST /mcp`: MCP Streamable HTTP, sem estado, JSON-RPC 2.0
- `GET /mcp`: Sem stream iniciado pelo servidor (sem API key)
- `GET /v1/pedidos-de-autorizacao/{pedido}`: O pedido de autorização, para a tela de consentimento
- `POST /v1/pedidos-de-autorizacao/{pedido}/aprovacao`: A pessoa aprova o pedido
- `POST /v1/pedidos-de-autorizacao/{pedido}/recusa`: A pessoa recusa o pedido
- `GET /v1/autorizacoes`: Assistentes conectados à conta
- `DELETE /v1/autorizacoes/{id}`: Revoga a autorização de um assistente
- `GET /openapi.yaml`: Este contrato, em YAML (sem API key)
- `GET /openapi.json`: Este contrato, em JSON (sem API key)
- `GET /llms.txt`: Índice curto para agentes (llmstxt.org) (sem API key)
- `GET /llms-full.txt`: Documentação completa para agentes (sem API key)

## Documentação

- [Documentação completa](/llms-full.txt): rotas, parâmetros, campos, enums, respostas, tipos de erro e exemplos
- [Contrato OpenAPI](/openapi.yaml): o contrato, para gerar cliente