Guides
Create your first Sandbox
Learn how to create your first sandbox using the AVM Sandbox Platform API
Using the TypeScript SDK
The easiest way to create a sandbox is using our official TypeScript SDK:
Customizing Resources
You can customize the CPU and memory allocation:
Using a Custom Docker Image
By default, sandboxes use avmcodes/avm-default-sandbox. You can specify a different image:
Attaching Volumes
You can attach persistent volumes to your sandbox:
Setting Environment Variables
Pass environment variables to your sandbox:
Response Structure
The create() method returns a SandboxCreateResponse object:
Parameters
A descriptive name for your sandbox
Docker image name to use for the sandbox
Environment variables to set in the sandbox (key-value pairs)
Next Steps
Once your sandbox is created, you can:
- Execute commands in your sandbox
- List all sandboxes in your account
- Check the API Reference for file upload and download operations