Create video render
create_renderQueue a video render by providing a full project JSON or a template ID. Returns a jobId to poll for completion.
Instructions
Queue a video render. Provide either a full project JSON as payload or a template ID (optionally with variables). Returns a jobId to poll with get_render. Credits are reserved up front. For NEW creative content do not hand-compose the payload: run plan_creative_video (or find_matching_examples) first and adapt a library example via start_from_example, then validate_project_json before rendering.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| payload | No | Full Zvid project JSON (scenes, elements, output settings). Call get_project_schema for the JSON Schema, list_supported_elements / get_element_docs for element docs, and validate_project_json BEFORE rendering. | |
| template | No | Template ID, e.g. "tpl_AbC123..." (20 chars after the prefix) | |
| overrides | No | Optional output overrides applied on top of the payload/template. | |
| variables | No | Template variable values, keyed by variable name. | |
| webhookUrl | No | Optional per-job webhook URL notified on render.completed / render.failed. |