POST

Generate Audio

Generation
3 min read

Generate complete audio track with narration and timing for the entire video.

POSThttps://api.videopilot.app/api/videos/{id}/generate-full-audio

Parameters

The following parameters are supported for this endpoint:

NameTypeRequiredDefaultDescription
idpath
stringRequired-

The unique identifier of the video

Example:"video_123abc"
voiceType
string
enum
Optional-

Override voice type for this generation

Example:"nova"
Options:echoalloyfableonyxnovashimmer
voiceProvider
string
enum
Optional-

Override voice provider for this generation

Example:"openai"
Options:openaihiggs

Code Examples

Example requests in multiple programming languages:

curl -X POST https://api.videopilot.app/api/videos/video_123abc/generate-full-audio \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "voiceType": "nova",
  "voiceProvider": "openai"
}'

Responses

Possible responses from this endpoint:

200
Audio generation started
Example Response
JSON
{
  "message": "Audio generation started",
  "jobId": "job_456"
}
400
Video scenes must be generated first
401
Authentication required
404
Video not found

Try It Out

Test this endpoint directly from your browser:

POST/api/videos/{id}/generate-full-audio
Generated cURL Command
Copy this command to use in your terminal
"text-blue-400 font-semibold">curl -X POST https://api.videopilot.app/api/videos/{id}/generate-full-audio \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
Response

Make a request to see the response here