Start here
ReferenceReference
The exact technical contract of Volobox: the HTTP API, the MCP server, webhooks and events, and the formats of manifests, workflows, apps and skills.
The reference is the exact contract: endpoints, headers, payloads, file formats, fields and commands, written for someone writing code against Volobox. For how to do a job end to end, start with the guides; for what an area is for, see the overview.
HTTP API
Volobox has a versioned public HTTP API under /api/v1/. Every call carries a bearer token, and acts with the permissions of the person, or the integration, it belongs to.
- API overview: base URL, versioning, authentication, action groups, paging, errors and retries. Read this first.
- One page per action group, listing every endpoint with its method, path and operation id: Agenda, Audit log, Calendar, Conversations, Docs, Files, Meetings, People, Projects, Support and Workspace.
Note
The endpoint pages and the event catalog are generated from the API description and the event catalog in the product, so they change when the product does. The full OpenAPI description, with every request and response schema, is served by your own workspace to signed-in callers.
MCP and events
- MCP server: the hosted endpoint, OAuth discovery, client registration, tool naming and the tools it offers.
- Webhooks: what a delivery contains, how it is signed, and when it is retried.
- Event catalog: every event Volobox can deliver to a webhook.
Formats
- Preview manifest:
volobox.app.yamlandvolobox.workspace.yaml, the files that tell Volobox how to run your app on a branch. - Code workflow API: the globals a Code workflow body uses, and how a waiting body resumes.
- App files:
app.json, rules, screens and the screen SDK of a custom app. - Skill, command and pack formats:
SKILL.md, slash command templates,pack.jsonand a pack registry's index. - The volobox command in coding sandboxes: what a coding agent can ask Volobox from inside its sandbox.
For AI tools
Every docs page has a plain Markdown version at the same address with .md added, such as /docs/api-overview.md. The site also publishes /llms.txt, a list of every page with a one-line description, and /llms-full.txt, all pages in one file.