Skip to content

render_video_timeline

Compose assets the user already has into ONE finished video and return immediately with a handle.

This is the video editor: stitch or sequence clips, add transitions, overlay text/logos/CTAs, layer
audio, arrange side-by-side or picture-in-picture, repeat a clip. Use it for any such edit — composing
existing assets is distinct from generating new content with `execute_forge` or a workflow.

Call `estimate_video_timeline_price` with the same timeline first to learn the price, and confirm with
the user before rendering when it is high. Do not ask the user about optional editing details (clip
trimming, audio mixing, transition timing) — pick sensible defaults, render, and say what you chose.

Rendering is asynchronous and produces exactly one video. Check the returned `generation_id` with
`get_generation_run`.

Parameters

ParameterTypeDefaultDescription
workspace_idrequiredstring (uuid)The user's workspace id.
session_idstring (uuid)The Session ID to attach the results to.
session_namestringCreates a new session with this name. One of `session_name` or `session_id` must specified, but not both.
templaterequiredTimelineTemplateTimeline layout designed in the editor. Tracks, items, timing, and slot references.
tracksTimelineTemplateTrack[]Ordered list of tracks in the timeline. Composited in reverse order (Track 1 is on top). Do not overlap items within the same track; use multiple tracks for overlapping content.
idrequiredstringUnique identifier for the track.
namerequiredstringUser-facing name of the track.
itemsrequiredany[]Ordered list of items on this track.
transitionsany[]Transitions on the seams between adjacent items on this track.
disabledbooleanfalseWhether the track is excluded from rendering.
fpsinteger≤120, >030Frames per second of the output video.
widthinteger2–76801920Width of the output video, in pixels. Must be even.
heightinteger2–43201080Height of the output video, in pixels. Must be even.
codecstringh264Video codec for encoding the output. Only h264 is supported.
crfinteger0–5118Constant Rate Factor controlling output quality. Lower values produce higher quality.
max_duration_in_secondsnumber≤120, >0Maximum allowed duration of the rendered video, in seconds.
playback_ratenumber≤4, >01Global playback speed multiplier. 1.0 = normal, 2.0 = double speed, 0.5 = half speed.
videosobjectSlotted video assets. Each slot name matches a slot reference in the timeline template.
imagesobjectSlotted image assets. Each slot name matches a slot reference in the timeline template.
audiosobjectSlotted audio assets. Each slot name matches a slot reference in the timeline template.