Skip to main content

Installation

Quick Start

Core Features

Lifecycle Management

Manage the complete sandbox lifecycle with renewal, pausing, and resuming capabilities.

Custom Health Check

Define custom logic to determine if the sandbox is healthy. This overrides the default ping check.

Command Execution & Streaming

Execute commands and handle output streams in real-time.

File Operations

Comprehensive file and directory management including read, write, search, and delete.

Sandbox Management (Admin)

Use SandboxManager for administrative tasks and finding existing sandboxes.

Configuration

Connection Configuration

The ConnectionConfig class manages API server connection settings.

Sandbox Creation Configuration

The Sandbox.create() method allows configuring the sandbox environment.

API Reference

Sandbox

Main class for interacting with sandboxes.

Methods

classmethod
Creates and initializes a new sandbox instance.Parameters:
  • image (str): Docker image to use
  • connection_config (ConnectionConfig): Connection configuration
  • timeout (timedelta, optional): Sandbox lifetime
  • entrypoint (List[str], optional): Custom entrypoint
  • resource (Dict[str, str], optional): CPU/memory limits
  • env (Dict[str, str], optional): Environment variables
  • metadata (Dict[str, str], optional): Custom metadata
  • network_policy (NetworkPolicy, optional): Network egress rules
  • health_check (Callable, optional): Custom health check function
  • ready_timeout (timedelta, optional): Readiness timeout
Returns: Sandbox instance
classmethod
Resumes a paused sandbox.Parameters:
  • sandbox_id (str): ID of the paused sandbox
  • connection_config (ConnectionConfig): Connection configuration
Returns: Sandbox instance
property
Access to command execution operations.Returns: CommandsClient
property
Access to file system operations.Returns: FilesClient
async method
Extends the sandbox expiration time.Parameters:
  • duration (timedelta): Extension duration
async method
Pauses the sandbox (suspends all processes).
async method
Terminates the sandbox immediately.
async method
Retrieves current sandbox information.Returns: SandboxInfo
async method
Gets the external endpoint for a port.Parameters:
  • port (int): Internal port number
Returns: SandboxEndpoint

Examples

Running a Python Script

Network Policy Example

Port Forwarding

Error Handling

Next Steps

Code Interpreter

Execute Python, Java, Go code with state persistence

API Reference

Explore detailed API documentation

Examples

Browse more code examples

Configuration

Advanced configuration options