# E2B Docs

## Docs

- [E2B Documentation](https://e2b-squash-sandbox-pages.mintlify.app/docs.md)
- [Amp](https://e2b-squash-sandbox-pages.mintlify.app/docs/agents/amp.md): Run Amp in a secure E2B sandbox with full filesystem, terminal, and git access.
- [Claude Code](https://e2b-squash-sandbox-pages.mintlify.app/docs/agents/claude-code.md): Run Claude Code in a secure E2B sandbox with full filesystem, terminal, and git access.
- [Codex](https://e2b-squash-sandbox-pages.mintlify.app/docs/agents/codex.md): Run OpenAI Codex in a secure E2B sandbox with full filesystem, terminal, and git access.
- [Deploy OpenClaw](https://e2b-squash-sandbox-pages.mintlify.app/docs/agents/openclaw/openclaw-gateway.md): Start the OpenClaw gateway in an E2B sandbox and connect your browser.
- [OpenClaw Telegram](https://e2b-squash-sandbox-pages.mintlify.app/docs/agents/openclaw/openclaw-telegram.md): Connect OpenClaw to Telegram in an E2B sandbox, approve pairing, and chat through your bot.
- [OpenCode](https://e2b-squash-sandbox-pages.mintlify.app/docs/agents/opencode.md): Run OpenCode in a secure E2B sandbox with full filesystem, terminal, and git access.
- [API key](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-key.md)
- [Check the health of the service](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/envd/check-the-health-of-the-service.md)
- [Get the environment variables](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/envd/get-the-environment-variables.md)
- [Get the stats of the service](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/envd/get-the-stats-of-the-service.md)
- [Compose multiple files into a single file using zero-copy concatenation. Source files are deleted after successful composition.](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/filesystem/compose-multiple-files-into-a-single-file-using-zero-copy-concatenation-source-files-are-deleted-after-successful-composition.md)
- [CreateWatcher](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/filesystem/createwatcher.md): Non-streaming versions of WatchDir
- [Download a file](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/filesystem/download-a-file.md)
- [GetWatcherEvents](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/filesystem/getwatcherevents.md)
- [ListDir](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/filesystem/listdir.md)
- [MakeDir](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/filesystem/makedir.md)
- [Move](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/filesystem/move.md)
- [Remove](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/filesystem/remove.md)
- [RemoveWatcher](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/filesystem/removewatcher.md)
- [Stat](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/filesystem/stat.md)
- [Upload a file and ensure the parent directories exist. If the file exists, it will be overwritten.](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/filesystem/upload-a-file-and-ensure-the-parent-directories-exist-if-the-file-exists-it-will-be-overwritten.md)
- [WatchDir](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/filesystem/watchdir.md): Server-streaming RPC. Use the Connect protocol with streaming support.
- [CloseStdin](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/process/closestdin.md): Close stdin to signal EOF to the process.  Only works for non-PTY processes. For PTY, send Ctrl+D (0x04) instead.
- [Connect](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/process/connect.md): Server-streaming RPC. Use the Connect protocol with streaming support.
- [List](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/process/list.md)
- [SendInput](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/process/sendinput.md)
- [SendSignal](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/process/sendsignal.md)
- [Start](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/process/start.md): Server-streaming RPC. Use the Connect protocol with streaming support.
- [StreamInput](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/process/streaminput.md): Client-streaming RPC. Client input stream ensures ordering of messages. Use the Connect protocol with streaming support.
- [Update](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/process/update.md)
- [Connect to sandbox](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/sandboxes/connect-to-sandbox.md): Returns sandbox details. If the sandbox is paused, it will be resumed. TTL is only extended.
- [Create sandbox](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/sandboxes/create-sandbox.md): Create a sandbox from the template
- [Delete sandbox](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/sandboxes/delete-sandbox.md): Kill a sandbox
- [Get sandbox](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/sandboxes/get-sandbox.md): Get a sandbox by id
- [Get sandbox logs](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/sandboxes/get-sandbox-logs.md): Get sandbox logs. Use /v2/sandboxes/{sandboxID}/logs instead.
- [Get sandbox logs (v2)](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/sandboxes/get-sandbox-logs-v2.md): Get sandbox logs
- [Get sandbox metrics](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/sandboxes/get-sandbox-metrics.md): Get sandbox metrics
- [Get snapshots](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/sandboxes/get-snapshots.md): List all snapshots for the team
- [List sandbox metrics](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/sandboxes/list-sandbox-metrics.md): List metrics for given sandboxes
- [List sandboxes](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/sandboxes/list-sandboxes.md): List all running sandboxes
- [List sandboxes (v2)](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/sandboxes/list-sandboxes-v2.md): List all sandboxes
- [Pause sandbox](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/sandboxes/pause-sandbox.md): Pause the sandbox
- [Post sandboxes snapshots](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/sandboxes/post-sandboxes-snapshots.md): Create a persistent snapshot from the sandbox's current state. Snapshots can be used to create new sandboxes and persist beyond the original sandbox's lifetime.
- [Put sandboxes network](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/sandboxes/put-sandboxes-network.md): Update the network configuration for a running sandbox. Replaces the current egress rules with the provided configuration. Omitting both fields clears all egress rules.
- [Refresh sandbox](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/sandboxes/refresh-sandbox.md): Refresh the sandbox extending its time to live
- [Resume sandbox](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/sandboxes/resume-sandbox.md): Resume the sandbox
- [Set sandbox timeout](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/sandboxes/set-sandbox-timeout.md): Set the timeout for the sandbox. The sandbox will expire x seconds from the time of the request. Calling this method multiple times overwrites the TTL, each time using the current timestamp as the starting point to measure the timeout duration.
- [Assign tags](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/tags/assign-tags.md): Assign tag(s) to a template build
- [Delete tags](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/tags/delete-tags.md): Delete multiple tags from templates
- [List template tags](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/tags/list-template-tags.md): List all tags for a template
- [Get team metrics](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/teams/get-team-metrics.md): Get metrics for the team
- [Get team metrics max](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/teams/get-team-metrics-max.md): Get the maximum metrics for the team in the given interval
- [List teams](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/teams/list-teams.md): List all teams
- [Create template](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/templates/create-template.md): Create a new template
- [Create template (v2)](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/templates/create-template-v2.md): Create a new template
- [Create template (v3)](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/templates/create-template-v3.md): Create a new template
- [Delete template](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/templates/delete-template.md): Delete a template
- [Get build logs](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/templates/get-build-logs.md): Get template build logs
- [Get build status](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/templates/get-build-status.md): Get template build info
- [Get build upload link](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/templates/get-build-upload-link.md): Get an upload link for a tar file containing build layer files
- [Get template](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/templates/get-template.md): List all builds for a template
- [Get template by alias](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/templates/get-template-by-alias.md): Check if template with given alias exists
- [List templates](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/templates/list-templates.md): List all templates
- [Rebuild template](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/templates/rebuild-template.md): Rebuild an template
- [Start build](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/templates/start-build.md): Start the build
- [Start build (v2)](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/templates/start-build-v2.md): Start the build
- [Update template](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/templates/update-template.md): Update template
- [Update template (v2)](https://e2b-squash-sandbox-pages.mintlify.app/docs/api-reference/templates/update-template-v2.md): Update template
- [Billing & pricing](https://e2b-squash-sandbox-pages.mintlify.app/docs/billing.md)
- [BYOC (Bring Your Own Cloud)](https://e2b-squash-sandbox-pages.mintlify.app/docs/byoc.md)
- [Analyze data with AI](https://e2b-squash-sandbox-pages.mintlify.app/docs/code-interpreting/analyze-data-with-ai.md)
- [Pre-installed libraries](https://e2b-squash-sandbox-pages.mintlify.app/docs/code-interpreting/analyze-data-with-ai/pre-installed-libraries.md)
- [Code contexts](https://e2b-squash-sandbox-pages.mintlify.app/docs/code-interpreting/contexts.md)
- [Create charts & visualizations](https://e2b-squash-sandbox-pages.mintlify.app/docs/code-interpreting/create-charts-visualizations.md)
- [Interactive charts](https://e2b-squash-sandbox-pages.mintlify.app/docs/code-interpreting/create-charts-visualizations/interactive-charts.md)
- [Static charts](https://e2b-squash-sandbox-pages.mintlify.app/docs/code-interpreting/create-charts-visualizations/static-charts.md)
- [Streaming](https://e2b-squash-sandbox-pages.mintlify.app/docs/code-interpreting/streaming.md)
- [Supported languages](https://e2b-squash-sandbox-pages.mintlify.app/docs/code-interpreting/supported-languages.md)
- [Run bash code](https://e2b-squash-sandbox-pages.mintlify.app/docs/code-interpreting/supported-languages/bash.md)
- [Run Java code](https://e2b-squash-sandbox-pages.mintlify.app/docs/code-interpreting/supported-languages/java.md)
- [Run JavaScript and TypeScript code](https://e2b-squash-sandbox-pages.mintlify.app/docs/code-interpreting/supported-languages/javascript.md)
- [Run Python code](https://e2b-squash-sandbox-pages.mintlify.app/docs/code-interpreting/supported-languages/python.md)
- [Run R code](https://e2b-squash-sandbox-pages.mintlify.app/docs/code-interpreting/supported-languages/r.md)
- [Cookbook](https://e2b-squash-sandbox-pages.mintlify.app/docs/cookbook.md)
- [SDK v2 migration guide](https://e2b-squash-sandbox-pages.mintlify.app/docs/migration/v2.md)
- [Running your first Sandbox](https://e2b-squash-sandbox-pages.mintlify.app/docs/quickstart.md): This guide will show you how to start your first E2B Sandbox.
- [Connect LLMs to E2B](https://e2b-squash-sandbox-pages.mintlify.app/docs/quickstart/connect-llms.md)
- [Install custom packages](https://e2b-squash-sandbox-pages.mintlify.app/docs/quickstart/install-custom-packages.md)
- [Upload & downloads files](https://e2b-squash-sandbox-pages.mintlify.app/docs/quickstart/upload-download-files.md)
- [Sandbox](https://e2b-squash-sandbox-pages.mintlify.app/docs/sandbox.md): E2B sandboxes are persistent, secure cloud environments for AI agents — with pause/resume, snapshots, and auto-resume built in.
- [CLI](https://e2b-squash-sandbox-pages.mintlify.app/docs/sandbox/cli.md): Use the E2B CLI to create, connect, manage, and debug sandboxes from your terminal.
- [Commands & terminal](https://e2b-squash-sandbox-pages.mintlify.app/docs/sandbox/commands.md): Run commands, use interactive terminals, and connect via SSH in E2B sandboxes.
- [Connect storage bucket](https://e2b-squash-sandbox-pages.mintlify.app/docs/sandbox/connect-bucket.md): Mount Google Cloud Storage, Amazon S3, or Cloudflare R2 buckets inside E2B sandboxes using FUSE.
- [Custom domain](https://e2b-squash-sandbox-pages.mintlify.app/docs/sandbox/custom-domain.md): Set up a custom domain to proxy requests to E2B sandboxes using Caddy and Cloudflare DNS.
- [Environment variables](https://e2b-squash-sandbox-pages.mintlify.app/docs/sandbox/environment-variables.md): Set and use environment variables in E2B sandboxes — default metadata, global variables, and per-command overrides.
- [Filesystem](https://e2b-squash-sandbox-pages.mintlify.app/docs/sandbox/filesystem.md): Read, write, upload, and download files in E2B sandboxes. Each sandbox has an isolated filesystem with up to 20 GB of storage.
- [Git integration](https://e2b-squash-sandbox-pages.mintlify.app/docs/sandbox/git-integration.md): Clone repositories, manage branches, and push changes using the sandbox.git methods.
- [Managing sandboxes](https://e2b-squash-sandbox-pages.mintlify.app/docs/sandbox/lifecycle.md): Manage E2B sandboxes — timeouts, metadata, listing, filtering, connecting, and shutdown. Sandboxes are persistent cloud environments for AI agents.
- [MCP gateway](https://e2b-squash-sandbox-pages.mintlify.app/docs/sandbox/mcp.md): Connect E2B sandboxes to 200+ MCP tools — Browserbase, Exa, Notion, Stripe, GitHub, and more — through a built-in MCP gateway.
- [Available servers](https://e2b-squash-sandbox-pages.mintlify.app/docs/sandbox/mcp/available-servers.md): Browse available MCP servers
- [Observability](https://e2b-squash-sandbox-pages.mintlify.app/docs/sandbox/observability.md): Monitor E2B sandboxes with resource metrics, lifecycle event history, and real-time webhooks.
- [Pause, resume & snapshots](https://e2b-squash-sandbox-pages.mintlify.app/docs/sandbox/persistence.md): E2B sandboxes are persistent — pause and resume preserves filesystem and memory state. Use snapshots to checkpoint and fork sandbox state.
- [Proxy tunneling](https://e2b-squash-sandbox-pages.mintlify.app/docs/sandbox/proxy-tunneling.md): How to tunnel Sandbox network traffic through a proxy server
- [Customizing sandboxes](https://e2b-squash-sandbox-pages.mintlify.app/docs/sandbox/runtime-customization.md): Install packages, upload files, and configure E2B sandboxes dynamically when you can't bake everything into a template.
- [Security](https://e2b-squash-sandbox-pages.mintlify.app/docs/sandbox/security.md): Learn about E2B sandbox security including authenticated access, network controls, and rate limits.
- [Volumes](https://e2b-squash-sandbox-pages.mintlify.app/docs/sandbox/volumes.md): Persistent storage volumes for E2B sandboxes — create, mount, read, write, and manage files that persist across sandbox sessions.
- [Errors](https://e2b-squash-sandbox-pages.mintlify.app/docs/sdk-reference/js-sdk/v2.14.1/errors.md)
- [Sandbox](https://e2b-squash-sandbox-pages.mintlify.app/docs/sdk-reference/js-sdk/v2.14.1/sandbox.md)
- [Sandbox commands](https://e2b-squash-sandbox-pages.mintlify.app/docs/sdk-reference/js-sdk/v2.14.1/sandbox-commands.md)
- [Sandbox filesystem](https://e2b-squash-sandbox-pages.mintlify.app/docs/sdk-reference/js-sdk/v2.14.1/sandbox-filesystem.md)
- [Template](https://e2b-squash-sandbox-pages.mintlify.app/docs/sdk-reference/js-sdk/v2.14.1/template.md)
- [Template logger](https://e2b-squash-sandbox-pages.mintlify.app/docs/sdk-reference/js-sdk/v2.14.1/template-logger.md)
- [Template readycmd](https://e2b-squash-sandbox-pages.mintlify.app/docs/sdk-reference/js-sdk/v2.14.1/template-readycmd.md)
- [Exceptions](https://e2b-squash-sandbox-pages.mintlify.app/docs/sdk-reference/python-sdk/v2.14.1/exceptions.md)
- [Logger](https://e2b-squash-sandbox-pages.mintlify.app/docs/sdk-reference/python-sdk/v2.14.1/logger.md)
- [Readycmd](https://e2b-squash-sandbox-pages.mintlify.app/docs/sdk-reference/python-sdk/v2.14.1/readycmd.md)
- [Sandbox async](https://e2b-squash-sandbox-pages.mintlify.app/docs/sdk-reference/python-sdk/v2.14.1/sandbox_async.md)
- [Sandbox sync](https://e2b-squash-sandbox-pages.mintlify.app/docs/sdk-reference/python-sdk/v2.14.1/sandbox_sync.md)
- [Template](https://e2b-squash-sandbox-pages.mintlify.app/docs/sdk-reference/python-sdk/v2.14.1/template.md)
- [Template async](https://e2b-squash-sandbox-pages.mintlify.app/docs/sdk-reference/python-sdk/v2.14.1/template_async.md)
- [Template sync](https://e2b-squash-sandbox-pages.mintlify.app/docs/sdk-reference/python-sdk/v2.14.1/template_sync.md)
- [Need help?](https://e2b-squash-sandbox-pages.mintlify.app/docs/support.md)
- [Base image](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/base-image.md): How to define a base image for your template
- [Build](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/build.md): How to build the template
- [Caching](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/caching.md): How the caching process works
- [Defining template](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/defining-template.md): How to create your own template
- [Error handling](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/error-handling.md): Handle errors in your template
- [Claude Code](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/examples/claude-code.md): Claude Code Agent available in a sandbox
- [Desktop](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/examples/desktop.md): Sandbox with Ubuntu Desktop and VNC access
- [Docker](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/examples/docker.md): Sandbox with Docker installed for running containers
- [Expo app](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/examples/expo.md): Expo web app running in the sandbox using Node.js
- [Next.js app](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/examples/nextjs.md): Next.js web app running in the sandbox using Node.js
- [Next.js app (Bun)](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/examples/nextjs-bun.md): Next.js web app running in the sandbox using Bun
- [How it works](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/how-it-works.md): How the template building process works
- [Logging](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/logging.md): How to view logs from the template build
- [V2 migration guide](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/migration-v2.md): How to migrate from the legacy template definition
- [Template names](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/names.md): Understanding and managing template names
- [Private registries](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/private-registries.md): Access private registries as the base image
- [Quickstart](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/quickstart.md): Start with custom sandbox templates
- [Start & ready commands](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/start-ready-command.md): Define running processes for the sandbox
- [Template tags & versioning](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/tags.md): Use tags to version your templates and manage environment-based deployments
- [User and workdir](https://e2b-squash-sandbox-pages.mintlify.app/docs/template/user-and-workdir.md): Default user and working directory in the sandbox and template
- [pip install fails during template build](https://e2b-squash-sandbox-pages.mintlify.app/docs/troubleshooting/pip-install-error.md)
- [The sandbox is running but port is not open - 49999](https://e2b-squash-sandbox-pages.mintlify.app/docs/troubleshooting/templates/49999-port-not-open.md)
- [Docker push authentication error](https://e2b-squash-sandbox-pages.mintlify.app/docs/troubleshooting/templates/build-authentication-error.md)
- [GitHub Actions CI/CD](https://e2b-squash-sandbox-pages.mintlify.app/docs/use-cases/ci-cd.md): Run AI-powered code review, testing, and validation in secure E2B sandboxes from your GitHub Actions workflows.
- [Coding Agents](https://e2b-squash-sandbox-pages.mintlify.app/docs/use-cases/coding-agents.md): Run AI coding agents like Claude Code, Codex, and Amp in secure E2B sandboxes with full terminal, filesystem, and git access.
- [Computer use](https://e2b-squash-sandbox-pages.mintlify.app/docs/use-cases/computer-use.md): Build AI agents that see, understand, and control virtual Linux desktops using E2B Desktop sandboxes.

## OpenAPI Specs

- [openapi-public](https://e2b-squash-sandbox-pages.mintlify.app/openapi-public.yml)