Skip to main content
POST
Create a session

Authorizations

Authorization
string
header
required

API key in the format gw_(live|test)_sk_<hex>

Body

application/json
rig_id
string
required
mode
enum<string>
default:desktop
Available options:
desktop,
app
idle_timeout_seconds
integer
default:900

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 <= 3600

Response

Session created

session_id
string
Example:

"s_xyz789"

rig_id
string
mode
enum<string>
Available options:
desktop,
app
status
enum<string>
Available options:
active,
ended,
failed
started_at
string<date-time>
action_count
integer
idle_timeout_seconds
integer

Inactivity seconds before automatic idle end (60–3600).

capture_mode
enum<string>

Host API capture path (updates mid-session on DXGI loss → GDI fallback)

Available options:
dxgi,
gdi,
gdi_fallback,
unknown
Example:

"dxgi"