Skip to main content
GET
JavaScript
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.

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

Response

OK

The response is of type string.