Fill a template and print it
render_templateFills a template with JSON data and prints it to PDF (a download link, valid 24 hours, and the edit link in the editor, where its template and data stay editable — until the person edits it on the page, which makes it a plain HTML document: then change its html). Either a gallery template (template_id from list_templates; without data it prints its sample) or your own template source. Send data in the shape of the template's sample (get_template). The language: read_guide topic "templates".
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "render_template"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | The values the template reads, in the shape of its sample data. | |
| preview | No | Pictures (PNG) of pages come with the answer, so you can check the layout, fonts and images before giving the links. Default: true. | |
| filename | No | The PDF file name. Default: the template's name or the document's <title>. | |
| template | No | Your own template source (HTML with {{ value }}, {% for %}, {% if %}), instead of template_id. | |
| template_id | No | A gallery template's id, from list_templates. | |
| preview_pages | No | Which pages to see, 1-based; -1 is the last page. Default: page 1 and the last page (a page that spilled over shows there). Up to 4, e.g. [1, 2, -1]. |
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 | ||
| guest | Yes | Printed without an account: the pages carry the ReflowPDF mark. | |
| notes | Yes | Facts about this PDF: how long its link works, its mark, what was not fetched or filled. | |
| pages | Yes | ||
| paper | Yes | Its paper, e.g. "A4", "Letter", "210 × 99 mm"; empty when unknown. | |
| title | Yes | The document's title. | |
| pdfUrl | Yes | The PDF (the same link as url). | |
| sizeKb | Yes | The PDF's size in KB. | |
| 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 | Which pages came with this answer as pictures (PNG), or why none did. | |
| filename | Yes | ||
| previews | Yes | Pages as pictures (PNG), kept with the PDF for its day. | |
| 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. | |
| missingFonts | No | Font families the document named that no face answered: their text took the next family of its list. | |
| missingVariables | No | Template values the data did not have (printed empty). | |
| skippedResources | No | Images, fonts or style sheets the server could not fetch. |