Skip to content

render_video_timeline

Edit assets the user already has into ONE finished video — sequence clips, add transitions, overlay
text or logos, layer audio. This is editing, not generating new content.

Estimate with `estimate_video_timeline_price` first. The render is asynchronous; check the returned
`generation_id` with `get_generation_run`.

Pass `timeline_object_id` whenever that board timeline already exists — one you placed with
`create_canvas_timeline` or read with `read_canvas_timelines` — so the render updates it in place
instead of placing a duplicate. It is the one input `estimate_video_timeline_price` does not take,
so add it back on top of the arguments you estimated with. Omit it only when no board timeline
exists yet.

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.
timeline_object_idstring (uuid)The board timeline this render writes to. Pass it whenever that timeline already exists on the board: the template alone does not identify it, so an id-less render places a second timeline beside the existing one. Omit it only when no board timeline exists yet.