Skip to content
ComPDF
New Release

Open-Source PDF SDK & AI Document Processing

Get the full self-hosted SDK and AI document processing on GitHub. One-click deploy to quickly build your document workflows.

PDF Generation API

Generate PDF files from an HTML file, HTML string, HTML URL, or an HTML template with JSON data.

HTML to PDF

ItemValue
Request URLPOST http://localhost:8080/api/v1/process/pdf/generation/html-to-pdf
Authenticationx-api-key: your_api_key_here
Request Typemultipart/form-data
Success ResponsePDF file stream

Parameters

FieldTypeDescriptionRequired
htmlFileFileHTML file. Mutually optional with request.html or request.htmlUrl.No
request.htmlStringHTML string.No
request.htmlUrlStringHTTP/HTTPS HTML URL.No
request.baseUriStringBase URI for relative resources.No
request.pageSizeObjectPage width and height in pt.No
request.outputFileNameStringOutput file name.No

curl Example

bash
curl -X POST "http://localhost:8080/api/v1/process/pdf/generation/html-to-pdf" \
  -H "x-api-key: your_api_key_here" \
  -F "[email protected]" \
  -F 'request={"pageSize":{"width":595,"height":842},"outputFileName":"report.pdf"}' \
  -o report.pdf

Template to PDF

ItemValue
Request URLPOST http://localhost:8080/api/v1/process/pdf/generation/template-to-pdf
Authenticationx-api-key: your_api_key_here
Request Typemultipart/form-data
Success ResponsePDF file stream

Parameters

FieldTypeDescriptionRequired
templateFileFileHTML template file. Mutually optional with request.template.No
dataFileFileJSON data file. Mutually optional with request.data.No
request.templateStringHTML template string.No
request.dataObject/StringTemplate data.No
request.baseUriStringBase URI for relative resources.No
request.pageSizeObjectPage width and height in pt.No
request.outputFileNameStringOutput file name.No

curl Example

bash
curl -X POST "http://localhost:8080/api/v1/process/pdf/generation/template-to-pdf" \
  -H "x-api-key: your_api_key_here" \
  -F "[email protected]" \
  -F 'request={"data":{"invoiceNumber":"INV-001","customer":"Acme"},"outputFileName":"invoice.pdf"}' \
  -o invoice.pdf