Skip to main content
POST
Flow Music Video
flow-music-video renders one of your clips into an MP4 video from a template. Confirm live rates on the SnapGen models page. Failed tasks are not charged.
string
required
Set to flow-music-video.
string
required
The id of your earlier task that holds the source clip. It must be your own task, must have succeeded, and must come from a model listed in Source tracks.
integer
default:"1"
Position of the source clip in that task’s result.tracks, counting from 1 (up to 8).
string
default:"simple"
Video template: simple, modern, or player.
string
Optional public https URL that receives one signed event when the task finishes. See Task webhooks.
string
Required with webhook: 16 to 256 characters, used to sign the delivery.

Source tracks

The source task must be your own succeeded task from one of these models: flow-music, flow-music-extend, flow-music-replace, flow-music-cover, flow-music-upload. Send the task id as source_task_id and pick the clip with source_index. Each Flow Music task returns one clip, so source_index is normally 1. Never send provider track or clip IDs. See Reference earlier tasks.

Request

The response is HTTP 202 with a task object and a Location: /v1/tasks/{id} header. Poll GET /v1/tasks/{id} every 10 to 20 seconds until status is succeeded or failed.

Result

The MP4 URL is in result.videos[0] and result.urls[0]; result.tracks[0].video_url holds it too.
Result URLs are kept for about 72 hours. Download the files you want to keep. See Music generation tasks for the task lifecycle, result fields, webhooks, and errors.