HTML to PDF API parameters — every parameter, on one page.

Your API license key.

The URL of the web page that is converted to PDF. URL-encoded.

The raw HTML that is converted to PDF. Pair with base_url to resolve relative paths.

Optional base URL used together with html to resolve relative paths from the HTML string.

Specifies the page size of the generated PDF document. If set to Custom, supply page_width and page_height.

Custom page width in points (1pt = 1/72 inch). Used only when page_size is Custom.

Custom page height in points (1pt = 1/72 inch). Used only when page_size is Custom.

Page orientation of the generated PDF document.

Top margin of the generated PDF document, specified in points.

Right margin of the generated PDF document.

Bottom margin of the generated PDF document.

Left margin of the generated PDF document.

Controls whether a custom header is displayed in the generated PDF document.

Height of the PDF document header.

URL of the web page that is converted and rendered in the PDF document header.

Raw HTML that is converted and rendered in the PDF document header.

Optional base URL used together with header_html to resolve relative paths.

Visibility of the header on the first page of the PDF document.

Visibility of the header on odd-numbered pages.

Visibility of the header on even-numbered pages.

Width used by the converter's internal browser window during header conversion.

Height used by the converter's internal browser during header conversion. 0 means automatic.

Controls whether a custom footer is displayed.

Height of the PDF document footer.

URL of the web page rendered in the footer.

Raw HTML rendered in the footer.

Base URL used together with footer_html.

Visibility on the first page.

Visibility on odd-numbered pages.

Visibility on even-numbered pages.

Force the footer to appear on the last page (useful when last-page footer differs from the rest).

Internal browser width during footer conversion.

Internal browser height during footer conversion. 0 means automatic.

Display the current page number in the footer of each PDF page.

Page number for the first rendered page.

Total-pages offset in the generated PDF.

The text used to display the page numbers. Supports {page_number} and {total_pages} placeholders.

Font used to display the page-numbers text.

Font size of the page-numbers text.

Alignment of the page-numbers text.

Color of the page-numbers text in RGB HTML format.

Vertical position (in points) where the page-numbers text is rendered in the footer.

PDF document title.

Subject of the PDF document.

PDF document keywords.

Name of the PDF document author.

Save the creation date and time in the PDF document information.

Page layout used when the document is opened. 0 — Single Page · 1 — One Column · 2 — Two Column Left · 3 — Two Column Right.

Document page mode. 0 — None · 1 — Outlines · 2 — Thumbs · 3 — Full Screen · 4 — OC · 5 — Attachments.

Position the document window in the center of the screen.

Display the document title in the viewer's title bar.

Resize the document window to fit the size of the first page.

Hide the PDF viewer application's menu bar.

Hide the PDF viewer application's toolbar.

Hide UI elements (scroll bars, navigation), leaving only the document content.

Password required to view the generated PDF document.

Password required to view or modify the PDF document.

Name of the PDF document that will be created.

Background color of the PDF page in RGB HTML format.

Render the web-page background in the PDF.

Use an enhanced custom page-breaks algorithm. Slightly slower but prevents hidden text when custom page breaks are used.

Resize the PDF page to fit all the content in a single page.

Produce a tagged, accessible PDF: a logical structure tree covering headings, paragraphs, lists, tables, figures with alternate text, links and reading order. Requires engine=Blink or engine=Chromium; when no engine is specified the request is promoted to Chromium and the engine used is returned in the X-SelectPdf-Engine response header. Also forces viewer_display_doc_title, which accessible PDF requires.

PDF conformance target. full — the complete PDF feature set · pdfa, pdfa2b, pdfa3b, pdfa3u — long-term archiving levels · pdfa3a — the accessible level of PDF/A-3, which implies a tagged document and so carries the same engine requirement as tagged · pdfx — graphics exchange · pdfsiqq_a, pdfsiqq_b — digital-signature profiles.

Natural language of the document, for example en-US or de-DE. Written as the PDF /Lang entry and onto tagged structure elements.

The invoice XML, uploaded as a multipart file part. Only its content is used — the name recorded inside the PDF is the one the standard prescribes (factur-x.xml, or xrechnung.xml for the XRECHNUNG profile), because recipients look it up by name.

How much of the EN 16931 semantic model the embedded XML carries. minimum and basic_wl are not complete invoices. xrechnung is the German public-sector profile.

How the XML relates to the visible invoice page. Defaults to alternative for minimum and basic_wl, where the page carries more than the XML, and data for the rest, where both carry the same content — which is mandatory in Germany for basic, en16931, extended and xrechnung. minimum or basic_wl combined with data is rejected.

Metadata schema identifying the invoice. zugferd20 is deprecated and only for recipients that still require it.

Width used by the converter's internal browser window.

Height used by the converter's internal browser. 0 means automatic. Whether the content below this height is left out is controlled by web_page_fixed_size.

Leave out the content below web_page_height instead of letting the page flow onto further pages. When not set, each engine keeps its long-standing behaviour: WebKit and WebKit Restricted leave it out whenever web_page_height is set, Blink and Chromium convert the whole page. Pass True or False to choose explicitly. Needs a non-zero web_page_height - with 0 there is no height to fix the page at and this is ignored. With WebKit a fixed size also cuts off content wider than web_page_width.

Delay before conversion to allow the page to fully load. Increase for pages that take time to render.

Maximum time the converter waits for the page to load. Up to 120 seconds.

If the page does not finish loading within max_load_time, generate a PDF from the partially loaded content instead of returning an error.

TLS/SSL protocol used when fetching the page. 0 means Automatic — the protocol is negotiated with the server.

Rendering engine used for the conversion.

HTTP cookies for the web page being converted, as querystring-encoded name/value pairs.

HTTP cookies for the web page being converted, as a JSON object — for JSON requests.

Username for HTTP Basic authentication on the source page.

Password for HTTP Basic authentication on the source page.

Use the CSS Print media type instead of Screen.

Do not run JavaScript in web pages.

Do not create internal links in the PDF.

Do not create external hyperlinks in the PDF.

Avoid breaking images between PDF pages.

Scale images during the conversion process.

Conversion startup mode. Automatic — start as soon as the page loads. Manual — start by calling SelectPdf.startConversion() from within the page.

Response Content-Type. 0 — binary/octet-stream · 1 — application/pdf.

Generate automatic PDF bookmarks. Use a CSS selector — "H1" for all H1, "*.myclass" for all elements with .myclass, "*#myid" for the element with id myid.

Exclude page elements from the conversion. Same selector syntax as pdf_bookmarks_selectors.

Convert only a specific section of the web page. The section is specified by the HTML element ID — image, table, table row, div, text, anything.

Retrieve the PDF coordinates of HTML elements that match the supplied CSS selectors. Returned in the X-SelectPdf-Web-Elements response header as base64-encoded JSON.

Submit the conversion asynchronously. The endpoint returns HTTP 202 with the job ID in the X-SelectPdf-Job-Id header; poll /api2/asyncjob/ to retrieve the PDF.

Engine-level URL handling toggle. When True, the converter treats the URL as already decoded; set to False if your URL contains characters that must be URL-decoded before fetching.

Alternative to multiple form-data fields — pass a JSON object containing all parameter values as a single field. The controller deserializes it into ConvertParameters and then uses the same processing path. Convenient for SDKs and callers that prefer one-shot JSON over many key/value pairs. Silently dropped by the /api2/convert/demo/ endpoint.

The job ID returned by an asynchronous conversion submission (in the X-SelectPdf-Job-Id response header).

Retrieve conversion history for past months alongside the current subscription state.