Build a video from an outline

Turns the outline into a video. Every field is optional — omit them all for the default template, no brand kit, and the root folder. Counts against the account's video creation limit. Render the result with POST /videos/render/{videoId}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Turns a finished outline into a video. Every field is optional — omit them all and you get the
default template, no brand kit, and the root folder.

This is the replacement for the retired create-by-outline enhancement.

mode

modeResult
video (default)Finished slides, ready to render immediately
storyStory-mode slides with empty header / sub-header / list / image placeholders, to fill in the story editor before rendering

Quiz drafts always produce a finished silent slide regardless of mode.

After building

The response is the created video. Render it with
POST /videos/render/{videoId}, which accepts the work and returns
immediately — watch for the video_ready or video_error webhook rather
than expecting the render outcome in an HTTP response.

🚧

This counts against your video creation limit

A 429 here is the 8-hour video quota, not a rate limit. Note that
Create an outline already consumed one, so a single prompt-to-video run
uses two.

brandKitId is validated before the video is built, so an invalid id fails the whole request
rather than producing an unbranded video.

Path Params
string
required

Id of the outline.

Body Params
string

Template to take slide visuals from. Must be published.

string | null
string

Validated before the video is built; an invalid id fails the request.

string
enum
Defaults to video

video produces finished slides ready to render. story produces story-mode slides with empty header / sub-header / list / image placeholders to fill in first. Quiz drafts always produce a finished silent slide regardless of mode.

Allowed:
Responses

mode, unknown brand kit, or an unknown field was included.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json