AI Clipper: analyse a long video (async)
start_clipperAI Clipper step 1/2: analyse a long video (podcast, interview, stream, show) from a link or upload and propose up to max_clips self-contained viral clips. Costs 6 credits per started 30 minutes of source (refunded if it fails). Returns plan_id immediately; analysis takes a few minutes — poll get_clip_plan until status is "ready", then call generate_clips (2 credits per clip).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | Public video link (YouTube, TikTok, Instagram, Facebook, X, Vimeo…) or a direct https link to a video file (.mp4, .mov, .webm, .m4v). | |
| music | No | "none" (default), "auto" or a Brand Kit music id (list_brand_assets). | |
| layout | No | Framing: auto, focus (speaker: tight crop on the main face, follows it), general (wide), split (two people stacked), screen (the whole picture on a framed panel, for screen recordings). | |
| headline | No | Headline card on each clip (default true). | |
| language | Yes | Language of captions and headlines. | |
| max_clips | Yes | How many clip candidates to find (up to the plan limit). | |
| upload_id | No | Id of a file uploaded with POST /api/v1/uploads, or of an image given to import_image. | |
| trim_pauses | No | Cut the long pauses (over 0.7 s of silence) out of each clip (default false). | |
| caption_style | No | Caption style (default highlight_box). | |
| logo_asset_id | No | Logo burned into the video: a logo id from list_brand_assets, or null for no logo (default: the Brand Kit default logo, if one is set). | |
| target_seconds | Yes | Target clip length in seconds (15–90). | |
| idempotency_key | No | Optional unique key (e.g. a uuid) — repeating the same call with the same key within 24 h returns the first result instead of charging again. |