Docs

API

Find the endpoint, contract, and failure mode without leaving the page. The canonical HTTP API reference - every route the aggregator serves, with method, auth, request shape, response shape, and how each one fails.

See it in motion

Where to find it

  • Desktop: localhost:4000, then Memory in the sidebar, then Reference index under All tools, in the Lessons, wiki and patterns group, which lists it.
  • Hosted: repoops.ai/team/reference, from Memory in the sidebar, then Reference index under All tools, in the Lessons, wiki and patterns group, which lists it.
  • Keyboard: ⌘ K, then type “API”.
  • On disk: .claude/brain/api.md

What it does for you

One canonical list - no guessing what's real.Every endpoint the server exposes lives in this file. Add a route to lib/routes/*.mjs, add a fragment under .claude/brain/api.d/, and run npm run sync-api in the SAME PR. The list is the contract.
The error shape is stated once, up front.The convention block at the top of the file sets the rule every route follows: an error comes back as { error } with a 4xx or 5xx status, and a few endpoints soft-error with a 200 and { ok: false, error } so the UI can render the message inline instead of crashing. Endpoints with a failure worth calling out carry their own Errors note.
There is no second copy to keep in step.Edit the markdown. The HTML page a reader opens is rendered from it on request, so there is nothing to regenerate and nothing to forget.

Configure

Nothing to configure. Endpoint documentation is written as fragments in .claude/brain/api.d/, and npm run sync-api folds them into the managed block of api.md. The HTML a reader opens is rendered from that markdown per request.

Use it well

When you add an endpoint in lib/routes/*.mjs, document it as a new fragment in .claude/brain/api.d/ and run npm run sync-api in the same PR (method, path, auth, request, response, errors). The generator folds every fragment into the managed block at the end of api.md, so never hand-edit that block; a fragment added without the fold fails the brain-drift fold-drift gate. When you change an endpoint's response shape, update its fragment in the same PR. Two brain-drift gates check the row: api-vs-routes fails a route api.md never mentions, and api-doc-fields fails a documented top-level response field the handler does not return, plus a returned field the section never names. Neither reads types, nullability, nested keys, or the hosted routes, so the rest is on you.

Read more

Last updated