render_image
Renders images, PDFs, or videos from a RenderForm template by merging dynamic content. Provide a template ID and data to customize the output.
Instructions
This tool renders an image, PDF or video from a RenderForm template.
Provide 'template' (required): the template ID, e.g. template_1234.
Provide 'data' to merge dynamic content into the template. Keys follow the 'componentId.property' convention (e.g. { "my-text.text": "Hello World!", "my-image.src": "https://example.com/image.jpg" }).
Component IDs and editable properties can be discovered with the 'get_template' tool (see the 'properties' field of the template).
Optionally provide 'fileName', 'webhookUrl' (called when the render finishes), 'version' (cache key - reusing it returns a cached result instead of re-rendering), 'metadata' (passed through to the webhook), 'batchName' (to group renders together) and 'waitTime' (delay before rendering, max 5000ms).
Use 'output: json' (default) to get back a JSON object with the href of the rendered file. Avoid 'output: image' here since it returns raw binary bytes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | Data to be merged into the template. Keys follow the 'componentId.property' convention, e.g. { 'my-text.text': 'John' }. | |
| output | No | Output format. 'json' (default) returns a JSON object with the href of the rendered file, which is recommended here. 'image' returns raw image bytes and is not suitable for text responses. | |
| version | No | Cache key used for caching the rendered output. Reusing the same version returns the cached file. | |
| fileName | No | Name of the file to be returned (without extension). | |
| metadata | No | Additional metadata to be passed to the webhook. | |
| template | Yes | Template ID to render, e.g. template_1234. | |
| waitTime | No | Wait time in milliseconds before rendering (max 5000). | |
| batchName | No | Batch name used for grouping renders together. | |
| webhookUrl | No | Webhook URL to be called when the render is done. |