For the complete BrainAPI documentation index, see llms.txt. A markdown version of any docs page is available by appending .md to its URL. Docs MCP: /docs/mcp.
Console
Local web UI to inspect and operate a BrainAPI instance
The BrainAPI Console is a small React + Vite + Tailwind SPA (brainapi-console) for inspecting and operating a local BrainAPI instance.
It is a browser dashboard for data already in a brain, not the setup TUI and not a chat UI.
Use it to browse the graph, text chunks, vectors, observations, and tasks, and to run quick ingests.
How it is served
- Built output goes to
console/dist/. - The FastAPI app mounts it at
/console/whenCONSOLE_ENABLEDis notfalseanddistexists (make build-console). - Console static assets and routes are excluded from BrainPAT middleware. You still authenticate inside the SPA.
Build the console, then open it from your running BrainAPI instance.
make build-console
# then visit
# http://localhost:8000/console/Auth and brain scoping
Login stores a session (API base URL + BrainPAT) in local storage:
GET /meta/login-inforesolves whether the token is system-wide or brain-scoped and whichbrain_idapplies.- Validates with
GET /meta/entity-labels. - Every API call sends
BrainPAT,Authorization: Bearer …, andX-Brain-IDfor non-/systemroutes.
Prop
Type
Pages
| Route | Purpose |
|---|---|
| Overview | Counts for entities, relationships, text chunks, observations, tasks, and vector stores via /retrieve/* and /tasks/. |
| Graph | Interactive vis-network graph: load entities/relationships, filter by label/query, expand neighbors, merge graph state. |
| Data | Paginated text chunks and structured data (/retrieve/text-chunks, /retrieve/structured-data), with type filter for structured rows. |
| Observations | Browse and filter observations (/retrieve/observations). |
| Vectors | List vector stores and browse vectors. |
| Tasks | List ingestion/Celery tasks (/tasks/), expand details, poll non-terminal statuses. |
| Ingest | POST /ingest/ with raw text; optional create brain via POST /system/brains when using a system PAT. |
Console text ingest posts to POST /ingest/ (async 202). For event-centric
structured triples, use the REST structured ingestion
API. Task polling uses GET /tasks/ — missing ids return 404.
The console is an operator and debug UI for graph, chunks, vectors, observations, tasks, and quick ingest. For conversational interfaces, see the Chatbot plugin.
Last updated on