Quote a music video
quote_music_videoRead-onlyIdempotent
The exact credits for an AI music video, before anything is charged. Returns quote_id, credits and a breakdown; the price follows the section's length (clips of about 15 seconds). The song's artist performs it, so the artist needs photos. Always quote first and tell the user the credits before creating; credits are reserved at creation and charged only when the video is delivered.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cast | No | The two photos the artist is kept from: face_photo_id (a sharp face, mouth visible) and outfit_photo_id (the outfit and body worn throughout); either left out, the director picks it. One photo can be both; hidden photos (add_artist_photos hidden) work too | |
| trim | No | Perform only this section of the song (15 seconds to 10 minutes); omitted, the whole song (15 seconds to 10 minutes long). The price follows its length. Best: a part from get_song_analysis (parts[]: its start and end never cut a word) | |
| model | No | The music video model: one-take (default; one continuous, lip-synced take of the artist). get_options lists the models with the categories, styles, formats and length each makes | one-take |
| style | No | Optional look: natural, film, golden-hour, neon-night, noir, vintage or dreamy. Omit it and the director picks one from the cover | |
| scenes | No | Where it is set besides the places the direction mentions from the kit: {"mode":"invent"} (default: the director imagines the others) or {"mode":"stock"} (it finds a real stock photo of each place it writes, empty of people, and the artist is put into it), up to the model's kit.places in all | |
| plan_id | No | Make the video from this plan (plan_music_video): its brief replaces the one sent, so send song_id and plan_id. Omitted, the director plans it while it is made | |
| quality | No | The resolution it is made at: one of the qualities get_options lists for the model (768p by default; 1080p is the same video sharper for about twice the credits); not part of the plan, so a plan is made in any quality. get_options lists each model's qualities with about how long each takes; credits.music_video.models has a minute by model and quality | 768p |
| song_id | Yes | The song; its artist performs the video and needs photos (add_artist_photos) | |
| category | No | performance (default: sings to camera in one place), intercut (performance cut against the artist living the song's story), cinematic (a moving camera through a location), story (acts out the song's story in one take) or surreal (the world transforms with the song). get_options lists the ones each model makes | performance |
| metadata | No | Your own JSON (an order id, for example): kept with the video and returned in its request. Quote and create with the same value | |
| direction | No | Optional notes for the director (a place, an era, a story idea, a mood). Mention kit pieces by @handle (list_kit): "@nina-kazora in the @blue-set on the @rooftop, the @chrome-mic in hand"; a mentioned piece is used exactly as it is and the director designs the rest. An unknown handle answers 400 | |
| variations | No | 1–4 different music videos | |
| lookbook_id | No | A lookbook (design_music_video_shoot) whose kept, drawn pieces the video uses like the kit pieces the direction mentions; its idea leads the director | |
| aspect_ratio | No | The one format of the file: "9:16" (default, vertical), "16:9" (wide) or "1:1" (square) | 9:16 |
| callback_url | No | An https URL to POST the finished video to (signed; see Callbacks). Quote and create with the same value |