Create Narration
Narrate a video with a chosen voice, from your script or a generated one.
project_name, project_description and folder_id.
Point video_url at the video and set video_type to say what it is. Supply script_file_key to narrate a script you have written, or omit it to have one written for you. narration_type picks between reading a script (narration) and describing what is on screen (audio_description). narrator_voice_id chooses the voice, and remove_fg_audio decides whether the original foreground audio stays under the narration.
Track progress by polling /narration/{task_id} with the task_id returned in the response.Authorizations
The x-api-key is a custom header required for authenticating requests to our API. Include this header in your request with the appropriate API key value to securely access our endpoints. You can find your API key(s) in the 'API' section of our studio website.
Headers
Body
Video to narrate, as a public or bucket URL.
Where video_url points.
0, 1, 2, 3 Language spoken in the video.
Voice that reads the narration.
3 - 2553 - 5000x > 0NARRATION reads a script; AUDIO_DESCRIPTION describes what is on screen.
narration, audio_description Platform video id. Derived from video_url when omitted.
Bucket key of a narration script. Omit to have one written.
Drop the original foreground audio under the narration.
Dictionaries applied to the narration.
Speech model used to read the narration. Same choices as the /tts-stream API (e.g. mars-pro, mars-81, mars-81-flash, mars-instruct). Omit to let the system choose automatically.
mars-pro, mars-81, mars-8.1-pro-beta, mars-8.1-flash-beta, mars-81-flash, mars-flash, mars-instruct, mars-x-instruct, mars-x.b-instruct Response
Successful Response