Get Started
Templating
API Documentation
Sync/Async options
API Documentation
Page options
All the available page options for the PDF/screenshot API endpoints.
Either page.url
, page.html
or page.htmlTemplate
needs to be set, they cannot be used at the same time!
The schema is of type object
.
Was this page helpful?
{
"url": "<string>",
"html": "<string>",
"htmlTemplate": "<string>",
"templateData": {},
"waitUntil": "auto",
"waitForMilliseconds": 2500,
"waitForSelector": {
"selector": "<string>",
"options": {
"visible": false,
"hidden": false,
"timeout": 10000
}
},
"waitForFunction": {
"pageFunction": "window.innerWidth < 100",
"options": {
"polling": "raf",
"timeout": 10000
}
},
"headers": {
"x-foo": "bar"
},
"adblock": true,
"javascript": true,
"cookies": [
{
"name": "<string>",
"value": "<string>",
"domain": "<string>",
"url": "<string>",
"path": "<string>",
"secure": true,
"httpOnly": true,
"sameSite": "Strict",
"expires": 123
}
],
"authentication": {
"username": "<string>",
"password": "<string>"
},
"colorScheme": "<string>",
"mediaType": "screen",
"timezone": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.