Preview template
preview_templatePictures of a saved template's pages filled with data, to check how it looks before render_template. It does not count as a document and nothing is stored. It uses your plan's hourly preview budget, which the editor's previews share. Answers JPEG pictures of up to 4 pages and a text block with the page count and the problems: data that does not fill the template, text that does not fit its box, an item that covers text and an item past the page edge, each with its path and page. A missing field shows as ‹path› in the picture; a graphic that does not draw shows as an empty frame. Ask for later pages with first_page. Look at each picture, change the body with update_template, and preview again until it is right.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| csv | No | CSV text for each table source, keyed by the source name. The first row names the columns. | |
| dpi | No | The picture resolution. 96 shows text down to 8 pt; 144 shows smaller print. The longer side stays at most 1,568 pixels. | |
| data | No | Sample field values. Each data path of the template reads one value from here. | |
| template | Yes | The template's id or its name, as list_templates gives them. | |
| first_page | No | The first page to picture. 1 is the first page. | |
| page_count | No | How many pages to picture from first_page. |