Reference
Every capability the product ships, and the limits on each.
Everything below is a call the API answers today, reachable from both SDKs, the CLI and every integration. Nothing here is planned or partial unless it says so.
Driving a machine
Machines
Create, stop, start, fork and delete. Sizes, states and the event log.
The desktop
Screenshots, pointer, keyboard, clipboard and display geometry.
The terminal
One-shot commands as argv, and interactive ptys.
Files
List, read, write, upload and download, with an explicit encoding.
The browser
Open a URL, enumerate tabs, drive the rest as a desktop.
Sessions and input control
One holder of the keyboard at a time, and how a person takes it back.
Keeping and reaching a machine
Snapshots, forks and templates
Captured disks, branched machines and named starting states.
Published ports
A guest port at its own https hostname, private by default.
Secrets
Values delivered into tmpfs, never readable back out.
The realtime gateway
Live screen, input, terminal and event channels over one websocket protocol.
The account around it
Organizations, members and keys
Roles, permissions, API key scopes and how they intersect.
Plans, usage and billing
Entitlements, meters, rates and the current-period summary.
API conventions
Auth, idempotency, pagination, ids and versioning, in one place.
Errors
The closed set of codes, what each means, and which are worth retrying.
Not shipped yet
Two things are worth naming because their absence changes how you design around them.
- Memory snapshots. A capture is a cold disk capture and a start is a normal boot. There is no resume-from-RAM, so a long-running process does not survive a stop.
- Portable snapshots. A captured disk lives on one host. Object storage is declared in configuration but nothing writes to it yet.