Skip to main content
The Hopx Python SDK provides a simple, intuitive API for creating and managing sandboxes. This reference covers all classes, methods, and types available in the SDK.

Installation

pip install hopx-ai

Quick Start

from hopx_ai import Sandbox

# Create sandbox
sandbox = Sandbox.create(template="code-interpreter")

# Execute code
result = sandbox.run_code("print('Hello, World!')")
print(result.stdout)

# Cleanup
sandbox.kill()

Main Classes

Resources

Models and Types

SandboxInfo

Sandbox information and properties

ExecutionResult

Code execution results with rich outputs

CommandResult

Command execution results

FileInfo

File and directory information

Error Handling


SDK Structure

hopx_ai/
├── Sandbox              # Main sync class
├── AsyncSandbox         # Async version
├── Template             # Template builder class
├── models/              # Data models
│   ├── SandboxInfo
│   ├── ExecutionResult
│   ├── CommandResult
│   └── FileInfo
├── template/            # Template building
│   ├── builder          # Template class
│   ├── types            # BuildOptions, BuildResult, etc.
│   └── build_flow       # Build execution
├── errors/              # Exception classes
│   ├── HopxError
│   ├── APIError
│   ├── AuthenticationError
│   └── ...
└── resources/           # Resource classes
    ├── Files
    ├── Commands
    ├── Desktop
    └── EnvironmentVariables

Next Steps