Create a session
Sessions
Create a session
Start a new desktop session on a rig. The rig must be online and have API access enabled by the owner.
POST
Create a session
Authorizations
API key in the format gw_(live|test)_sk_<hex>
Body
application/json
Available options:
desktop, app Seconds with no screenshot, observe, or input before the
session is ended automatically (ended_reason=idle_timeout).
Longer timeouts keep the concurrency slot and continue
wall-clock billing. Default 900 (15 minutes).
Required range:
60 <= x <= 3600Response
Session created
Example:
"s_xyz789"
Available options:
desktop, app Available options:
active, ended, failed Inactivity seconds before automatic idle end (60–3600).
Host API capture path (updates mid-session on DXGI loss → GDI fallback)
Available options:
dxgi, gdi, gdi_fallback, unknown Example:
"dxgi"
