v12

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-014994227.2 KB

phones

Get a session's live thumbnail

Returns a short-lived URL for the session's current screen thumbnail — a rolling JPEG refreshed every few seconds while the session is active. Poll this endpoint and swap the image; every call mints a fresh URL. Status is "pending" (no URL) before the first frame lands or after the session ends. Org-scoped: another org's session reads as not found.

get/phones/sessions/{session_id}/thumbnail

Path parameters

session_idstring uuid required

Phone session identifier

Response

$schemastring uri

A URL to the JSON Schema for this object.

status'ready' | 'pending' required

'ready' when a thumbnail URL is returned, or 'pending' when no thumbnail exists.

urlstring

URL for the current thumbnail JPEG, set only when status is 'ready'. The URL is time-limited; poll the endpoint for a fresh image.

Example response

{
  "$schema": "/api/v1/PhoneSessionThumbnailResponse.json"
}