Skip to main content
GET
JavaScript
Deprecated: use POST /devices/{deviceId}/screenshots to capture a screenshot. Existing callers can continue using this endpoint and migrate in a follow-up. The response body is the PNG image itself (Content-Type: image/png), not a JSON wrapper. The accessibility overlay is the on-screen element-highlight layer controlled by the set overlay visibility endpoint. If you’ve enabled it, pass hideOverlay=true to capture a clean frame; on devices whose capture path sits below the overlay, the flag has no effect either way. Pass save=true to also store the captured PNG as device media. If the device has an active recording owned by the device owner, the screenshot is saved into that recording and inherits its retention. Otherwise it is saved standalone for seven days. Without save=true, no screenshot is stored. The PNG response is unchanged; X-Screenshot-Saved is true when both the object and its metadata were stored, and false if storage limits or a save failure prevented persistence. A failed save does not fail screenshot capture. The device screenshots endpoints list saved screenshots, open their images, and delete individual screenshots. Recording screenshots remain available through the existing list recording screenshots endpoint and are also deleted with the recording.

Authorizations

Authorization
string
header
required

Bearer token via Authorization header

Headers

X-Device-Display-ID
integer<int64>
default:0
Required range: x >= 0

Path Parameters

deviceId
string
required

Query Parameters

hideOverlay
boolean
default:false
save
boolean
default:false

Store the screenshot as device media: in the owner's active recording, or standalone for 7 days. Without save=true nothing is stored. The PNG response is unchanged; X-Screenshot-Saved reports whether it was stored.

Response

OK

The response is of type string.