Skip to main content
POST
Create a sandbox

Authorizations

Authorization
string
header
required

API key

Query Parameters

wait
boolean
default:false

Hold the request for a completed start or exec result

Body

application/json
name
string

Sandbox name, unique within the account. A random word-list name is generated when omitted.

Required string length: 1 - 63
Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
vcpu_count
integer
default:1
Required range: 1 <= x <= 32
mem_size_mib
integer
default:2048
Required range: 256 <= x <= 65536
base_image
string
default:ubuntu:26.04

Public Linux OCI image reference. Docker shorthand and tags are accepted.

env
object

Environment variables applied to every exec

max_ttl_seconds
integer
default:28800

Lifetime budget for each powered-on session. Activity does not extend the deadline; starting or resuming the sandbox begins a fresh session.

Required range: 60 <= x <= 28800
max_concurrent_execs
integer
default:32
Required range: 1 <= x <= 256

Response

The sandbox was created

success
boolean
required
Example:

true

data
object
required