API Reference
REST (agent, localhost)
Default base: http://localhost:3005. Routes are profile-prefixed (/api/profiles/<name>/...) except for a few exempt routes.
→ REST API
OpenAPI spec available at http://localhost:3005/api/profiles/<profile>/openapi.json while the agent is running.
GraphQL (backend)
https://<your-workspaces-graphql-endpoint>/graphql
The Vibecontrols GraphQL API, served by the Burdenoff Workspaces platform. Find your workspace's endpoint in the platform developer docs. Requires a bearer token plus the x-workspace-id header; every operation is permission-checked against your role in that workspace.
WebSocket
| Path | Purpose |
|---|---|
ws://localhost:3005/ws/ | Event stream (agent) |
ws://localhost:3005/terminal/ | Bidirectional terminal I/O (agent) |
wss://<your-workspaces-graphql-endpoint>/graphql | GraphQL subscriptions (backend) |
CLI
vibecontrols --help
Environment selection
All API endpoints default to production. Use BURDENOFF_ENV=local|alpha|prod (default prod) with the CLI, SDK, or extensions. Direct API callers should use the endpoints below:
| Environment | Workspace gateway | Global gateway | Agent REST |
|---|---|---|---|
prod (default) | https://graphqlworkspaces.burdenoff.com/workspaces/graphql | https://graphql.burdenoff.com/global/graphql | http://localhost:3005 |
alpha | https://alphagraphqlworkspaces.burdenoff.com/workspaces/graphql | https://alphagraphql.burdenoff.com/global/graphql | http://localhost:3005 |
local | http://localhost:4003/workspaces/graphql | http://localhost:4000/global/graphql | http://localhost:3005 |
Ecosystem repositories
| Component | Repository | Package |
|---|---|---|
| Agent | github.com/algoshred/vibecontrols-agent | @vibecontrols/agent |
| CLI | github.com/algoshred/vibecontrols-cli | @vibecontrols/cli |
| Node SDK | github.com/algoshred/vibecontrols-sdk-node | @vibecontrols/sdk |
| Python SDK | github.com/algoshred/vibecontrols-sdk-python | vibecontrols-sdk (PyPI) |
| MCP Server | github.com/algoshred/vibecontrols-mcp | @vibecontrols/mcp |
| Browser Extension | github.com/algoshred/vibecontrols-browser-extension | Chrome Web Store |
| VS Code Extension | github.com/algoshred/vibecontrols-code-extension | VS Code Marketplace |
| Doctor (E2E) | github.com/algoshred/vibecontrols-doctor | — |
| Backend Service | github.com/algoshred/wspace-vibecontrols-svc | — |
| Plugin SDK | github.com/algoshred/vibecontrols-plugin-sdk | @vibecontrols/plugin-sdk |
| Built-in plugins | github.com/algoshred (search vibe-plugin-*) | — |