Plan the edit of the user's own video
plan_video_editIgnix's video editor, with this brand's context: from the TRANSCRIPT of the user's own video (each word with its times) it decides the hook title, captions and emphasised words, zooms, on-screen texts and numbers, emojis, sound effects from the Ignix library, b-roll from the user's files, cuts (only if asked), the end card, and the post caption with hashtags. Returns it anchored to word indices and as a timeline in seconds. Up to 10 minutes of video. Spends 45 AI credits per started minute. OPTIONAL: by default you decide the edit yourself following get_edit_playbook (free) — call this only when the user asks for Ignix's editor. To get several short clips out of a long video use plan_clips instead. SPENDS AI CREDITS ONLY WITH confirm: true. Call it first without confirm: nothing runs and nothing is charged, you get the quote (what it will do and the credits). Tell the user, in your own words, exactly that — including the options you chose, so they can change them — and wait for a clear yes before calling again with the same arguments and confirm: true. One yes covers the plan they approved (e.g. every line of an approved voice-over with the chosen voice); anything new or different needs a new yes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| broll | No | The user's own photos or clips that can be shown over the video: { ref: "b1".., kind: image|video, durationSec?, description }. | |
| words | Yes | Every word in order: { t: the word, s: start second, e: end second }. Up to 1800 words. | |
| format | No | Aspect ratio of the result, default 9:16. | |
| confirm | No | true ONLY after the user said yes to the quote (what it does and the credits). Without it nothing runs and nothing is charged. | |
| request | Yes | What the user asked for, in their words (e.g. "subtitles and a strong hook, remove the repeats"). | |
| language | No | Two-letter language of what is said (es, en…). Optional. | |
| platform | No | Network it is for (instagram, tiktok…). | |
| cutsAllowed | No | True only if the user asked to tighten it (cut retakes, false starts, tangents). | |
| durationSec | Yes | Length of the video in seconds (max 600). | |
| workspaceId | No | Workspace to work on (an id from list_workspaces). Not needed when this connection is tied to one workspace, or when you pass an account: the account's workspace is used. | |
| idempotencyKey | No | Optional. A unique id for this action (16-128 chars: letters, digits, _ : . -). If you are unsure whether a call went through (timeout, network error), repeat it with the SAME idempotencyKey and the same arguments: you get the original result and nothing is done twice. |