Create screenshot async

Use our build-in adblocker.

Provide credentials for HTTP authentication.

Color-scheme to set on the page.

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

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

HTML to render. Needs to be base64 encoded!

HTML template to render, uses Handlebars to render your HTML together with the provided templateData. Needs to be base64 encoded!

Whether or not to enable JavaScript on the page.

Changes the CSS media type of the page.

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

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

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

Wait for the pageFunction to execute in the page. If the pageFunction doesn't execute successfully after the timeout milliseconds of waiting, the request will continue.

Wait for a certain amount of milliseconds before the request continues.

Wait for the selector to appear in page. If the selector doesn't appear after the timeout milliseconds of waiting, the request will continue.

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.

The webhook's URL. Should include the scheme, e.g. https://

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

Additional metadata that will be inside the request when the webhook is called. All values must be strings. Max 1kB.

Method to use when calling the webhook.

The way this webhook wants to receive the result.

• When URL is used an temporary URL will be provided to download the file (the file will be automatically deleted after 1 hour).
• When base64 is used make sure your webhook can receive the size of the file!

Capture the screenshot beyond the viewport. false if there is no clip. true otherwise.

Specifies the region of the page to clip.

Device preset to use, will not be set when viewport option is provided!

It captures the DOM element matching the given CSS selector. This will overwrite the clip property and set fullPage to false. Will wait for the element to become visible for a maximum of 15 seconds.

Capture the screenshot from the surface, rather than the view.

When true, takes a screenshot of the full page.

Hides default white background and allows capturing screenshots with transparency.

Add an overlay to the image. Cannot be used together with the fullPage option!

Quality of the image, between 0-100. Not applicable to png images.

Define an custom viewport, when defined the device option will be ignored!

Pre-signed url to upload the generated pdf/screenshot to. Should include the scheme, e.g. https://