Render personalized preview
render_previewRender a poster image of a template filled with the user's props, in a few seconds, and return it with the editor link. Call after get_template_spec once the props are filled, and show the image to the user. Invalid props return an error that names the field to fix. If rendering is unavailable, poster is null and the editor link still works.
With loop: true it also waits for a 4-second animated WebP loop of these props and returns it as video. A loop still rendering has video: null and videoPending: true; call again with the same props to get it. loop: "start" returns the poster now and starts the loop in the background. Show the loop as an image (Markdown ) where the host renders images.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| loop | No | true waits for a 4-second animated loop of these props and returns it as video. "start" only starts it. | |
| props | Yes | The full props object from get_template_spec with edited texts, theme, and media. | |
| searchId | No | The searchId returned by search_templates. Pass it through so picks can be measured. | |
| variantId | Yes | Template id. | |
| templateVersion | No | Only for older template versions. Usually omit. |