Create video brief
create_video_briefCreate a video job from a structured brief. Specify script, captions, scenes, and target platform. Trigger async rendering and receive job and run IDs immediately.
Instructions
Create a new video job from a structured brief and trigger the render pipeline. Returns the job and run IDs immediately; rendering continues asynchronously (typically a few minutes) — poll get_job_status until draft_ready. Requires a key with write scope. To change an existing job, use edit_video_brief instead of creating a duplicate.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| steps | No | Structured steps for educational content (LaTeX) | |
| title | Yes | Short title (max 120 chars) | |
| scenes | No | Scene graph for the UniversalVideo composition | |
| script | Yes | Full narration script (sent to TTS) | |
| caption | Yes | Social caption with hooks, hashtags, CTA | |
| voiceId | No | TTS narrator voice ID. Unknown IDs are rejected before rendering; when omitted, the org's saved voice preference or the system default is used and reported in the response's resolution block. | |
| objective | Yes | Content objective (drives composition routing) | |
| directions | No | DirectionsWalkthrough 'find-us' payload: source clips (legs), decision-point cues on the realtime walk timeline, outro, and optional music. Set compositionId 'DirectionsWalkthrough' (or objective 'directions'). | |
| aspectRatio | No | Aspect ratio (defaults to 9:16 when omitted) | |
| lessonTitle | No | Display title rendered inside the video | |
| compositionId | No | Remotion composition ID override (advanced) | |
| publishTarget | Yes | Target social platform |