E2B compatibility

Sandbox

The Snapshot feature is available only on the MicroVM runtime and only to accounts that have been granted allowlist access. Obtain allowlist access before you call Snapshot-related APIs.

The following sandbox lifecycle and access capabilities are supported:

• Sandbox.create()

• Sandbox.connect(sandboxId)

• Sandbox.list()

• Sandbox.getInfo(sandboxId)

• Sandbox.kill(sandboxId)

• Sandbox.setTimeout(sandboxId, ms)

• sandbox.getInfo()

• sandbox.isRunning()

• sandbox.setTimeout(ms)

• sandbox.pause()

• sandbox.kill()

• sandbox.downloadUrl(path)

• sandbox.uploadUrl(path)

• sandbox.getHost(port)

• sandbox.createSnapshot({ name? }) / Sandbox.createSnapshot(sandboxId, { name? })

• Sandbox.listSnapshots({ sandboxId?, name?, limit?, nextToken? })

• Sandbox.deleteSnapshot(snapshotId | qualifiedName)

• Python: sandbox.create_snapshot(name=...) / Sandbox.create_snapshot(sandbox_id, name=...), Sandbox.list_snapshots(...), and Sandbox.delete_snapshot(snapshot_id | qualified_name)

Sandbox.connect(sandboxId) can connect to an existing sandbox. If the target sandbox is paused, connecting automatically resumes it.

Sandbox.create() accepts a snapshot ID or the qualified name of a named snapshot as its template parameter, in addition to a template name or template ID. For snapshot usage limits and naming rules, see Snapshot (Preview).

Commands

The following command execution and process management capabilities are supported:

• sandbox.commands.run()

• sandbox.commands.list()

• sandbox.commands.connect()

• sandbox.commands.sendStdin()

• sandbox.commands.kill()

Interactive terminals and tasks that depend on a teletypewriter (TTY) use the sandbox.pty API.

Filesystem

The following filesystem capabilities are supported:

• sandbox.files.list()

• sandbox.files.exists()

• sandbox.files.getInfo() / sandbox.files.get_info()

• sandbox.files.read()

• sandbox.files.write()

• sandbox.files.makeDir() / sandbox.files.make_dir()

• sandbox.files.remove()

• sandbox.files.rename()

• sandbox.files.watchDir() / sandbox.files.watch_dir()

sandbox.files.write() supports text, binary, and streaming content. Directory watching is useful for waiting for agent output files or syncing task artifacts.

Agent Sandbox Flash Edition supports custom file metadata only on the MicroVM runtime. For example, in Python SDK e2b==2.31.0, the method signature accepts the metadata parameter, but the sandbox envd version must be 0.6.2 or later. If the envd version is earlier than 0.6.2, the SDK raises TemplateException: File metadata requires envd 0.6.2 or later before it sends the write request.

Code Interpreter

The core Code Interpreter capabilities are supported:

• sandbox.runCode() / sandbox.run_code()

• sandbox.createCodeContext() / sandbox.create_code_context()

• sandbox.listCodeContexts() / sandbox.list_code_contexts()

• sandbox.restartCodeContext() / sandbox.restart_code_context()

• sandbox.removeCodeContext() / sandbox.remove_code_context()

• Execution outputs, including stdout, stderr, execution count, the results of bare expressions, and rich results from the execution.results field.

• stdout, stderr, and result callbacks when output is streamed.

• Variable and context state persistence across multiple code executions.

• Python, JavaScript, TypeScript, and Bash execution through the language parameter.

Charts and visualizations currently support only the file-based fallback: generate image files inside the sandbox, then retrieve them through Filesystem or download URLs.

Template

Create, read, update, and delete (CRUD) operations on templates are supported. Template building currently supports creating templates from images. For details, see Build and manage templates.

CLI

Agent Sandbox Flash Edition is compatible with the commonly used E2B CLI sandbox commands, and extends some template management commands:

New E2B CLI versions authenticate with E2B_API_KEY. For configuration details, see Use Agent Sandbox Flash Edition with the CLI.

Metrics

E2B metrics are supported, and the console provides observability. The Metrics API is not currently supported.