Set the scaling factor (zoom) for the output image. Must be a positive integer number.

The output image background color. It is available for API client version >= 5.0.0 and applicable for converter version >= 20.10. More Pdfcrowd versioning details. The value must be in RRGGBB or RRGGBBAA hexadecimal format.

Use the print version of the page if available (@media print).

Do not print the background graphics.

Do not execute JavaScript.

Do not load images.

Disable loading fonts from remote sources.

Use a mobile user agent. It is available for API client version >= 5.3.0 and applicable for converter version >= 20.10. More Pdfcrowd versioning details.

Specifies how iframes are handled. It is available for API client version >= 5.0.0 and applicable for converter version >= 20.10. More Pdfcrowd versioning details.
Possible values:

• "all" - All iframes are loaded.
• "same-origin" - Only iframes with the same origin as the main page are loaded.
• "none" - Iframe loading is disabled.

Try to block ads. Enabling this option can produce smaller output and speed up the conversion.

Set the default HTML content text encoding.

Set the locale for the conversion. This may affect the output format of dates, times and numbers. It is available for API client version >= 5.0.0 and applicable for converter version >= 20.10. More Pdfcrowd versioning details.

Set the HTTP authentication user name.

Set the HTTP authentication password.

Set cookies that are sent in Pdfcrowd HTTP requests.

Do not allow insecure HTTPS connections.

Abort the conversion if the main URL HTTP status code is greater than or equal to 400.

Abort the conversion if any of the sub-request HTTP status code is greater than or equal to 400 or if some sub-requests are still pending. See details in a debug log.

Do not send the X-Pdfcrowd HTTP header in Pdfcrowd HTTP requests.

Run a custom JavaScript right after the document is loaded. The script is intended for early DOM manipulation (add/remove elements, update CSS, ...). In addition to the standard browser APIs, the custom JavaScript code can use helper functions from our JavaScript library.

Set a custom HTTP header that is sent in Pdfcrowd HTTP requests. A string containing the header name and value separated by a colon.

Wait the specified number of milliseconds to finish all JavaScript after the document is loaded. Your API license defines the maximum wait time by "Max Delay" parameter. Must be a positive integer number or 0.

Specify the DOM handling when only a part of the document is converted. This can affect the CSS rules used.
Possible values:

• "cut-out" - The element and its children are cut out of the document.
• "remove-siblings" - All element's siblings are removed.
• "hide-siblings" - All element's siblings are hidden.

Wait for the specified element in a source document. The element is specified by one or more CSS selectors. The element is searched for in the main document and all iframes. If the element is not found, the conversion fails. Your API license defines the maximum wait time by "Max Delay" parameter.

The main HTML element for conversion is detected automatically. It is available for API client version >= 5.5.0 and applicable for converter version >= 20.10. More Pdfcrowd versioning details.

The input HTML is automatically enhanced to improve the readability. It is available for API client version >= 5.5.0 and applicable for converter version >= 20.10. More Pdfcrowd versioning details.
Possible values:

• "none" - No enhancements are used.
• "readability-v1" - Version 1 of the enhancements is used.
• "readability-v2" - Version 2 of the enhancements is used.
• "readability-v3" - Version 3 of the enhancements is used.
• "readability-v4" - Version 4 of the enhancements is used.

Set the input data for template rendering. The data format can be JSON, XML, YAML or CSV.

Load the input data for template rendering from the specified file. The data format can be JSON, XML, YAML or CSV.

Specify the input data format.
Possible values:

• "auto" - the data format is auto detected
• "json"
• "xml"
• "yaml"
• "csv"

Set the encoding of the data file set by setDataFile.

Ignore undefined variables in the HTML template. The default mode is strict so any undefined variable causes the conversion to fail. You can use {% if variable is defined %} to check if the variable is defined.

Auto escape HTML symbols in the input data before placing them into the output.

Auto trim whitespace around each template command block.

Set the advanced data options:

• csv_delimiter - The CSV data delimiter, the default is ,.
• xml_remove_root - Remove the root XML element from the input data.
• data_root - The name of the root element inserted into the input data without a root node (e.g. CSV), the default is data.

Turn on the debug logging. Details about the conversion are stored in the debug log. The debug log is available in conversion statistics.

Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.

A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet. The value must have format DOMAIN_OR_IP_ADDRESS:PORT.

A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet. The value must have format DOMAIN_OR_IP_ADDRESS:PORT.

A client certificate to authenticate Pdfcrowd converter on your web server. The certificate is used for two-way SSL/TLS authentication and adds extra security. The file must exist and not be empty.

A password for PKCS12 file with a client certificate if it is needed.

Set the maximum time to load the page and its resources. After this time, all requests will be considered successful. This can be useful to ensure that the conversion does not timeout. Use this method if there is no other way to fix page loading. It is available for API client version >= 5.15.0 and applicable for converter version >= 20.10. More Pdfcrowd versioning details. The value must be in the range 10-30.

Specifies the User-Agent HTTP header that will be used by the converter when a request is made to the converted web page. It is available for API client version >= 6.4.0. More Pdfcrowd versioning details.
Possible values:

• "chrome-desktop" - The user-agent for desktop chrome corresponding to the converter used.
• "chrome-mobile" - The user-agent for mobile chrome corresponding to the converter used.
• "latest-chrome-desktop" - The user-agent of the recently released Chrome browser on desktops.
• "latest-chrome-mobile" - The user-agent of the recently released Chrome browser on mobile devices.
• A custom string for the user agent.

Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case. It is available for API client version >= 5.0.0 and applicable for converter version >= 20.10. More Pdfcrowd versioning details.
Possible values:

• "24.04" - Version 24.04.
• "20.10" - Version 20.10.
• "18.10" - Version 18.10.

Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.

Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.