Skip to main content
POST
/
v1
/
sandboxes
curl --request POST \
  --url https://api.runtools.ai/v1/sandboxes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "template": "base-ubuntu"
}
'
{
  "data": {
    "id": "sandbox-abc123def456",
    "name": "<string>",
    "status": "pending",
    "tags": [
      "<string>"
    ],
    "template": "<string>",
    "ownerUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ownerDisplayName": "<string>",
    "ownerEmail": "<string>",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "mounts": [
      {
        "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "path": "/workspace",
        "readOnly": true
      }
    ],
    "hasWritableWorkspaceMount": true,
    "sshReady": true,
    "vncReady": true,
    "ip": "<string>",
    "publicIp": "<string>",
    "sshAccessConfigured": true,
    "sshAuthMethod": "key",
    "vncUrl": "<string>",
    "resources": {
      "vcpus": 2,
      "memory": "4GB",
      "disk": "10GB"
    },
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
required

WorkOS session token or RunTools API key (rt_live_* / rt_test_*). Used in Authorization: Bearer <token> header.

Body

application/json
​
template
string
required
Example:

"base-ubuntu"

​
name
string
​
mounts
object[]
​
idleTimeout
integer

Idle pause timeout, in seconds. 0 disables auto-pause.

Example:

600

​
resources
object
​
env
object
​
metadata
object
​
sshKeys
string<uuid>[]

SSH key IDs to inject (resolved server-side).

​
rootPassword
string

Optional root password (less secure than keys).

​
tags
string[]
​
projectId
string<uuid>

Response

Sandbox created.

​
data
object