Options & Hosting
PDF rendering options and document hosting configuration, accepted by/convert,/render, and/compose.
Rendering options
| Field | Default | Description |
|---|---|---|
page_size | A4 | A4, Letter, Legal, Tabloid, A3, A5, or WxH in mm |
orientation | portrait | portrait or landscape |
margins.top | 20mm | Top margin (CSS units: mm, in, pt, cm) |
margins.right | 15mm | Right margin |
margins.bottom | 20mm | Bottom margin |
margins.left | 15mm | Left margin |
header_html | — | HTML header on every page (Puppeteer only) |
footer_html | — | HTML footer on every page (Puppeteer only) |
javascript | false | Execute JS before rendering (auto-selects Puppeteer) |
javascript_delay | — | Wait N ms after page load for JS |
tagged | false | Tagged PDF for accessibility (Rust only) |
pdf_profile | — | PDF/A conformance: 1b, 2b, 3b (Rust only) |
Hosting options
Enable document hosting to get a public download link. The document is accessible at /d/{token}.
| Field | Type | Description |
|---|---|---|
hosting.enabled | boolean | Enable hosted download link |
hosting.download_limit | number | Max downloads before returning 410 |
hosting.expires_in | number | Seconds until the link expires |
hosting.password | string | Password-protect the download page |
Engine selection
The Rust engine is used by default. Puppeteer is selected automatically when any of these options are set:javascript: true,header_html,footer_html, orsource: "url". Override explicitly with "engine": "puppeteer".