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.
Create
SandboxCreateOptions
| Field | Type | Description |
|---|---|---|
name | string | Friendly name |
template | string | Defaults to base-ubuntu |
tags | string[] | Filter and deploy tracking tags |
sshKeys | string[] | SSH key IDs to inject |
rootPassword | string | Optional password access |
resources | { vcpus?, memory?, disk? } | Resource request |
env | Record<string,string> | Environment variables |
idleTimeout | number | Idle timeout in seconds |
mounts | { workspaceId, path }[] | Workspace mounts under /workspace |
/workspace or a subpath under /workspace. When an agent uses this sandbox, the mounted workspace is persistent filesystem state the agent can carry across runs.
List
status, tags, template, exclude_template, limit, cursor, and admin-only all.
Get an Instance
get() returns a local Sandbox object. It does not fetch immediately; methods and subscriptions use the API.
Execute
Lifecycle
Wait and Subscribe
Accessors
| Property | Description |
|---|---|
sandbox.id | Sandbox ID |
sandbox.status | Current known status or unknown |
sandbox.sshReady | Current known SSH readiness |
sandbox.vncReady | Current known VNC readiness |
sandbox.vncUrl | Normalized desktop URL when available |
sandbox.state | Last full state payload or null |
sandbox.metrics | Last metrics payload or null |