HTTP API
Capture a desktop screenshot region.
GET /v1/desktop/screenshot/region
GET
/v1/desktop/screenshot/region
Performs a health-gated screenshot crop against the managed desktop and returns the requested region image bytes.
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ” x
required
integer format: int32
y
required
integer format: int32
width
required
integer format: int32
height
required
integer format: int32
format
string
quality
integer format: int32
scale
number format: float
showCursor
boolean
Responses
Section titled “ Responses ”Desktop screenshot region as image bytes
Invalid screenshot region
object
detail
string
instance
string
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties
Desktop runtime is not ready
object
detail
string
instance
string
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties
Desktop runtime health or screenshot capture failed
object
detail
string
instance
string
status
required
integer format: int32
title
required
string
type
required
string
key
additional properties