The cloud sandbox of veFaaS is compatible with the E2B protocol at the API layer, and supports dynamically injecting the Envd runtime into any sandbox image. This allows business applications to directly use the official E2B SDK without image modification. This topic describes the compatibility scope of the veFaaS cloud sandbox with the E2B official SDK.

Background information

E2B is a code execution sandbox protocol designed for AI Agents and LLM applications. It provides an isolated cloud runtime environment that allows Agents to safely execute code, run terminal commands, read and write files, and access container ports. The goal of E2B is to standardize code execution environments, preventing developers from designing a set of container scheduling, isolation, and lifecycle management logic for each Agent scenario.

Integration method

For the method of integrating E2B applications with the veFaaS cloud sandbox, see Integrating sandbox applications with the E2B protocol.

Compatibility overview

Feature module	Description
Sandbox	Sandbox instance lifecycle management. It supports connection, suspending and resuming, termination, timeout configuration, and access address retrieval.
Commands	Process and command management. It provides features, such as command execution, process management, terminal connection, input, and process termination.
Filesystem	File system management. It provides features, such as file read/write, directory management, and file information retrieval.
Code Interpreter	Code interpreter management. It provides features, such as code execution, context creation, and status persistence.
Template	Template management. It providing featues such as template retrival, list, update, deletion, and tag management.
Volume	Storage volume management. It supports volume creation, connection, destruction, listing, and information retrieval.

Compatible API details

Sandbox

SDK method	Description
sandbox.connect()	Connects to an existing sandbox instance. If it is paused, it will automatically resume.
Sandbox.list()	Lists sandbox instances.
sandbox.getInfo()	Obtains the details of a sandbox instance.
sandbox.kill()	Terminates a sandbox instance.
sandbox.setTimeout()	Sets or refreshes the maximum lifetime of a sandbox instance.
sandbox.isRunning()	Checks whether a sandbox instance is running.
sandbox.pause()	Suspends a sandbox instance.
Sandbox.connect(sandboxId)	Connects to an existing sandbox instance. If it is paused, it will automatically resume.
Sandbox.setTimeout(sandboxId, ms)	Refreshes the maximum lifetime of a sandbox instance by its ID.
sandbox.getHost(port)	Obtains the external access address of a sandbox instance for a given port.
sandbox.downloadUrl(path)	Obtains a pre-signed download URL for a file in a sandbox instance via the file path.
sandbox.uploadUrl(path)	Obtains a pre-signed upload URL for a file in a sandbox instance via the file path.

Commands

SDK method	Description
sandbox.commands.run()	Runs a command.
sandbox.commands.list()	Lists running processes.
sandbox.commands.connect()	Connects to an existing process.
sandbox.commands.sendStdin()	Sends input. For example, enter text in the terminal.
sandbox.commands.kill()	Terminates a process.
sandbox.pty.create()	Creates a Pseudo Terminal (PTY).
sandbox.pty.connect()	Connects to an existing PTY session.
sandbox.pty.sendInput()	Sends input to a PTY.
sandbox.pty.resize()	Resizes the PTY window.
sandbox.pty.kill()	Terminates a PTY.
sandbox.commands.closeStdin()	Closes the input channel for a command.

Filesystem

SDK method	Description
sandbox.files.read()	Reads a file.
sandbox.files.write()	Writes a file.
sandbox.files.list()	Lists the contents of a directory.
sandbox.files.exists()	Determines whether a file exists.
sandbox.files.makeDir()	Creates a directory.
sandbox.files.remove()	Deletes a file.
sandbox.files.rename()	Renames a file.
sandbox.files.watchDir()	Listens for file changes within a directory in a sandbox instance.
sandbox.files.getInfo()	Obtains file information.
sandbox.files.writeFiles()	Writes multiple files simultaneously.

Code Interpreter

SDK method	Description
sandbox.runCode()	Runs code.
sandbox.createContext()	Creates an execution context.

Template

SDK method	Description
Template.assignTags()	Assigns tags to a template.
Template.getTags()	Queries tags of a template.
Template.removeTags()	Removes tags from a template.

Volume

SDK method	Description
Volume.create()	Creates a storage volume.
Volume.connect()	Connects to an existing storage volume.
Volume.destroy()	Destroys a storage volume.
Volume.list()	Lists all storage volumes in the team.
Volume.getInfo()	Obtains storage volume information.

Volcano Engine Function as a Service