Allocate a phone
Allocates an Android phone and opens a session. Omit workflow_id for an interactive lease (drive the phone directly); set it to allocate for a workflow. Pass phone_id to pin a specific dedicated phone. If allocation setup fails the claim is rolled back, so you are never billed for a session that never starts.
Authorizations
Customer API key (axl_ prefix).
Body
Request body for allocating a phone.
Category of device to allocate.
android Capture media this session produces on the phone into the org's file library (default true). false disables capture for this session entirely.
Hosted live-view options for this session; omit for the defaults (token auth, interactive, enabled).
Optional session label (letters, numbers, dots, hyphens, underscores; max 64). Unique among the org's active sessions - allocating with a name already in use returns a conflict.
PhoneID pins allocation to a specific device (for dedicated devices).
Which pool to draw the phone from. Omit for shared. 'dedicated' claims any idle phone your organization rents; combine with phone_id to pin a specific one.
shared, dedicated Record this session's screen (default true). false suppresses the video recording and rolling thumbnail entirely - no screen content is ever written.
Optional key->value labels for organizing sessions (max 50 tags; keys up to 40 chars, values up to 128).
Emit this session's telemetry (default true). false suppresses telemetry entirely - no live trace stream and no durable trace store; the session dashboard shows a 'telemetry disabled' state.
Idle timeout for this session. Omit for no idle timeout: the session runs until the 1-hour max-session cap.
Workflow requesting allocation; nil for an interactive lease.
Response
OK
Returned when a device has been successfully allocated.
Allocated device's identifier.
Device_allocations row id — the canonical session identifier (WS-ID2).
Timestamp when the session started.
WebSocket URL for driving the phone over the device control protocol.
Hosted live-view page URL (live screen + interaction, iframe-embeddable). Contains a session-scoped capability token; treat as a secret. Dies with the session.
Physical region or location of the device.
WebSocket URL for the session's live telemetry stream (trace spans + output logs, read-only). Dies with the session.