ui

Capture screenshot

Captures a screenshot of the entire screen or a specific element. Element IDs may identify MAUI visual elements or native elements advertised by the visual tree.

get/api/v1/ui/screenshot

Query parameters

elementIdstring

Element to screenshot. If omitted, captures the full screen.

maxWidthinteger

Maximum width in pixels. The image is scaled down if wider.

scale'native' | 'auto'

Scale mode. native returns at device pixel density; auto returns a reasonable size for agent consumption.

format'png' | 'jpeg'

Image format.

captureEpochinteger

Epoch returned by a prior tree, query, hit-test, element, or screenshot capture.

registryGenerationinteger

Native registration generation paired with captureEpoch.

Response

Screenshot image.

Changes