Skip to main content

Installation

Install the Sandbox SDK using your preferred package manager:

Authentication

Set your API key as an environment variable:
Or pass it directly when initializing the client:

Basic Usage

Create a Sandbox

Create a new sandbox with a Docker image:
With custom timeout (defaults to 10 minutes):

Execute Commands

Execute commands using string syntax (shell execution):
Commands support shell features like pipes, variables, and globs:

Get Sandbox Info

Fetch current sandbox state:

List Sandboxes

List all sandboxes in your organization:

Refresh State

Refresh sandbox data from the server:

Delete Sandbox

Clean up when you’re done:

Complete Example

Key Concepts

Timeouts

Sandboxes auto-stop after 10 minutes by default. Extend the timeout:
See Sandbox Management for details.

Files

Read and write files (text and binary, up to 10 MB):
See File Operations for binary examples and patterns.

Background Processes

Run servers without blocking:
See Command Execution for process management.

Exposing Services

Your server must bind to IPv6 (::):
See Networking for framework examples.

Next Steps

Sandbox Management

Manage lifecycle, timeouts, and state

File Operations

Read and write text and binary files

Command Execution

Run commands and background processes

Networking

Expose services via public URLs

Pricing

Understand billing and costs

Troubleshooting

Common issues and solutions