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 Índice: o que o serviço faz, onde atende e cada rota.
/llms-full.txt Tudo num arquivo: rotas, campos, enums, erros e exemplos.
/openapi.yaml O contrato OpenAPI, para gerar cliente.
Em breve MCP Servidor MCP remoto com OAuth 2.1, para usar a sua base de dentro do ChatGPT e do Claude.

/llms.txt

# Abeesys RAG

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

A API ainda não tem endereço público. Hoje ela atende só em: `http://rag.railway.internal:8000` — rede privada do Railway; `http://localhost:8002` — stack local (make up).

## Autenticação

- `apiKey`: http bearer — `Authorization: Bearer <key>`. API key do tenant, gerada pelo `cmd/admin` e guardada só como hash.
- Sem API key: `GET /v1/health`, `GET /v1/health/ready`, `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, que ainda não é público. Um site que só publica esta documentação não os atende.

- `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/{id}`: Lê a versão atual de um conhecimento
- `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/credenciais/{nome}`: Cadastra ou troca uma credencial de modelo do tenant
- `POST /v1/perguntas`: Pergunta ao conhecimento do tenant que pergunta
- `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