Endpoint Examples
Create an episode with a user provided script
Starts a background job to produce an audio file with the provided script segments. The response
contains a job_id
that can be used to query with the /podcast/{job_id}
to query for status.
Requires a valid X-API-TOKEN
header.
Throws:
- 429 if the user has too many jobs in flight.
- 400 if any voice_id or music_id provided is invalid
POST
/
podcast
/
scripted
Authorizations
X-API-KEY
string
headerrequiredBody
application/json
A request to start a job to generate a podcast episode with a provided script.
script
object[]
requiredThe segments forming the script for the episode
music_spec
object | null
An optional spec for adding background music to the generated script. Note that if the chosenmusic track is longer than the duration of the generated script, it will be cut off.
Response
200 - application/json
job_id
string
requiredThe job ID for the episode generation. The status of this job can be queried using the/podcast/{job_id}
endpoint.