# HTML-to-PDF API Convert HTML content or URLs to PDF documents using headless Chromium. Supports custom paper formats, margins, headers/footers with page numbers, landscape mode, and CSS page sizes. Returns either raw PDF binary or base64-encoded JSON. Perfect for invoices, reports, and document exports. ## Endpoint `POST /api/html-to-pdf` ## Authentication All requests require the `X-RapidAPI-Proxy-Secret` header (handled automatically by RapidAPI). ## Request Body | Field | Type | Required | Description | |-------|------|----------|-------------| | `html` | string | Conditional* | Raw HTML content to convert. Required if `url` not provided. | | `url` | string | Conditional* | URL to fetch and convert. Must be absolute HTTP(S). Required if `html` not provided. | | `outputFormat` | string | No | Set to `"base64"` for JSON response. Default returns raw PDF binary. | | `options` | object | No | PDF generation options (see below) | \* Either `html` or `url` must be provided, but not both. ### PDF Options | Field | Type | Default | Description | |-------|------|---------|-------------| | `options.format` | string | `A4` | Paper format: `A3`, `A4`, `A5`, `Letter`, `Legal`, `Tabloid`, `Ledger` | | `options.landscape` | boolean | `false` | Landscape orientation | | `options.printBackground` | boolean | `true` | Include background graphics | | `options.preferCssPageSize` | boolean | `false` | Prefer CSS-defined page size over `format` | | `options.scale` | number | `1.0` | Webpage rendering scale (0.1–2.0) | | `options.marginTop` | string | `"0.4in"` | Top margin (CSS value, e.g., `"60px"`, `"0.4in"`) | | `options.marginRight` | string | `"0.4in"` | Right margin | | `options.marginBottom` | string | `"0.4in"` | Bottom margin | | `options.marginLeft` | string | `"0.4in"` | Left margin | | `options.headerTemplate` | string | — | HTML template for page header. Supports `` and `` | | `options.footerTemplate` | string | — | HTML template for page footer. Supports page number placeholders. | ### Example Request ```json { "html": "<html><body>

Invoice #1234

Total: $99.99

</body></html>", "outputFormat": "base64", "options": { "format": "A4", "marginTop": "60px", "marginBottom": "60px", "footerTemplate": "

Page of

" } } ``` ## Response When `outputFormat` is `"base64"`, returns JSON: | Field | Type | Description | |-------|------|-------------| | `base64` | string | Base64-encoded PDF data | | `mimeType` | string | Always `application/pdf` | | `sizeBytes` | integer | PDF file size in bytes | | `pages` | integer | Number of pages in the PDF | ### Example Response (base64 mode) ```json { "base64": "JVBERi0xLjQKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZyAv...", "mimeType": "application/pdf", "sizeBytes": 245760, "pages": 3 } ``` When `outputFormat` is omitted, returns raw PDF binary with `Content-Type: application/pdf`. ## Constraints | Constraint | Value | |------------|-------| | Rendering engine | Headless Chromium (PuppeteerSharp) | | Default paper size | A4 | | Default margins | 0.4in all sides | | Architecture | Stateless — no data persisted | ## Error Responses | Status | Condition | Message | |--------|-----------|---------| | 400 | Missing html and url | `Either 'html' or 'url' must be provided.` | | 400 | Invalid URL | `URL must be an absolute HTTP(S) URL.` | | 400 | Timeout | `Page load timed out.` | | 401 | Unauthorized | Missing or invalid API key | ## Use Cases - **Invoice Generation** — Generate professional PDF invoices from HTML templates - **Report Export** — Convert dashboards and analytics pages to downloadable PDFs - **Document Archiving** — Snapshot web pages as PDF documents for compliance or records - **Print Layouts** — Create print-ready documents with custom headers, footers, and page numbers ## More Information For full documentation, code examples in cURL/JavaScript/Python/C#, and integration details, visit the [HTML-to-PDF documentation](https://api.atomicapis.dev/pages/api-09-html-to-pdf.html).