Render Video Template
clipform_render_video_templateRender a curated video template (a pre-arranged Scene: bed + overlay + sane defaults) to MP4 or PNG from a small controls object, instead of hand-assembling Scene layers. Call clipform_list_video_templates first for available template names and their controls. Renders through the Scene composition under the hood.
Choosing a render tool: for a recognisable form/quiz beat (guess-the-city, this-or-that, mystery reveal, multiple choice, photo montage...) reach for a video template first (clipform_list_video_templates + clipform_render_video_template) - it is a one-call recipe. Use clipform_generate_video for a narrated or audio-synced media montage (images/clips timed to a voice track). Use clipform_render_composition only when neither fits and you need a custom layer stack. A render for a form node is not done until it is attached to that node. Pass node_id (and form_id) so the completed render attaches itself automatically - do not poll clipform_check_render to completion or manually chain clipform_upload_media_asset + clipform_attach_node_media; fire the render and move on.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| wait | No | true (default) blocks until the render is ready and returns its URL; false returns a job ID for clipform_check_render. | |
| context | Yes | Describe the user's underlying goal in one sentence - not the tool you're calling. | |
| form_id | No | The form UUID (required when node_id is set). | |
| node_id | No | Form node to attach this render to automatically once it completes - skips the manual clipform_upload_media_asset + clipform_attach_node_media steps and republishes the form if it's currently live. Requires form_id. | |
| captions | No | Word-level captions from clipform_generate_tts - carried onto the attached media asset. Only used when node_id is set. | |
| controls | Yes | Template-specific controls (see clipform_list_video_templates for the exposed control surface). | |
| template | Yes | Video template name (see clipform_list_video_templates). | |
| outputFormat | No | Output format (default: mp4) | mp4 |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| job_id | No | Present when status is 'rendering' - pass to clipform_check_render | |
| status | Yes | ||
| attached | No | True when node_id was provided and the render was attached to the node automatically (present once the attach outcome is known). | |
| template | No | ||
| public_url | No | Present when status is 'complete' - attach via upload_media_asset then attach_node_media (fit_media: true), unless node_id was set (auto-attached) | |
| republished | No | True when the form was live and was republished to include this media. | |
| attach_error | No | Present when node_id was provided but auto-attach failed - the render itself still succeeded. | |
| output_format | No | ||
| media_asset_id | No | The workspace media asset created from this render, when attached. |