Get Started
Templating
API Documentation
Sync/Async options
API Documentation
Screenshot options
All available options for the screenshot API endpoints.
All options are optional
The schema is of type object
.
Was this page helpful?
{
"type": "png",
"device": "Macbook Pro 16",
"viewport": {
"width": 2240,
"height": 1260,
"deviceScaleFactor": 1,
"isMobile": false,
"hasTouch": false,
"isLandscape": false
},
"fullPage": false,
"fromSurface": true,
"omitBackground": false,
"optimizeForSpeed": true,
"quality": 50,
"captureBeyondViewport": false,
"clip": {
"scale": 1,
"width": 2240,
"height": 1260,
"x": 123,
"y": 123
},
"element": "<string>",
"overlay": {
"background": "<string>",
"filter": "none",
"margin": 0.2,
"browser": "light",
"screenshotBorderRadius": 0
}
}
Assistant
Responses are generated using AI and may contain mistakes.