Skip to main content
POST
/
api
/
v1
/
sandbox
Create Sandbox Endpoint
curl --request POST \
  --url https://api.primeintellect.ai/api/v1/sandbox \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "docker_image": "<string>",
  "start_command": "<string>",
  "cpu_cores": 1,
  "memory_gb": 2,
  "disk_size_gb": 10,
  "gpu_count": 0,
  "gpu_type": "CPU_NODE",
  "vm": false,
  "network_access": true,
  "timeout_minutes": 60,
  "environment_vars": {},
  "secrets": {},
  "labels": [
    "<string>"
  ],
  "team_id": "<string>",
  "advanced_configs": {},
  "registry_credentials_id": "<string>",
  "region": "<string>",
  "guaranteed": false
}
'
{
  "id": "<string>",
  "name": "<string>",
  "dockerImage": "<string>",
  "startCommand": "<string>",
  "cpuCores": 123,
  "memoryGB": 123,
  "diskSizeGB": 123,
  "diskMountPath": "<string>",
  "gpuCount": 123,
  "networkAccess": true,
  "status": "PENDING",
  "timeoutMinutes": 123,
  "environmentVars": {},
  "advancedConfigs": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "terminatedAt": "2023-11-07T05:31:56Z",
  "userId": "<string>",
  "teamId": "<string>",
  "kubernetesJobId": "<string>",
  "gpuType": "CPU_NODE",
  "vm": false,
  "labels": [
    "<string>"
  ],
  "exitCode": 123,
  "errorType": "<string>",
  "errorMessage": "<string>",
  "region": "us",
  "registryCredentialsId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.primeintellect.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Rate Limit

500 requests per 60 seconds per IP and token.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

Sandbox name

Required string length: 1 - 100
​
docker_image
string
required

Docker image to run

Minimum string length: 1
​
start_command
string | null

Command to run in container

​
cpu_cores
number
default:1

CPU cores required

Required range: 0.1 <= x <= 16
​
memory_gb
number
default:2

Memory in GB

Required range: 0.1 <= x <= 64
​
disk_size_gb
number
default:10

Disk size in GB

Required range: 0.1 <= x <= 1000
​
gpu_count
integer
default:0

Number of GPUs

Required range: 0 <= x <= 8
​
gpu_type
enum<string> | null

GPU type (e.g. H100, A100). Required when gpu_count > 0

Available options:
CPU_NODE,
A10_24GB,
A100_80GB,
A100_40GB,
A30_24GB,
A40_48GB,
B200_180GB,
B300_262GB,
RTX3070_8GB,
RTX3070_8GB,
RTX3080_10GB,
RTX3080Ti_12GB,
RTX3090_24GB,
RTX3090Ti_24GB,
RTX4070Ti_12GB,
RTX4080_16GB,
RTX4080Ti_16GB,
RTX4090_24GB,
RTX5090_32GB,
H100_80GB,
H200_96GB,
GH200_96GB,
H200_141GB,
GH200_480GB,
GH200_624GB,
L4_24GB,
L40_48GB,
L40S_48GB,
RTX4000_8GB,
RTX5000_16GB,
RTX6000_24GB,
RTX8000_48GB,
RTX2000Ada_16GB,
RTX4000Ada_20GB,
RTX5000Ada_32GB,
RTX6000Ada_48GB,
A2000_6GB,
A4000_16GB,
A4500_20GB,
A5000_24GB,
A6000_48GB,
V100_16GB,
V100_32GB,
P100_16GB,
T4_16GB,
P4_8GB,
P40_24GB,
RTX_PRO_6000B_96GB
​
vm
boolean
default:false

Create a VM sandbox on the VM sandbox infra. Required when requesting GPUs.

​
network_access
boolean
default:true

Allow outbound internet access (enabled by default)

​
timeout_minutes
integer
default:60

Max execution time in minutes

Required range: 1 <= x <= 1440
​
environment_vars
Environment Vars · object

Environment variables

​
secrets
Secrets · object

Sensitive environment variables. Currently supported for CPU sandboxes only; VM sandboxes reject this field.

​
labels
string[]

Tags/labels for the sandbox

​
team_id
string | null

Team ID for team sandboxes

​
advanced_configs
AdvancedConfigs · object

Advanced configuration options

​
registry_credentials_id
string | null

Registry credentials ID for pulling private images

​
region
string | null

Cluster region for the sandbox (e.g. us, india). Defaults to 'us'.

​
guaranteed
boolean
default:false

Admin/manager only. When true, schedule the sandbox with CPU/memory requests equal to its limits (Guaranteed QoS), bypassing the default oversubscription multiplier. Not applicable to VM sandboxes.

Response

Successful Response

​
id
string
required
​
name
string
required
​
dockerImage
string
required
​
startCommand
string | null
required
​
cpuCores
number
required
​
memoryGB
number
required
​
diskSizeGB
number
required
​
diskMountPath
string
required
​
gpuCount
integer
required
​
networkAccess
boolean
required
​
status
enum<string>
required
Available options:
PENDING,
PROVISIONING,
RUNNING,
PAUSED,
ERROR,
TERMINATED
​
timeoutMinutes
integer
required
​
environmentVars
Environmentvars · object
required
​
advancedConfigs
Advancedconfigs · object
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
startedAt
string<date-time> | null
required
​
terminatedAt
string<date-time> | null
required
​
userId
string | null
required
​
teamId
string | null
required
​
kubernetesJobId
string | null
required
​
gpuType
enum<string> | null
Available options:
CPU_NODE,
A10_24GB,
A100_80GB,
A100_40GB,
A30_24GB,
A40_48GB,
B200_180GB,
B300_262GB,
RTX3070_8GB,
RTX3070_8GB,
RTX3080_10GB,
RTX3080Ti_12GB,
RTX3090_24GB,
RTX3090Ti_24GB,
RTX4070Ti_12GB,
RTX4080_16GB,
RTX4080Ti_16GB,
RTX4090_24GB,
RTX5090_32GB,
H100_80GB,
H200_96GB,
GH200_96GB,
H200_141GB,
GH200_480GB,
GH200_624GB,
L4_24GB,
L40_48GB,
L40S_48GB,
RTX4000_8GB,
RTX5000_16GB,
RTX6000_24GB,
RTX8000_48GB,
RTX2000Ada_16GB,
RTX4000Ada_20GB,
RTX5000Ada_32GB,
RTX6000Ada_48GB,
A2000_6GB,
A4000_16GB,
A4500_20GB,
A5000_24GB,
A6000_48GB,
V100_16GB,
V100_32GB,
P100_16GB,
T4_16GB,
P4_8GB,
P40_24GB,
RTX_PRO_6000B_96GB
​
vm
boolean
default:false
​
labels
string[]
​
exitCode
integer | null
​
errorType
string | null
​
errorMessage
string | null
​
region
string
default:us
​
registryCredentialsId
string | null