Capture a full desktop screenshot.

GET

/v1/desktop/screenshot

Performs a health-gated full-frame screenshot of the managed desktop and returns the requested image bytes.

Parameters

Query Parameters

format

string

Allowed values: png jpeg webp

quality

integer format: int32

nullable

scale

number format: float

nullable

showCursor

boolean

nullable

Responses

200

Desktop screenshot as image bytes

400

Invalid screenshot query

object

detail

string

nullable

instance

string

nullable

status

required

integer format: int32

title

required

string

type

required

string

key

additional properties

409

Desktop runtime is not ready

object

detail

string

nullable

instance

string

nullable

status

required

integer format: int32

title

required

string

type

required

string

key

additional properties

502

Desktop runtime health or screenshot capture failed

object

detail

string

nullable

instance

string

nullable

status

required

integer format: int32

title

required

string

type

required

string

key

additional properties