Skip to main content

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.

→ GraphQL API

WebSocket​

PathPurpose
ws://localhost:3005/ws/Event stream (agent)
ws://localhost:3005/terminal/Bidirectional terminal I/O (agent)
wss://<your-workspaces-graphql-endpoint>/graphqlGraphQL subscriptions (backend)

→ WebSocket channels

CLI​

vibecontrols --help

→ CLI reference

Open-source code​

  • Agent: github.com/algoshred/vibecontrols-agent
  • CLI: github.com/algoshred/vibecontrols-cli
  • MCP: github.com/algoshred/vibecontrols-mcp
  • Backend, agent, CLI, MCP, plugin SDK, and built-in plugins: published on github.com/algoshred (search vibecontrols, vibe-plugin-*)
  • Plugin SDK: github.com/algoshred/vibecontrols-plugin-sdk