Print HTML to PDF
render_pdfLays out a whole HTML document (with its CSS) as paged print and returns a download link to the PDF, valid 24 hours, and the document's edit link in the ReflowPDF editor (give the person both). Use @page for paper and margins, margin boxes for headers, footers and page numbers; JavaScript does not run. Read read_guide topic "html" before the first document. To change the document later, use update_document with its document_id.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| html | Yes | The whole HTML document: <!doctype html>, <html lang>, a <title>, a <style> in <head> with @page. Self-contained; images and fonts by https URL, data: URI or an upload_image link. | |
| preview | No | A picture (PNG) of page 1 comes with the answer, so you can check the layout, fonts and images before giving the links. Default: true. | |
| filename | No | The PDF file name, e.g. "invoice-1042.pdf". Default: the document's <title>. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The link, valid 24 hours. | |
| mark | Yes | Whether the PDF carries the ReflowPDF mark, and why. | |
| bytes | Yes | ||
| notes | Yes | What to tell the person about this PDF. | |
| pages | Yes | ||
| timing | No | The engine's own parts of it, when it states them: layoutMs (styles, layout and pagination) and writeMs (writing the PDF). | |
| editUrl | No | The document in the ReflowPDF editor: the person edits it there (the link is the document; it lasts while it is used). | |
| preview | No | What picture of the PDF came with this answer (page 1, as PNG), or why none did. | |
| filename | Yes | ||
| renderMs | No | How long the print took on the server, in milliseconds (the engine and its adapter). | |
| revision | No | Its revision: name it to update_document as base_revision. | |
| expiresAt | Yes | When the link stops working (ISO 8601). | |
| documentId | No | The document, for get_document and update_document. | |
| missingVariables | No | Template values the data did not have (printed empty). | |
| skippedResources | No | Images, fonts or style sheets the server could not fetch. |