Create PDF
Create a PDF and directly return the raw result.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Page options, either provide the url, html or htmlTemplate option.
Use our build-in adblocker.
Color-scheme to set on the page.
20Cookies added to the page, Also accepted as string inside headers.cookie.
Cookie domain.
1 - 512Cookie name.
1 - 1024Cookie value.
1 - 4096Cookie expiration date (UTC time in seconds, counted from January 1, 1970.), session cookie if not set.
true if cookie is http-only.
Cookie path.
1 - 512Cookie SameSite type.
Strict, Lax, None true if cookie is secure.
The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie. Should include the scheme, e.g. https://
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.
screen, print 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.
Function to be evaluated in browser context until it returns a truthy value.
1 - 1024Options for configuring waiting behavior.
An interval at which the pageFunction is executed, defaults to raf. If polling is a number, then it is treated as an interval in milliseconds at which the function would be executed. If polling is a string, then it can be one of the following values:
rafto constantly executepageFunctioninrequestAnimationFramecallback. This is the tightest polling mode which is suitable to observe styling changes.mutationto executepageFunctionon every DOM mutation.
raf, mutation Maximum time to wait in milliseconds.
1 < x < 30000Wait for a certain amount of milliseconds before the request continues.
0 < x < 5000Wait for the selector to appear in page. If the selector doesn't appear after the timeout milliseconds of waiting, the request will continue.
The selector of an element to wait for.
1 - 1024Options for configuring waiting behavior.
Wait for the selected element to not be found in the DOM or to be hidden.An element is considered to be hidden if at least one of the following is true:
- the element has no computed styles
- the element has an empty bounding client rect
- the element's visibility is
hiddenorcollapse
Maximum time to wait in milliseconds.
1 < x < 30000Wait for the selected element to be present in DOM and to be visibleAn element is considered to be visible if all of the following is true:
- the element has computed styles
- the element has a non-empty bounding client rect
- the element's visibility is not
hiddenorcollapse
When to consider waiting succeeds.
autoour smart waiting option that can handle 90% of the cases.loadwaits for the 'load' event.domcontentloadedwaits for the 'DOMContentLoaded' event.networkidle0waits till there are no more than 0 network connections for at least500ms.networkidle2waits till there are no more than 2 network connections for at least500ms.
auto, load, domcontentloaded, networkidle0, networkidle2 Whether to show the header and footer.
HTML template for the print footer. Has the same constraints and support for special classes as headerHtml.
If set, this takes priority over the width and height options.
The sizes of each format are as follows:
letter8.5in x 11inlegal8.5in x 14intabloid11in x 17inledger17in x 11ina033.1in x 46.8ina123.4in x 33.1ina216.54in x 23.4ina311.7in x 16.54ina48.27in x 11.7ina55.83in x 8.27ina64.13in x 5.83in
letter, legal, tabloid, ledger, a0, a1, a2, a3, a4, a5, a6 HTML template for the print header. Should be valid HTML (base64 encoded) with the following classes used to inject values into them:
dateformatted print datetitledocument titleurldocument locationpageNumbercurrent page numbertotalPagestotal pages in the document
Sets the height of paper. You can pass in a number or a string with a unit.
Whether to print in landscape orientation.
Hides default white background and allows generating pdfs with transparency.
Generate document outline. If this is enabled the PDF will also be tagged (accessible).
Paper ranges to print, e.g. 1-5, 8, 11-13.
Give any CSS @page size declared in the page priority over what is declared in the width or height or format option.
Set to true to print background graphics.
Scales the rendering of the web page. Amount must be between 0.1 and 2.
0.1 < x < 2Generate tagged (accessible) PDF. This is experimental and will increase the size of the PDF.
Sets the width of paper. You can pass in a number or a string with a unit.
Response
Raw PDF document
Was this page helpful?