Take screenshot
GET /api/screenshot
GET
/api/screenshot
Capture the full screen or a region via query parameters. Returns the image as binary.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ” format
string
Image format.
quality
integer
JPEG quality (1–100).
x
integer
Left edge of the capture region.
y
integer
Top edge of the capture region.
width
integer
Region width in pixels. Set width and height together. Use 0 for both to capture the full screen; otherwise both must be positive pixel values.
height
integer
Region height in pixels. Set width and height together. Use 0 for both to capture the full screen; otherwise both must be positive pixel values.
Responses
Section titled “ Responses ”Screenshot image.
string format: binary
string format: binary
Bad request – validation error.
object
message
required
string
Example
Invalid request errors
required
Array<object>
object
field
required
string
error
required
string