Base URL
Authentication
All requests require a Bearer token in theAuthorization header:
Quick start
1. Create a workspace
Workspaces organize your computers.2. Create a computer
3. Control the computer
Resource hierarchy
Computer specs
Any other value for
os, cpu, ram, or gpu is rejected with 400. ios places the computer on a physical handset, so it succeeds only where one is available, and cpu and ram are ignored for it. GPU computers are Linux only. Windows requires either a Windows license on the account or a plan that includes Windows.
Maximum CPU, RAM, and disk per computer are capped by your plan. See orgo.ai/pricing.
Recommended configurations
Available actions
Mouse
- Click (left, right, double)
- Move (hover, without clicking)
- Drag
- Scroll
Keyboard
- Type text
- Press keys (Enter, Tab, ctrl+c, etc.)
Execution
- Bash commands
- Python code
Real-time (WebSocket)
- Terminal: interactive PTY shell
- Audio: live PCM audio stream from the computer’s virtual speaker
- Events: subscribe to window, clipboard, file, process, and idle events
Lifecycle
- Start, stop, restart
- Auto-stop (off by default; configurable per computer on paid plans)
- Clone (copy a computer with full disk state)
- Fork (copy a running computer, memory included)
- Resize (live CPU/RAM/disk hot-resize)
- Move (transfer between workspaces)
Other
- Screenshots
- Wait/delays
Templates
Templates are reproducible computers defined in a singleorgo.ai/v1 file: hardware, installed apps, long-running services, secrets, and lifecycle hooks. Orgo builds the file once into a golden snapshot, and every launch restores from it in seconds.
- Launch a curated template. Pass a
system/…ref astemplate_refto Create computer. - Author your own. Validate, publish, and build over HTTP. Start at the Templates API.
Resource IDs
Workspaces, computers, files, and threads are identified by UUIDs. Pass the UUID in the URL path wherever you see an{id} placeholder, as in /workspaces/{id} or /computers/{id}/click.
Workspace and computer UUIDs are returned in the id field of every create, get, and list response. A computer also has a separate instance id, returned as instance_id by Create computer. The instance id addresses WebSocket paths such as wss://www.orgo.ai/desktops/{instance_id}/ws/websockify, not the REST endpoints.
Error responses
Errors return a JSON object with anerror field holding a human-readable message:
/v1 are the exception. Their error is an object with type, message, and code, described in Create chat completion.
Some errors add a machine-readable code (for example workspace_scope_mismatch, GUEST_RESTRICTED, disk_exceeds_quota). Branch on code where it is present. It is stable, and the error string is not.
Workspaces are called projects internally, so a few error messages on the workspace endpoints say “project”. They refer to the same resource.
Rate limits
Some endpoints are rate limited. If you get a429, back off with exponential retry: start at 1s, double each retry, and cap the delay at 60s. Email spencer@orgo.ai if you need higher limits.
Next steps
Create Workspace
Organize computers
Create Computer
Provision a computer
Templates
Reproducible computers
Authentication
API key setup
Use Any Model
Claude, GPT, Gemini, and more