Skip to main content
POST
Start a live view of the session's phone

Authorizations

X-Api-Key
string
header
required

Workspace API key, created in the dashboard under Settings → API Keys.

Path Parameters

id
string
required

Session ID.

Body

application/json
width
number
height
number
fps
number
iceServers
object[]

Overrides the server-issued ICE servers for the phone. Omit to use them.

viewer_id
string

Identifies this viewer when several watch one phone. Defaults to the session id.

workspaceId
string<uuid>

Optional for workspace-scoped API keys.

Response

The phone accepted the command

data
object
required