Merge a clip into a UGC ad
merge_adCombine a completed clip with an app screen recording and hook text overlay to create the final UGC ad. Upload files first, then poll the ad's status until completion.
Instructions
Merge a completed clip with an app screen recording and a hook text overlay (plus optional background music) into the final UGC ad. Same as clipugc videos merge <clipId>. The clip must have status "completed" (check with get_video). Merging is free at the time of writing; the live cost is the "merge" entry of get_credits. Files are uploaded first. Returns merged_video_id: the AD id, which is a different id space from the clip id. The merge renders in the background. Poll get_video with {"id": , "kind": "ad"} every 5 to 10 seconds until status is "completed" or "failed", then call download_video with kind "ad".
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hook | Yes | Hook text overlaid on the video, max 150 chars (same as --hook). | |
| music | No | Local path of background music, mp3/wav/m4a (same as --music). | |
| video | Yes | Clip (character video) id, as returned by other tools (numbers are fine as strings). | |
| app_video | Yes | Local path of the app screen recording, mp4/mov (same as --app-video). |