Interactive playground

CreateOS Sandbox is in alpha. These tools run against the live control plane. Live calls are read-only — nothing here creates, mutates, or deletes a sandbox. Talk to us / share feedback.

Try the API without leaving the docs. Set your key once below and every code sample on this page fills it in. The Try it panel makes real (read-only) calls through a same-origin proxy, so your key never touches a third-party origin.

Set your key once

Authorize with your CreateOS account — the “Try it” widgets then call the API as you.

Or paste an API key

CreateOS API key

Saved in this browser only. Get one from your dashboard.

Your key is stored in this browser only. If you are signed in to the CreateOS dashboard, the Try it panel can also use your session automatically.

Build a create command

Pick a shape and toggle options — the command updates live for whichever surface you use. The tabs stay in sync with the rest of the page.

ShapeNameRootfs (optional)Auto-pause after (seconds)

Enable HTTP ingressEnable SSH gateway

Bash

1createos sandbox create --shape s-1vcpu-1gb \
2  --name my-box

One task, three surfaces

The same work — create a box, run a command, tear it down — across the CLI, the TypeScript SDK, and the raw REST API. Switch the tab; your choice sticks.

Bash
1createos sandbox create --shape s-1vcpu-1gb --name my-box
2createos sandbox exec my-box -- uname -a
3createos sandbox rm my-box --force

Lifecycle

A sandbox moves between a few states. Click any state for its reference.

Creating

POST /v1/sandboxes

ready→

Running

exec · files · ingress

pause→

Paused

snapshot in storage

resume · paused → runningfork · paused → new running clonerm · running → destroyed

Destroyed

DELETE /v1/sandboxes/{id}

Each state links to its REST reference. The same transitions are exposed in the SDK and CLI.

Try it live

Read-only calls against your account. No sandboxes are created or deleted.

Next steps

Quickstart: create your first sandbox
Concepts: the vocabulary
REST API: every endpoint
SDK: the TypeScript client
CLI: the terminal workflow