Sign in

v1

latestOpenAPI 3.1.02026-07-1371123.3 KB
Podcasts

Generate AI-scripted podcast with 2 hosts using Convo Mode

Starts a background job that creates an AI generated script and produces an audio file in convo mode. The response contains a job_id that can be used with the /podcast/{job_id} endpoint to query for status. Requires a valid X-API-TOKEN header.

**Note that generating via Convo Mode yields more natural results but takes longer.
Expect at least 1 minute of processing per minute duration of audio before investigating a potential failure.**

Throws:
- 429 if the user has too many jobs in flight.
- 400 if any voice_ids provided are invalid or if the length of voice_ids is not 2.
post/podcast/convo-mode/ai-scripted

Request body

promptstring required

The prompt to instruct the AI to generate the script. You can specify the duration, and include links. Sometimes, the AI hallucinates, so it helps to mention that this podcast has two hosts.

voice_idsstring[]

A list of voice_ids to use for the generated audio. Must provide exactly 2 voices for this endpoint. If the script has multiple speakers, we will use the voices from this list in the order they appear in. All ids in this list must be unique. If no IDs are provided, 2 defaults will be used.

delivery_instructionsstring nullable

An optional delivery instructions for the generated audio. This will be used to guide the generation of the audio.

Response

Successful Response

job_idstring uuid required

The job ID for the episode generation. The status of this job can be queried using the/podcast/{job_id} endpoint.