# BrainstormRouter System API

**Canonical:** https://apis.io/apis/brainstormrouter-com/brainstormrouter-com-system-api/  
**Provider:** BrainstormRouter — https://apis.io/providers/brainstormrouter-com/  
**Base URL:** https://api.brainstormrouter.com  
**Documentation:** https://brainstormrouter.com/developers

BrainstormRouter System API is one of 73 APIs that [BrainstormRouter](https://apis.io/providers/brainstormrouter-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include System. The published artifact set on APIs.io includes an OpenAPI specification.

The system API from BrainstormRouter — 243 operation(s) for system.

## Operations (60 of 316)

| Method | Path | Summary |
|---|---|---|
| GET | `/health` | Liveness probe — returns ok while the process is up and serving HTTP |
| GET | `/metrics` | Prometheus-compatible metrics endpoint (text exposition format) |
| GET | `/v1/account` | Get tenant profile with user count |
| PATCH | `/v1/account` | Update tenant profile (currently: name) |
| POST | `/v1/account/graduate` | Graduate a sandbox tenant to standard tier via a verified provider key (BYOK) |
| GET | `/v1/account/graduation` | Graduation criteria + live progress for a sandbox tenant (machine-readable) |
| GET | `/v1/account/users` | List users in the current tenant (RLS-scoped) |
| POST | `/v1/account/users/invite` | Invite a user by email; returns claim URL (201) |
| DELETE | `/v1/account/users/{id}` | Remove a user from the current tenant |
| POST | `/v1/account/verify-email` | Send a verification code to upgrade a sandbox tenant to standard tier |
| POST | `/v1/account/verify-email/confirm` | Confirm the code — promote sandbox tenant to standard tier ($5/day) |
| GET | `/v1/agent-limits` | Read the per-agent limits map for the current tenant |
| PATCH | `/v1/agent-limits` | Merge updates into the per-agent limits map (null value deletes an entry) |
| PUT | `/v1/agent-limits` | Replace the entire per-agent limits map (canonicalizes keys to `agent:`) |
| GET | `/v1/agent/task-runs` | Query task-run history (filter by project, limit) |
| POST | `/v1/agent/task-runs` | Report a completed task run (Brainstorm CLI integration; 201) |
| POST | `/v1/agents/{agentId}/run` | Start the agent loop for a session and stream events as SSE |
| GET | `/v1/agents/{agentId}/runs` | Run history for an agent (sessions with aggregate metadata) |
| POST | `/v1/agents/{agentId}/sessions` | Create an idle session for the agent (no loop) |
| DELETE | `/v1/agents/{agentId}/sessions/{sessionId}` | Terminate a session (status → ended) |
| GET | `/v1/agents/{agentId}/sessions/{sessionId}` | Get a session by id |
| POST | `/v1/agents/{agentId}/sessions/{sessionId}/events` | Publish a user event to a running session (PG NOTIFY) |
| GET | `/v1/aliases` | Read the model alias map for the current tenant |
| PATCH | `/v1/aliases` | Merge alias updates (null value deletes a key) |
| PUT | `/v1/aliases` | Replace the entire model alias map (rejects null values; use PATCH to delete) |
| GET | `/v1/api-keys` | List API keys (no plaintext, preview only) |
| POST | `/v1/api-keys` | Create a new API key (plaintext returned once) |
| DELETE | `/v1/api-keys/{id}` | Revoke an API key (soft-delete; cache invalidated immediately) |
| PATCH | `/v1/api-keys/{id}` | Update an API key's scopes, limits, or metadata (self-service) |
| GET | `/v1/approvals/pending` | List pending approval requests for the tenant |
| POST | `/v1/approvals/queue` | Submit a deferred action for human review |
| POST | `/v1/approvals/{id}/approve` | Approve a pending request and execute its deferred action |
| POST | `/v1/approvals/{id}/reject` | Reject a pending request without executing its action |
| POST | `/v1/auth/device/authorize` | Start a device-authorization flow (admin scope required) |
| POST | `/v1/auth/device/token` | Poll device-authorization status |
| POST | `/v1/auth/link` | Generate a browser-based dashboard link URL (admin scope) |
| GET | `/v1/billing/plan` | Current tenant plan + usage vs limits |
| PUT | `/v1/billing/plan` | Switch the tenant's billing plan (platform operator only; tenants get 403… |
| GET | `/v1/billing/plans` | List available billing plans |
| GET | `/v1/budget` | Alias of /v1/budget/status served at the bare /v1/budget path |
| GET | `/v1/budget/agents` | List per-agent budget configurations and current status |
| PUT | `/v1/budget/agents/{agentId}` | Set budget configuration for a specific agent |
| GET | `/v1/budget/alerts/config` | Get current budget alert configuration |
| PUT | `/v1/budget/alerts/config` | Update budget alert configuration (thresholds, webhook, enabled) |
| GET | `/v1/budget/alerts/history` | Recent budget alert events for the tenant |
| GET | `/v1/budget/forecast` | Spend forecast, projected depletion date, anomaly detection |
| PUT | `/v1/budget/limits` | Update tenant-level daily and monthly budget limits |
| GET | `/v1/budget/status` | Current tenant + key spend against daily/monthly limits |
| GET | `/v1/capabilities` | Machine-queryable, trust-scored graph of BR's own capabilities — query, don't… |
| GET | `/v1/capacity/forecast` | Predict rate-limit exhaustion + budget burn per provider (DB-backed forecast) |
| GET | `/v1/capacity/providers` | Per-provider capacity status (24h) — request count, success rate, latency… |
| GET | `/v1/catalog/runnable` | Filtered list of models routable right now (circuit-closed + sentinel-healthy +… |
| GET | `/v1/catalog/status` | Curated-catalog status: total endpoints, models, per-provider counts |
| GET | `/v1/config` | List all config sections (RBAC-filtered, sensitive fields redacted for… |
| POST | `/v1/config/import` | Import configuration sections from the on-disk file (admin only) |
| GET | `/v1/config/otel` | OpenTelemetry exporter configuration: endpoint, service name, batching |
| DELETE | `/v1/config/{key}` | Delete a config section (reset to defaults) |
| GET | `/v1/config/{key}` | Read a single config section (sensitive fields redacted for non-admins) |
| PATCH | `/v1/config/{key}` | Merge-patch a config section (RFC 7396) with optional OCC |
| PUT | `/v1/config/{key}` | Replace a config section (full PUT) with OCC via If-Match header |

…and 256 more operations. The page lists the first 250; the full set of 316 is in the OpenAPI linked below.

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/brainstormrouter-com/openapi/brainstormrouter-com-system-api-openapi.yml

## Other BrainstormRouter APIs (12)

- [BrainstormRouter A2a API](https://apis.io/apis/brainstormrouter-com/brainstormrouter-com-a2a-api/)
- [BrainstormRouter Admin API](https://apis.io/apis/brainstormrouter-com/brainstormrouter-com-admin-api/)
- [BrainstormRouter Agent API](https://apis.io/apis/brainstormrouter-com/brainstormrouter-com-agent-api/)
- [BrainstormRouter Agent Bootstrap API](https://apis.io/apis/brainstormrouter-com/brainstormrouter-com-agent-bootstrap-api/)
- [BrainstormRouter Agent Manifests API](https://apis.io/apis/brainstormrouter-com/brainstormrouter-com-agent-manifests-api/)
- [BrainstormRouter Agent Onboarding API](https://apis.io/apis/brainstormrouter-com/brainstormrouter-com-agent-onboarding-api/)
- [BrainstormRouter Agent Profiles API](https://apis.io/apis/brainstormrouter-com/brainstormrouter-com-agent-profiles-api/)
- [BrainstormRouter Agents API](https://apis.io/apis/brainstormrouter-com/brainstormrouter-com-agents-api/)
- [BrainstormRouter Analytics API](https://apis.io/apis/brainstormrouter-com/brainstormrouter-com-analytics-api/)
- [BrainstormRouter Anomaly API](https://apis.io/apis/brainstormrouter-com/brainstormrouter-com-anomaly-api/)
- [BrainstormRouter API Keys API](https://apis.io/apis/brainstormrouter-com/brainstormrouter-com-api-keys-api/)
- [BrainstormRouter Approvals API](https://apis.io/apis/brainstormrouter-com/brainstormrouter-com-approvals-api/)

## Tags

System

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/brainstormrouter-com/brainstormrouter-com-system-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/brainstormrouter-com/.