mobileDevices

A mobile device is a cloud Android phone, the third member of the computer suite beside computers and browser sessions. Seven methods; objects parse with the core MobileDeviceSchema. API detail: Mobile devices.

create

client.mobileDevices.create(body: MobileDeviceCreate): Promise<MobileDevice>

POST /v1/mobile_devices. Every field is optional — an empty body gets an Android 15 phone in the us jurisdiction with a 10-minute idle timeout and a 2-hour ceiling. platform is android (the only platform today) and model is phone. A phone takes about a minute to boot, so the answer is usually creating: poll get until it is ready. There is no limit on how many phones an organization runs, only on the balance: a create needs 10 minutes ($0.39) for every live phone and the new one, plus what the live ones have run, or it throws insufficient_credits (402). It throws rate_limited (429) when the platform’s phones are all in use; try again shortly.

const device = await client.mobileDevices.create({
  name: "pixel",
  os_version: "15",
  idle_timeout_minutes: 15,
  apps: ["com.example.shop"],
});

list

client.mobileDevices.list(query?: ListQuery & { session_id?: string }): Promise<Page<MobileDevice>>

GET /v1/mobile_devices, cursor-paginated, terminated devices excluded; session_id narrows it to the phone that agent session opened. Reads rows only; see get for the reconciled read.

get

client.mobileDevices.get(id: string): Promise<MobileDevice>

GET /v1/mobile_devices/{id}. Asks the provider and rewrites the row when they disagree — the read that notices an idle-timer termination.

update

client.mobileDevices.update(id: string, body: { name: string }): Promise<MobileDevice>

PATCH /v1/mobile_devices/{id}. The name, and nothing else.

act

client.mobileDevices.act(id: string, action: MobileAction): Promise<MobileActionResult>

POST /v1/mobile_devices/{id}/act. One action; the device must be ready. image is { content_type: "image/jpeg", data: "<base64>" } on a screenshot, at half the phone’s resolution; its pixels map 1:1 to tap coordinates. Every other action answers image: null, so take a screenshot to see its result.

const look = await client.mobileDevices.act(device.id, { type: "screenshot" });
await client.mobileDevices.act(device.id, { type: "tap", x: 360, y: 1200 });
await client.mobileDevices.act(device.id, { type: "tap", selector: { text: "Sign in" } });
await client.mobileDevices.act(device.id, { type: "type", text: "hello" });
await client.mobileDevices.act(device.id, { type: "press_key", key: "KEYCODE_BACK" });
await client.mobileDevices.act(device.id, { type: "scroll", direction: "down" });
await client.mobileDevices.act(device.id, { type: "open_url", url: "https://example.com" });

liveView

client.mobileDevices.liveView(id: string): Promise<MobileLiveView>

POST /v1/mobile_devices/{id}/live_view. Answers url, the device’s page on the dashboard, where the screen plays live. stream (a wss:// address and token for the dashboard’s player) is returned only to a signed-in member, so with an API key it is null: open url. Needs computers:write; a device still starting answers computer_unavailable, and one that has ended answers not_found. stream is a bearer credential — whoever holds it drives the device until it ends. Do not log or store it; play it and let it die with the device. expires_at is null. Each mint is audited as mobile_device.live_view_opened, without the credential.

delete

client.mobileDevices.delete(id: string): Promise<{ id: string; object: string; deleted: true }>

DELETE /v1/mobile_devices/{id}. Ends the device; idempotent.

TypeScript

Control plane

Resources

Identity & access

Automation

Account

mobileDevices

create

list

get

update

act

liveView

delete

​create

​list

​get

​update

​act

​liveView

​delete

create

list

get

update

act

liveView

delete