Skip to content

Region screenshot

POST
/api/screenshot/region

Capture a specific region of the screen.

object
x
required

Left edge of the capture region.

integer
y
required

Top edge of the capture region.

integer
width
required

Region width in pixels.

integer
>= 1
height
required

Region height in pixels.

integer
>= 1
format

Image format.

string
Allowed values: png jpg jpeg
quality

JPEG quality.

integer
>= 1 <= 100

Screenshot image.

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