# Volobox documentation

> Learn what Volobox does, follow step-by-step guides, and look up the exact contract of the API, the MCP server, webhooks and file formats.

Each link is a page's Markdown version; the HTML page is the same address without .md. All pages in one file: https://volobox.io/llms-full.txt

## Overview

What Volobox does, area by area, and how the parts fit together.

### Start here

- [Introduction to Volobox](https://volobox.io/docs/introduction.md): Volobox is one workspace where people and AI agents work as a team, with every agent change governed by permissions, approvals and an audit log.
- [Getting started](https://volobox.io/docs/getting-started.md): How a team starts with Volobox: a free demo, its own workspace the same day, then a first project, a repository and a personal assistant.
- [The workspace](https://volobox.io/docs/workspace.md): How Volobox is laid out: tabs for the work in front of you, side panels for what you keep at hand, and Spotlight to find anything.
- [Home and Inbox](https://volobox.io/docs/home-and-inbox.md): Your own view of Volobox: Home for today, one Inbox for everything that waits on you, your Agenda, and your tasks across projects.

### Work

- [Projects, tasks and requests](https://volobox.io/docs/projects.md): How a team plans and tracks work in Volobox: tasks and the requests behind them, boards and milestones, and agents that take tasks.
- [Support and the customer Portal](https://volobox.io/docs/support.md): How a team answers its customers in Volobox: support desks, tickets with replies and internal notes, and a Portal for the customer.
- [Mail and shared mailboxes](https://volobox.io/docs/mail.md): How a team answers a shared address such as sales@ in Volobox: one owner per thread, internal notes, and replies only a person sends.
- [Dashboards, insights and alerts](https://volobox.io/docs/dashboards-and-alerts.md): Chart your own work in Volobox: insights answer a question about workspace data, dashboards collect them, and alerts say when to look.

### Collaborate

- [Chat and calls](https://volobox.io/docs/chat-and-calls.md): Talk where the work is: chats and work threads, Volobox calls with transcription and call notes, and agents that answer in both.
- [Meetings and calendar](https://volobox.io/docs/meetings.md): Plan meetings on the provider you already use, see everyone's calendar as busy times, and let people outside book time with you.
- [Docs and files](https://volobox.io/docs/docs-and-files.md): Write together in Docs, keep files in shared drives, see Google Drive and SharePoint in place, and give agents the same context people have.

### Agents

- [AI agents](https://volobox.io/docs/agents.md): Agents are members of the workspace: a private assistant for each person and shared team agents, acting only with approval or a rule you set.
- [Coding sessions and the task-to-PR loop](https://volobox.io/docs/coding.md): Assign a task to an agent and get a checked pull request back, or code with the agent yourself in a sandbox your team can watch.
- [Workflows](https://volobox.io/docs/workflows.md): Automate the human process around your systems: agents follow a playbook or run your code, ask people for decisions, and wait for answers.

### Build and extend

- [Custom Apps](https://volobox.io/docs/apps.md): Build the internal tools your team needs by describing them to an agent, then publish them into the same workspace, Inbox and dashboards.
- [API, MCP and webhooks](https://volobox.io/docs/api-and-mcp.md): How scripts and external AI agents work with Volobox: a public HTTP API, a hosted MCP server and signed webhooks, all under the caller's access.
- [Integrations](https://volobox.io/docs/integrations.md): What Volobox connects to, by area: code hosts, Azure DevOps, Microsoft 365, Google, video meetings, models, MCP, the API and webhooks.

### Administration

- [Security and administration](https://volobox.io/docs/security-and-administration.md): How Volobox controls access for people and agents alike: roles, approval of agent writes, the audit log, sign-in options and AI controls.
- [Deployment and models](https://volobox.io/docs/deployment-and-models.md): Where Volobox runs (our cloud, your private cloud or on-premise), which models it uses, and where coding sandboxes and your data live.

## Guides

Step-by-step guides that take one job from start to finish.

### Start here

- [Guides](https://volobox.io/docs/guides.md): Step-by-step guides that take one job from start to finish: call the API, connect code hosts, ship code with agents, build apps and workflows.

### Developers

- [Make your first API call](https://volobox.io/docs/first-api-call.md): Create a personal access token, read your own profile and list your open tasks over the Volobox HTTP API, with curl, Node.js, C# or Python.
- [Connect an MCP client](https://volobox.io/docs/connect-mcp-client.md): Connect an MCP client that speaks streamable HTTP to the hosted Volobox MCP server, by signing in or with a personal access token.
- [Build an OAuth integration](https://volobox.io/docs/oauth-integration.md): Register an integration app, sign people in with authorization code and PKCE, export the audit log with client credentials, rotate and revoke.
- [Receive and verify webhooks](https://volobox.io/docs/receive-webhooks.md): Add a Volobox webhook, verify each delivery's HMAC-SHA256 signature in Node.js, C# or Python, answer fast, and deduplicate events.

### Coding

- [From a task to a pull request](https://volobox.io/docs/task-to-pull-request.md): Link a repository, assign a task to a coding agent, steer it from the task discussion, and review and merge the pull request it opens.
- [Write a preview manifest](https://volobox.io/docs/write-preview-manifest.md): Have a coding agent draft volobox.app.yaml or write it yourself, check it, start a branch preview, and add verify steps for agent pull requests.
- [Guide coding agents with repository files and guidance](https://volobox.io/docs/guide-coding-agents.md): Tell coding agents and the AI reviewer how your team works: AGENTS.md, REVIEW.md, workspace and project guidance, learned notes.
- [Run coding sessions on your own machine](https://volobox.io/docs/own-machine.md): Add a computer you own so your coding sessions run there, use your Claude subscription with Claude Code, and keep the runner up to date.

### Automation and apps

- [Write a code workflow](https://volobox.io/docs/write-code-workflow.md): Create a Code workflow (or convert a playbook), write a body that finds people and notifies them, rehearse it, then schedule or trigger it.
- [Build an app](https://volobox.io/docs/build-an-app.md): Start an app from a template or a description in the Builder, try the draft, set roles and access, review and publish, and export or import it.
- [Call other systems from an app](https://volobox.io/docs/call-external-systems.md): Have an app rule call a REST API with a secret an Admin binds, receive a signed webhook on an endpoint, and handle refusals on both sides.
- [Create a skill](https://volobox.io/docs/create-a-skill.md): Write a SKILL.md with optional reference files and scripts, import it, give it to an agent, and add a slash command that uses it.
- [Host a pack registry](https://volobox.io/docs/host-pack-registry.md): Package a library pack as a zip with pack.json, serve it from an HTTPS registry with an index.json, and connect the registry in another workspace.

### Administration

- [Connect GitHub](https://volobox.io/docs/connect-github.md): Create your organization's own GitHub App from Volobox, install it on your GitHub organizations and register the repositories projects will use.
- [Connect GitLab](https://volobox.io/docs/connect-gitlab.md): Connect a GitLab.com group to Volobox with a service account, let each person link their own GitLab account, and register the group's projects.
- [Connect Azure DevOps](https://volobox.io/docs/connect-azure-devops.md): Connect Azure DevOps Services through your own Microsoft Entra application, then use its repositories, pipelines and work items from Volobox projects.
- [Set up Microsoft Entra ID sign-in](https://volobox.io/docs/entra-id-sign-in.md): Let your organization's members sign in to Volobox with Microsoft Entra ID, through the Microsoft 365 connection or your own app registration.
- [Add a model provider](https://volobox.io/docs/add-model-provider.md): Connect OpenAI, Anthropic, OpenRouter, Azure OpenAI or another OpenAI-compatible endpoint with your own key, and choose which models agents use.

## Reference

The exact contract: endpoints, events, headers, file formats and commands.

### Start here

- [Reference](https://volobox.io/docs/reference.md): The exact technical contract of Volobox: the HTTP API, the MCP server, webhooks and events, and the formats of manifests, workflows, apps and skills.

### HTTP API

- [API overview](https://volobox.io/docs/api-overview.md): Base URL, versioning, authentication, action groups and the conventions every call to the Volobox public HTTP API follows.
- [Agenda API](https://volobox.io/docs/api-agenda.md): Endpoints for the caller's agenda: agenda items, recurring agenda items and the agenda requests people send each other.
- [Audit log API](https://volobox.io/docs/api-audit.md): Endpoints that list and export the organization's audit log, one page at a time.
- [Calendar API](https://volobox.io/docs/api-calendar.md): Endpoints for bookings, vacations and vacation requests, and the working calendar of work schedules and holidays.
- [Conversations API](https://volobox.io/docs/api-conversations.md): Endpoints for chats and item discussions: messages, participants, polls, message reminders and starred messages.
- [Docs API](https://volobox.io/docs/api-docs.md): Endpoints for Docs spaces and pages: members, the page tree, page content, revisions, Trash and search.
- [Files API](https://volobox.io/docs/api-files.md): Endpoints for Drive files and folders, shared drives and sharing, plus the caller's alerts, Inbox and notifications.
- [Meetings API](https://volobox.io/docs/api-meetings.md): Endpoints for meetings and their occurrences, notes and attendance, scheduled calls in chats, and groups.
- [People API](https://volobox.io/docs/api-people.md): Endpoints for the team directory, member profiles, people lookup, expertise tags and the caller's own profile and status.
- [Projects API](https://volobox.io/docs/api-projects.md): Endpoints for projects and their members, tasks, requests, areas, labels, milestones and work item types.
- [Support API](https://volobox.io/docs/api-support.md): Endpoints for the support tickets of the desks the caller works on, and their links to project requests and tasks.
- [Workspace API](https://volobox.io/docs/api-workspace.md): Endpoints for announcements, references to workspace items, and searching the knowledge the caller can read.

### MCP and events

- [MCP server](https://volobox.io/docs/mcp-server.md): The hosted Volobox MCP server: endpoint, transport, OAuth discovery and client registration, tool naming, catalog tools and curated tools.
- [Webhooks](https://volobox.io/docs/webhooks.md): What a Volobox webhook delivery contains: headers, body envelope, ping, signature, retry schedule and delivery semantics.
- [Event catalog](https://volobox.io/docs/events.md): Every event Volobox can deliver to a webhook, grouped by what it is about, with its scope and what it means.

### Formats

- [Preview manifest reference](https://volobox.io/docs/preview-manifest.md): Every key of volobox.app.yaml and volobox.workspace.yaml: steps, verify checks, services, preview settings and placeholders.
- [Code workflow API](https://volobox.io/docs/code-workflow-api.md): The globals a Code workflow body uses (inputs, tools, ai, wf, refs, log, utils), how a waiting body resumes, and what a body cannot use.
- [App files](https://volobox.io/docs/app-files.md): The files of a Volobox app: app.json keys, entities, roles and access, rules and their helpers, Volobox events, screens and the screen SDK.
- [Skill, command and pack formats](https://volobox.io/docs/skill-and-pack-formats.md): The SKILL.md format and skill bundles, slash command templates, the pack.json manifest of a library pack, and what a remote pack registry serves.
- [The volobox command in coding sandboxes](https://volobox.io/docs/sandbox-cli.md): The read-only volobox command a coding agent runs in its sandbox: docs, manifest checks, preview status and logs, and the Repository needed line.

### Glossary

- [Glossary](https://volobox.io/docs/glossary.md): Plain definitions of the words Volobox uses, from Workbench and approval cards to personal access tokens, webhooks and preview manifests.
