{
  "url": "<string>",
  "html": "<string>",
  "htmlTemplate": "<string>",
  "templateData": {},
  "waitUntil": "auto",
  "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>"
}

Either page.url, page.html or page.htmlTemplate needs to be set, they cannot be used at the same time!

url
string | null

URL to go to. Should include the scheme, e.g. https://

html
string | null

HTML to render. Needs to be base64 encoded!

htmlTemplate
string | null

HTML template to render. Needs to be base64 encoded!

templateData
object | null

Template data, only used in combination with page.htmlTemplate.

waitUntil
enum<string>
default: auto

When to consider waiting succeeds.

  • auto our smart waiting option that can handle 90% of the cases.
  • load waits for the 'load' event.
  • domcontentloaded waits for the 'DOMContentLoaded' event.
  • networkidle0 waits till there are no more than 0 network connections for at least 500 ms.
  • networkidle2 waits till there are no more than 2 network connections for at least 500 ms.
Available options:
auto,
load,
domcontentloaded,
networkidle0,
networkidle2
headers
object | null

An object containing additional HTTP headers to be sent with every request. All header values must be strings.

adblock
boolean
default: true

Use our build-in adblocker.

javascript
boolean
default: true

Whether or not to enable JavaScript on the page.

cookies
object[] | null

Cookies added to the page, Also accepted as string inside headers.cookie.

authentication
object

Provide credentials for HTTP authentication.

colorScheme
string | null

Color-scheme to set on the page.

mediaType
enum<string> | null

Changes the CSS media type of the page.

Available options:
screen,
print
timezone
string | null

Changes the timezone of the page. See ICU’s metaZones.txt for a list of supported timezone IDs.

Was this page helpful?

IntroductionPDF options