Skip to main content
POST
Take a screenshot with compression options

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Path Parameters

id
string
required

Machine ID (e.g. mch_a1b2c3d4)

Body

application/json
format
enum<string>
default:png
Available options:
png,
jpeg,
jpg,
webp
quality
integer
default:80
Required range: 0 <= x <= 100
scale
number<float>
default:1
show_cursor
boolean
default:false
region
object

Response

Image data in requested format

The response is of type file.