Referência de API
Ferramentas MCP, endpoints REST, credenciais e qual documento OpenAPI usar.
Ferramentas MCP
Nomes canônicos, toolsets, aliases, deprecadas.
Endpoints REST
Rotas do engine voltadas ao cliente, no valorbrain-api.
Ciclo de vida dos tokens
Validade, revogação e rotação de cada credencial. Gerado da matriz.
Limites de requisição
Limites por credencial e por rota. Gerado da matriz.
Catálogo de erros
Cada código de erro com causa e ação. Gerado do engine.
Catálogo MCP (gerado)
src/tool-catalog.ts, reconstruído junto com as docs.
REST (gerado)
Todos os paths do OpenAPI público do engine (rotas de cliente), reconstruídos junto com as docs.
OpenAPI: qual arquivo usar
| URL | O que de fato é |
|---|---|
https://valorbrain-api.valor.digital/openapi.json | OpenAPI público do engine, sem autenticação: só as rotas de cliente (documentos e ingest, conversas, busca e retrieve, memory prepare/store/recall/used, signup/identify/claim de agente, tokens MCP, OAuth, health), gerado da tabela de rotas do processo. É a fonte da referência REST deste site. |
https://docs.valorbrain.com.br/openapi.json | Cópia do anterior, regenerada no build das docs (servers reescritos para valorbrain-api e o engine local). |
docs/reference/openapi.yaml no repositório do engine | Contrato completo do engine, com rotas de admin e operação. Só para quem opera a plataforma; não é publicado. |
https://valorbrain.valor.digital/openapi.json | OpenAPI do app: as mesmas rotas de cliente do engine mais as rotas de cliente do app (POST /api/v1/ingest, POST /api/v1/cli/device/code, POST /api/v1/cli/device/token), com o app como servidor. |
O device flow do @valorbrain/connect e o ingest com chave fk_ são rotas
do app em https://valorbrain.valor.digital, não do engine: estão no OpenAPI
do app, não na spec pública do engine.
A matriz de credenciais (prefixos, onde cada um é aceito, variáveis do cliente,
limites e erros) é servida em
https://valorbrain-api.valor.digital/.well-known/valorbrain-credentials.json.
As páginas Tokens,
Ciclo de vida,
Limites e Erros são geradas dela,
e este site publica a mesma cópia em
/valorbrain-credentials.json.
Para integrar, use a spec pública do engine (ou a cópia deste site) e a página Endpoints REST.
Docs legíveis por máquina
| URL | Conteúdo |
|---|---|
/llms.txt | Índice + roteamento para agentes |
/llms-full.txt | Markdown completo de todas as páginas |
/.well-known/mcp/server-card.json | Card MCP vivo (produto, não este host de docs) |
/.well-known/agent-card.json | Nosso agent card, apontando para o MCP do produto |