What it reaches
What it does not reach
- The live screen and remote control. Both are dashboard-only, over WebSocket and MJPEG. There is no API for either.
- The Companion. Nothing in the API installs, starts or configures the desktop app, and nothing runs while it is closed.
- Script authoring. Scripts are read-only here, and the Script Builder is locked platform-wide.
- Billing. Buying slots, credits or Autogrowth MAX happens in the dashboard.
Quickstart
Create a key
In the dashboard, open Settings → Developer API and create a key. It is
shown once — copy it into your secret manager immediately. You need the
Manage API keys permission to see that screen. Details in
Authentication.
List your phones
id of a phone whose slotState is active. A phone with an
expired slot cannot be scheduled on.Schedule a run
Automation IDs come from
A
GET /automations, which also
returns each automation’s inputs. Keys in inputValues are those inputs’
id fields.201 means the run is queued, not that it has happened. Poll
GET /executions for its
status, or read it back by ID.The response also carries conflicts: pending runs on the same phone whose
window overlaps this one. It is information, not a rejection — the phone runs
one execution at a time and queues the rest.Before you build
Authentication
Key format, the bearer header, and the scoping rule that surprises everyone.
Conventions
IDs, timestamps, dropped nulls, expanded references, no pagination.
Errors
The error envelope, the codes, and what to do about each.
API Reference
Every endpoint, generated from the spec.