HTML to PDF

When to Use#

User needs to call PDF API Hub endpoints ( pdfapihub.com/api/v1/...) for document automation: generating PDFs from HTML/URLs, merging, splitting, compressing, OCR, watermarking, signing, encrypting/decrypting, converting between PDF and images, parsing/extracting text and tables, or managing uploaded files.

Scope#

This skill ONLY:

• Provides endpoint reference, request/response contracts, and integration patterns for the PDF API Hub REST API
• Shows code examples in multiple languages (cURL, Python, Node.js, etc.)
• Explains authentication, error handling, and output format options

This skill NEVER:

• Executes API calls or generates files directly
• Stores or transmits API keys
• Accesses files outside the user's working directory

All code examples are reference patterns for the user to implement.

Quick Reference#

TopicFileAll endpoints & parametersendpoints.mdCode examples by use caseexamples.mdAdvanced workflowsadvanced.md

Authentication#

Every request requires the CLIENT-API-KEY header.

text

CLIENT-API-KEY: <your-api-key>
Content-Type: application/json

Get your API key at pdfapihub.com/signup.

Base URL#

text

https://pdfapihub.com/api/v1/

All endpoints use POST with JSON body.

Endpoint Map#

#CategoryEndpointPathWhat it does1DocumentGenerate PDF/generatePdfRender HTML or capture any webpage as a PDF2DocumentParse PDF/pdf/parseExtract text, tables, or structured layout data3DocumentMerge PDFs/pdf/mergeCombine multiple PDFs into one4DocumentSplit PDF/pdf/splitSplit a PDF into pages, ranges, or chunks5DocumentCompress PDF/compressPdfShrink file size (4 compression levels)6DocumentPDF Info/pdf/infoGet metadata and page info from a PDF7DocumentWatermark/watermarkOverlay text/logo watermarks on pages8DocumentSign PDF/sign-pdfStamp a signature image on PDF pages9SecurityLock PDF/lockPdfAES-256 encryption with granular permissions10SecurityUnlock PDF/unlockPdfRemove password protection11ConversionGenerate Image/generateImageCapture URL/HTML as PNG image12ConversionCompress Image/compressImageReduce image file size13ConversionPDF to Image/pdfToImageRender PDF pages as PNG/JPG/WebP14ConversionImage to PDF/imageToPdfCombine images into a PDF15OCRPDF OCR/pdfOcrExtract text from scanned PDF documents16OCRImage OCR/imageOcrExtract text from photos/images17UtilityURL to HTML/urlToHtmlFetch fully-rendered HTML via headless browser18File MgmtUpload File/uploadFileUpload a file to cloud storage19File MgmtList Files/listFilesList uploaded files20File MgmtDelete File/deleteFileDelete an uploaded file21TemplatesCreate Template/createTemplateSave a reusable HTML template22TemplatesList Templates/listTemplatesList saved templates23TemplatesDelete Template/deleteTemplateDelete a saved template

Output Formats#

Most endpoints support the output_format parameter:

ValueDescriptionurlReturns a hosted CDN URL (default)fileReturns the file as a downloadbase64Returns base64-encoded contentbinaryReturns raw binary streampdfReturns PDF file directly

Error Handling#

HTTP CodeMeaningAction400Invalid RequestCheck JSON body shape and required fields401UnauthorizedVerify CLIENT-API-KEY header422Validation FailedCheck URL/HTML/options for conflicts429Rate LimitedBack off and retry with exponential delay500Internal ErrorRetry; contact support if persistent

Common Response Shape#

json

{
  "success": true,
  "pdf_url": "https://cdn.pdfapihub.com/pdf/a1b2c3d4.pdf",
  "file_size_bytes": 84321,
  "file_deletion_date": "2026-05-04",
  "source_type": "html"
}

Core Rules#

1. Always Set output_format Explicitly#

json

{ "output_format": "url" }

Don't rely on defaults — be explicit about whether you need a URL, file, or base64.

2. Use html_content for Dynamic Documents#

json

{
  "html_content": "<h1>Invoice #{{number}}</h1>",
  "css_content": "h1 { color: #333; }",
  "dynamic_params": { "number": "INV-001" }
}

3. Use url for Webpage Capture#

json

{
  "url": "https://example.com/report",
  "wait_until": "networkidle",
  "paper_size": "A4"
}

4. Handle Files via URL or Upload#

For endpoints that operate on existing PDFs (merge, split, compress, etc.), provide files via:

• Direct URL to the PDF
• Previously uploaded file reference via the Upload File endpoint

5. Validate Responses#

Always check success: true in the response before using the result.

Common Traps#

TrapConsequenceFixMissing CLIENT-API-KEY header401 errorAlways include the headerSending both url and html_contentUndefined behaviorUse one or the otherNot setting wait_until for SPAsIncomplete captureUse networkidle for JS-heavy pagesIgnoring file_deletion_dateBroken links after expiryDownload/store files before deletionLarge HTML without paginationTimeout or huge PDFUse page_size to limit output

Security & Privacy#

• All API calls go to pdfapihub.com over HTTPS
• API keys should be stored in environment variables, never hardcoded
• Files hosted on CDN have an expiration date — download promptly
• This skill provides reference patterns only; it does not execute code or store credentials

Feedback#

• Full docs: pdfapihub.com/docs
• Get API key: pdfapihub.com/signup