# Modbox | Documentation

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.modbox.run/_mcp/server

## Docs

- [Welcome to Modbox](https://docs.modbox.run/welcome.md): On-demand cloud sandboxes for AI agents, code execution and browser automation
- [Quickstart](https://docs.modbox.run/quickstart.md): Provision your first sandbox in under 2 minutes
- [Authentication](https://docs.modbox.run/authentication.md): How to authenticate with the Modbox API
- [SDKs](https://docs.modbox.run/sdks.md): Official client libraries for TypeScript and Python
- [Errors](https://docs.modbox.run/errors.md): One envelope, stable codes, and a hint telling you what to do next
- [Changelog](https://docs.modbox.run/home/changelog/changelog.md): New features, improvements, and fixes to the Modbox API and platform
- [Changelog (all entries)](https://docs.modbox.run/home/changelog/changelog/llms.txt)
- [AI Coding Agents](https://docs.modbox.run/guides/ai-coding-agents.md): Give every AI agent its own isolated environment to write and run code safely
- [Browser Automation](https://docs.modbox.run/guides/browser-automation.md): Provision Chromium sandboxes for web scraping, testing, and AI browser agents
- [Code Execution](https://docs.modbox.run/guides/code-execution.md): Safe, multi-language code execution in isolated containers
- [Dev Environments](https://docs.modbox.run/guides/dev-environments.md): On-demand, ephemeral development environments for every branch and PR
- [Sandboxes](https://docs.modbox.run/guides/sandboxes.md): Understanding the sandbox lifecycle and available operations
- [The modbox/sandbox Image](https://docs.modbox.run/guides/modbox-sandbox.md): Full desktop sandbox with Chromium, VNC, terminal and REST API
- [Images](https://docs.modbox.run/guides/images.md): Manage the Docker images used to provision sandboxes
- [Workspaces](https://docs.modbox.run/guides/workspaces.md): Organize your team, sandboxes, and images with workspaces and RBAC
- [Registries](https://docs.modbox.run/guides/registries.md): Connect private Docker registries to pull private images
- [TTL & Lifecycle](https://docs.modbox.run/guides/ttl.md): Automatically clean up sandboxes to avoid resource leaks
- [API Overview](https://docs.modbox.run/api-reference.md): REST API reference for the Modbox Sandbox Manager

## API Docs

- Modbox API > workspaces [List your workspaces](https://docs.modbox.run/api-reference/modbox-api/workspaces/list-workspaces.md)
- Modbox API > workspaces [Create a workspace](https://docs.modbox.run/api-reference/modbox-api/workspaces/create-workspace.md)
- Modbox API > workspaces [Get a workspace](https://docs.modbox.run/api-reference/modbox-api/workspaces/get-workspace.md)
- Modbox API > workspaces [Update a workspace](https://docs.modbox.run/api-reference/modbox-api/workspaces/update-workspace.md)
- Modbox API > workspaces [Delete a workspace](https://docs.modbox.run/api-reference/modbox-api/workspaces/delete-workspace.md)
- Modbox API > workspaces [List workspace members](https://docs.modbox.run/api-reference/modbox-api/workspaces/list-workspace-members.md)
- Modbox API > workspaces [Add a workspace member](https://docs.modbox.run/api-reference/modbox-api/workspaces/add-workspace-member.md)
- Modbox API > workspaces [Change a member's role](https://docs.modbox.run/api-reference/modbox-api/workspaces/update-workspace-member-role.md)
- Modbox API > workspaces [Remove a workspace member](https://docs.modbox.run/api-reference/modbox-api/workspaces/remove-workspace-member.md)
- Modbox API > system [Liveness probe](https://docs.modbox.run/api-reference/modbox-api/system/health-check.md)
- Modbox API > sandboxes [Provision a sandbox](https://docs.modbox.run/api-reference/modbox-api/sandboxes/provision-sandbox.md)
- Modbox API > sandboxes [Destroy a sandbox](https://docs.modbox.run/api-reference/modbox-api/sandboxes/destroy-sandbox.md)
- Modbox API > sandboxes [Check whether a sandbox is ready](https://docs.modbox.run/api-reference/modbox-api/sandboxes/get-sandbox-status.md)
- Modbox API > sandboxes [Block until a sandbox is ready](https://docs.modbox.run/api-reference/modbox-api/sandboxes/wait-for-sandbox.md)
- Modbox API > sandboxes [Get a sandbox](https://docs.modbox.run/api-reference/modbox-api/sandboxes/get-sandbox.md)
- Modbox API > sandboxes [List your sandboxes](https://docs.modbox.run/api-reference/modbox-api/sandboxes/list-sandboxes.md)
- Modbox API > sandboxes [List every sandbox in a realm (admin)](https://docs.modbox.run/api-reference/modbox-api/sandboxes/list-realm-sandboxes.md)
- Modbox API > observability [Read sandbox logs and metrics](https://docs.modbox.run/api-reference/modbox-api/observability/get-sandbox-monitoring.md)
- Modbox API > images [List sandbox images](https://docs.modbox.run/api-reference/modbox-api/images/list-sandbox-images.md)
- Modbox API > images [Register a sandbox image](https://docs.modbox.run/api-reference/modbox-api/images/create-sandbox-image.md)
- Modbox API > images [Get a sandbox image](https://docs.modbox.run/api-reference/modbox-api/images/get-sandbox-image.md)
- Modbox API > images [Update a sandbox image](https://docs.modbox.run/api-reference/modbox-api/images/update-sandbox-image.md)
- Modbox API > images [Delete a sandbox image](https://docs.modbox.run/api-reference/modbox-api/images/delete-sandbox-image.md)
- Modbox API > registries [List registry credentials](https://docs.modbox.run/api-reference/modbox-api/registries/list-registries.md)
- Modbox API > registries [Create a registry credential](https://docs.modbox.run/api-reference/modbox-api/registries/create-registry.md)
- Modbox API > registries [Get a registry credential](https://docs.modbox.run/api-reference/modbox-api/registries/get-registry.md)
- Modbox API > registries [Update a registry credential](https://docs.modbox.run/api-reference/modbox-api/registries/update-registry.md)
- Modbox API > registries [Delete a registry credential](https://docs.modbox.run/api-reference/modbox-api/registries/delete-registry.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.modbox.run/openapi.json)
- [OpenAPI YAML](https://docs.modbox.run/openapi.yaml)