HTM to PNG 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.

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

String Element selector string of the DOM element that should be converted. Element will be cropped from the document.

Double Set the default zoom level of webpages.

Default: 1

Range: 0.1 .. 10.0

Bool Sets default background color to transparent to get transparency in the image. Also, for this property to work, the source HTML BODY background color should be set to none.

Default: False

Integer Image width in pixels.

Range: 10 .. 20000

Integer Image height in pixels.

Range: 10 .. 20000

Integer Screenshot crop X offset.

Range: 0 .. 16384

Integer Screenshot crop Y offset.

Range: 0 .. 16384

Integer Screenshot crop width.

Range: 1 .. 16384

Integer Screenshot crop height.

Range: 1 .. 16384