Skip to main content
GET
/
v1
/
desktop
/
screenshot
/
region
Capture a desktop screenshot region.
curl --request GET \
  --url http://localhost:2468/v1/desktop/screenshot/region
{
  "status": 1,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "instance": "<string>"
}

Query Parameters

​
x
integer<int32>
required
​
y
integer<int32>
required
​
width
integer<int32>
required
Required range: x >= 0
​
height
integer<int32>
required
Required range: x >= 0
​
format
enum<string>
Available options:
png,
jpeg,
webp
​
quality
integer<int32> | null
Required range: x >= 0
​
scale
number<float> | null
​
showCursor
boolean | null

Response

Desktop screenshot region as image bytes