Render a video
tourwright_renderQueue a script to render a narrated product tour video; wait for ready links, duration, chapters, and captions, or return a job ID for polling.
Instructions
Queue a script for rendering. With wait=true (default) it waits until the video is ready and returns its links (and local paths), duration, chapters and captions; otherwise it returns the job id to poll with tourwright_job.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| vars | No | Values for the script variables ({{name}}): the same script makes a different video per set of values | |
| wait | No | Wait for the video (default true); false returns the job id at once, to poll with tourwright_job | |
| assets | No | Files the script refers to by name (images, music, uploads), base64-encoded | |
| script | Yes | The script: an object, or YAML/JSON text. Read tourwright_guide first for the format. | |
| options | No | Render settings that override the script | |
| waitSeconds | No | How long to wait for the video before returning the job as it is (default 900) |