HTM to PDF API

String Authentication secret must be provided as a query parameter. If omitted, token must be provided.

String Authentication token must be provided as a query parameter. If omitted, secret must be provided.

Bool Store converted file on our secure server and provides download URL.

Default: False

String Converted output file name without extension. The extension will be added automatically.

Integer Conversion timeout in seconds.

Default: 120

Range: 10 .. 1200

Bool Run conversion job asynchronously.

Default: False

String Conversion job self generated UUID (RFC 4122) used for getting conversion result asynchronously. Also automatically added to WebHook url.

String Set WebHook URL to call after conversion is finished. Also works for synchronous requests.

String HTTP authentication username. Could be used if conversion web page is protected with HTTP authentication.

String HTTP authentication password. Could be used if conversion web page is protected with HTTP authentication.

String Set page range. Example 1-10 or 1,2,5.

Default: 1-100

Integer Delay in seconds before page load and PDF creation. Sometimes useful to let web page fully load.

Default: 0

Range: 0 .. 30

Bool Block ads in converting page.

Default: False

Bool Tries to remove EU regulation required cookie warnings from web pages.

Default: False

Bool Allow web pages to run JavaScript.

Default: True

String Element selector string of the DOM element. Converter will wait for this element to appear in DOM before conversion begins.

String Execute provided JavaScript before conversion begins.

String Element selector string of the DOM elements that needs to be hidden during conversion.

String Use CSS media type in conversion process. The default screen and print media types are supported but not limited to these. The custom media type, like convertapi can be used too.

Default: screen

Bool Load page images that loads only when they are visible.

Default: False

Integer Sets browser viewport width.

Default: 1366

Range: 200 .. 4000

Integer Sets browser viewport height.

Default: 1024

Range: 200 .. 4000

Bool Convert web page background.

Default: True

Collection Change fixed elements CSS 'position' property to adapt page for conversion.

Default: fixed

Values: fixed, absolute, relative, hide

String Element selector string of the DOM elements that should be visible during conversion. Other elements will be hidden.

Bool If true, the converter will generate PDF as the content looks like in the browser. If is set to false, the converter acts like Chrome print to PDF function.

Default: True

Integer Set web page scale value in percentage.

Default: 100

Range: 10 .. 200

Collection PDF page orientation.

Default: portrait

Values: portrait, landscape

Collection PDF page size.

Default: letter

Values: a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, b0, b1, b2, b3, b4, b5, letter, legal, ledger

Integer Custom page width in millimeters (mm). This option override PageSize option.

Range: 10 .. 30000

Integer Custom page height in millimeters (mm). This option override PageSize option.

Range: 10 .. 30000

Integer Set the page top margin in millimeters (mm).

Default: 10

Range: 0 .. 500

Integer Set the page right margin in millimeters (mm).

Default: 10

Range: 0 .. 500

Integer Set the page bottom margin in millimeters (mm).

Default: 10

Range: 0 .. 500

Integer Set the page left margin in millimeters (mm).

Default: 10

Range: 0 .. 500

String Adds a HTML header to every page. HTML tags with the classes 'pageNumber', 'totalPages', 'title', 'date' will be injected with the page metadata. Use inline CSS to style provided HTML.

String Adds a HTML footer to every page. HTML tags with the classes 'pageNumber', 'totalPages', 'title', 'date' will be injected with the page metadata. Use inline CSS to style provided HTML.