Documentation Menu
Developer Access Overview
Every way to work with your BrainRoad account from code: API keys, the REST API, MCP connections, event streaming, WebSocket access, and webhook triggers.
On this page
What developer access covers
Most people never need this section. The dashboard covers everyday use. But if you (or a developer helping you) want to connect other tools to your account, BrainRoad exposes several programmatic surfaces:
- REST API (
/api/v1/): check status, start or stop your helper, propose work for review, read billing. See Public API Reference. - OpenAI-compatible chat API (
/v1/chat/completions): talk to your helper from any tool that speaks the OpenAI API format. - MCP connection (
https://app.brainroad.com/mcp/brain): connect Claude Code, Codex, or another MCP client to your Business Brain and your review queue. MCP (Model Context Protocol) is a standard way for AI tools to connect to approved business context and capabilities. See MCP Integration. - Event streaming (SSE): a live feed of your helper’s activity for monitoring and logging. See Event Streaming.
- WebSocket RPC and webhook triggers: direct access to the OpenClaw runtime, plus wake and task webhook URLs you can point outside tools at. See WebSocket RPC.
Everything lives in two dashboard places:
- API in the sidebar (
/dashboard/api), the “Developer Access” page: API keys, the MCP endpoint with ready-made setup snippets, the WebSocket connection details, REST examples, and event streaming. - Settings → Developer Triggers: the Wake Webhook and Task Endpoint URLs for your running OpenClaw helper.
The review rule still applies
External tools can read your Business Brain and propose work, but they can never approve it. Anything that would touch the outside world (like sending an email) lands as a draft in your Inbox for you to review first. There is no API or MCP call that approves a card. Approval happens only in the dashboard, by a person.
Two kinds of credentials
| Credential | What it is for | Where to get it |
|---|---|---|
API key (starts with brk_) | The BrainRoad platform: REST API, OpenAI-compatible chat, the public MCP endpoint, event streaming | Dashboard → API → “AI connections and API keys” |
| Gateway Token | Your helper’s own runtime: WebSocket RPC and the per-agent MCP endpoint | Dashboard → API → Gateway Connection (helper must be running) |
API keys are scoped: you choose exactly what each key can do when you create it. You can hold up to 10 active keys and revoke any of them instantly. Details: API Keys.
The Gateway Token gives full access to your helper. Keep it secret.
Rate limits and the trial
| Surface | Limit |
|---|---|
REST API (/api/v1/) | 120 requests/min per key |
Chat completions (/v1/chat/completions) | 20 requests/min per key |
Model list (/v1/models) | 60 requests/min |
MCP endpoint (/mcp/brain) | 120 requests/min per key |
| API keys per account | 10 active |
The 30-day free trial applies to developer access too. When the trial ends, chat completions, starting your helper, provisioning, and the MCP endpoint require a Pro subscription. See Plans & Pricing.