OpenSandbox ships first-party client libraries for five languages, each covering the full surface of the sandbox API: lifecycle management, shell command execution, file operations, egress policy control, and code interpretation. Every SDK follows the same four-step workflow — configure a connection, create a sandbox, perform operations, then clean up — so patterns learned in one language translate directly to another.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/opensandbox-group/OpenSandbox/llms.txt
Use this file to discover all available pages before exploring further.
Sandbox SDKs
The core libraries for creating and managing sandboxes.| Language | Package | Install |
|---|---|---|
| Python | opensandbox | pip install opensandbox |
| JavaScript/TypeScript | @alibaba-group/opensandbox | npm install @alibaba-group/opensandbox |
| Kotlin/Java | com.alibaba.opensandbox:sandbox | Gradle / Maven |
| Go | github.com/alibaba/OpenSandbox/sdks/sandbox/go | go get |
| C#/.NET | Alibaba.OpenSandbox | dotnet add package |
Code Interpreter SDKs
Higher-level libraries for multi-language code execution inside sandboxes. Built on top of the sandbox SDKs, they add execution contexts and state persistence across runs.| Language | Package | Install |
|---|---|---|
| Python | opensandbox-code-interpreter | pip install opensandbox-code-interpreter |
| JavaScript/TypeScript | @alibaba-group/opensandbox-code-interpreter | npm install @alibaba-group/opensandbox-code-interpreter |
| Kotlin/Java | com.alibaba.opensandbox:code-interpreter | Gradle / Maven |
| C#/.NET | Alibaba.OpenSandbox.CodeInterpreter | dotnet add package |
MCP Server
The MCP server exposes sandbox operations to MCP-capable clients such as Claude Code and Cursor.Common Patterns
All SDKs share four standard patterns regardless of language.Connection config
Supply the server domain, API key, and optional transport settings. Most SDKs read
OPEN_SANDBOX_API_KEY and OPEN_SANDBOX_DOMAIN from the environment automatically.Sandbox creation
Specify a container image, optional entrypoint, resource limits, environment variables, TTL, and network policy. The SDK blocks until the sandbox reports ready or
ready_timeout elapses.Operations
Execute shell commands (with optional real-time streaming), read and write files, resolve port endpoints, inspect or patch egress rules, and inject credentials via Credential Vault.
Choose Your SDK
Python
Async and sync APIs,
SandboxPoolSync, SandboxPoolAsync, and optional Redis-backed pool state for distributed deployments.JavaScript / TypeScript
Typed async API with
undici keep-alive pools per instance, volume mounts, and full browser compatibility.Kotlin / Java
Builder-style API with OkHttp connection pooling,
SandboxPool, and an optional sandbox-pool-redis module.Go
Three focused clients —
LifecycleClient, ExecdClient, and EgressClient — with idiomatic SSE streaming callbacks.C# / .NET
IAsyncDisposable sandbox and manager types, Microsoft.Extensions.Logging integration, and support from .NET Standard 2.0 through .NET 10.