API reference
MCP tools, REST endpoints, credentials, and which OpenAPI document to use.
MCP tools
Canonical names, toolsets, aliases, deprecated.
REST endpoints
Customer-facing engine routes on valorbrain-api.
Token lifecycle
Expiry, revocation and rotation of every credential. Generated from the matrix.
Rate limits
Limits per credential and per route. Generated from the matrix.
Error catalog
Every error code with cause and action. Generated from the engine.
MCP catalog (generated)
src/tool-catalog.ts, rebuilt with the docs.
REST (generated)
Every path of the engine's public OpenAPI (client routes), rebuilt with the docs.
OpenAPI: which file to use
| URL | What it actually is |
|---|---|
https://valorbrain-api.valor.digital/openapi.json | The engine's public OpenAPI, no auth needed: client routes only (documents and ingest, conversations, search and retrieve, memory prepare/store/recall/used, agent signup/identify/claim, MCP tokens, OAuth, health), generated from the process' route table. The source of this site's REST reference. |
https://docs.valorbrain.com.br/openapi.json | A copy of the above, regenerated at docs build (servers rewritten to valorbrain-api and the local engine). |
Engine repo docs/reference/openapi.yaml | The engine's full contract, admin and operations routes included. For the platform operator only; not published. |
https://valorbrain.valor.digital/openapi.json | The app's OpenAPI: the same engine client routes plus the app's client routes (POST /api/v1/ingest, POST /api/v1/cli/device/code, POST /api/v1/cli/device/token), with the app as server. |
The @valorbrain/connect device flow and fk_ key ingest are app routes on
https://valorbrain.valor.digital, not engine routes: they are in the app's
OpenAPI, not in the engine's public spec.
The credential matrix (prefixes, where each one is accepted, client variables,
limits and errors) is served at
https://valorbrain-api.valor.digital/.well-known/valorbrain-credentials.json.
The Tokens,
Token lifecycle,
Rate limits and Errors
pages are generated from it, and this site publishes the same copy at
/valorbrain-credentials.json.
To integrate, use the engine's public spec (or this site's copy) and the REST endpoints page.
Machine-readable docs
| URL | Content |
|---|---|
/llms.txt | Index + routing for agents |
/llms-full.txt | Full markdown of every page |
/.well-known/mcp/server-card.json | Live MCP card (product, not this docs host) |
/.well-known/agent-card.json | Our agent card, pointing at the product MCP |