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,
  "timeout_minutes": 60,
  "environment_vars": {},
  "team_id": "<string>",
  "advanced_configs": {}
}'
{
  "id": "<string>",
  "name": "<string>",
  "dockerImage": "<string>",
  "startCommand": "<string>",
  "cpuCores": 123,
  "memoryGB": 123,
  "diskSizeGB": 123,
  "diskMountPath": "<string>",
  "gpuCount": 123,
  "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",
  "exitCode": 123,
  "userId": "<string>",
  "teamId": "<string>",
  "kubernetesJobId": "<string>"
}

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 length: 1
start_command
string | null

Command to run in container

cpu_cores
integer
default:1

CPU cores required

Required range: 1 <= x <= 16
memory_gb
integer
default:2

Memory in GB

Required range: 1 <= x <= 64
disk_size_gb
integer
default:10

Disk size in GB

Required range: 1 <= x <= 1000
gpu_count
integer
default:0

Number of GPUs

Required range: 0 <= x <= 8
timeout_minutes
integer
default:60

Max execution time in minutes

Required range: 1 <= x <= 1440
environment_vars
object | null

Environment variables

team_id
string | null

Team ID for team sandboxes

advanced_configs
object | null

Advanced configuration options

Response

Successful Response

id
string
required
name
string
required
dockerImage
string
required
startCommand
string | null
required
cpuCores
integer
required
memoryGB
integer
required
diskSizeGB
integer
required
diskMountPath
string
required
gpuCount
integer
required
status
enum<string>
required
Available options:
PENDING,
PROVISIONING,
RUNNING,
STOPPED,
ERROR,
TERMINATED
timeoutMinutes
integer
required
environmentVars
object | null
required
advancedConfigs
object | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
startedAt
string<date-time> | null
required
terminatedAt
string<date-time> | null
required
exitCode
integer | null
required
userId
string | null
required
teamId
string | null
required
kubernetesJobId
string | null
required
I