HTML to PDF

• API Endpoint: http://127.0.0.1:8080/html-to-pdf
• Method: POST
• Content-Type: application/json
• Try Online: html-to-pdf

Parameters

Name	Type	Required	Description	Default
id	String	No	Unique request identifier	UUID
text	String	Yes	HTML content to print
pdf	Object	No	PDF parameters
headerTemplate	String	No	Header
footerTemplate	String	No	Footer
displayHeaderFooter	Boolean	No	When true, header and footer will be displayed	false
generateTaggedPdf	Boolean	No	Generate a tagged PDF, useful for accessible PDFs	false
generateDocumentOutline	Boolean	No	Generate a PDF with outline. Requires generateTaggedPdf to be true	false
options	Object	No	Printing options
waitUntil	String	No	load: wait for load event domcontentloaded: wait for DOMContentLoaded event manual: wait for manual print signal	load
timeout	Long	No	Print timeout, unit: milliseconds	15000

tip

All strings support UTF-8. For complex HTML, inline CSS/JS is recommended to avoid loading delays.

Request Body

{
  "id": "43eaf69a-194a-4c0f-8e38-726f09eb24ba",
  "text": "<html><body>Hi, bkhtmltopdf.</body></html>",
  "pdf": {
    "footerTemplate": "",
    "headerTemplate": "",
    "displayHeaderFooter": false,
    "generateTaggedPdf": true,
    "generateDocumentOutline": true
  },
  "options": {
    "waitUntil": "load"
  }
}

Response Body

The API returns a PDF stream (Content-Type: application/pdf), which can be directly displayed or saved in a browser or HTTP client.

cURL

curl 'http://localhost:8080/html-to-pdf' \
  -H 'Content-Type: application/json' \
  --data-raw '{"id":"43eaf69a-194a-4c0f-8e38-726f09eb24ba","text":"<html><body>Hi, bkhtmltopdf.</body></html>","pdf":{"footerTemplate":"","headerTemplate":"","displayHeaderFooter":false,"generateTaggedPdf":true,"generateDocumentOutline":true},"options":{"waitUntil":"load"}}' \
  --output bkhtmltopdf.pdf

After execution, bkhtmltopdf.pdf will be generated in the current directory.

manual

The manual mode allows you to customize when rendering is considered complete, which is especially useful when integrating libraries like Paged.js. Add a script in your HTML to trigger it manually:

<script>
    window.addEventListener('DOMContentLoaded', () => {
        // Only takes effect when waitUntil is set to manual.
        window.print();
    })
</script>

• Mechanism: The service waits for the window.print(); log. If not received within 15 seconds, it will timeout and throw an error.
• Purpose: Ensures JS/CSS pagination is complete, preventing incomplete page printing.
• Note: Only effective when waitUntil: "manual" is set.