Generate podcast with 2 hosts using Convo Mode, with a user provided script

curl --request POST \
  --url https://api.wondercraft.ai/v1/podcast/convo-mode/user-scripted \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "script": [
    {
      "text": "<string>",
      "voice_id": "<string>"
    }
  ],
  "delivery_instructions": "<string>",
  "music_spec": {
    "music_id": "<string>",
    "fade_in_ms": 0,
    "fade_out_ms": 0,
    "playback_start": 0,
    "playback_end": 123,
    "volume": 0.05,
    "loop": false
  }
}
'

{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Endpoint Examples

Generate podcast with 2 hosts using Convo Mode, with a user provided script

Starts a background job to produce an audio file with the provided script segments in convo mode. 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.

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

user-scripted

Generate podcast with 2 hosts using Convo Mode, with a user provided script

curl --request POST \
  --url https://api.wondercraft.ai/v1/podcast/convo-mode/user-scripted \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "script": [
    {
      "text": "<string>",
      "voice_id": "<string>"
    }
  ],
  "delivery_instructions": "<string>",
  "music_spec": {
    "music_id": "<string>",
    "fade_in_ms": 0,
    "fade_out_ms": 0,
    "playback_start": 0,
    "playback_end": 123,
    "volume": 0.05,
    "loop": false
  }
}
'

{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

X-API-KEY

string

header

required

Body

application/json

A request to start a job that generates an audio file for a podcast in convo mode with a script generated by the user.

script

ScriptSegment · object[]

required

The segments forming the script for the episode

Show child attributes

script.text

string

required

The text to be spoken for this part of the dialogue

script.voice_id

string

required

A unique identifier for the voice copied from the Wondercraft Platform to use for the speaker of this segment.

delivery_instructions

string | null

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

music_spec

MusicTrackSpec · object

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.

Show child attributes

music_spec.music_id

string

required

The ID of the music track to used in the background. This can be copied from theWondercraft platform

music_spec.fade_in_ms

integer

default:0

The number of milliseconds to fade in from the start of the music track

music_spec.fade_out_ms

integer

default:0

The number of milliseconds to fade out from the end of the music track

music_spec.playback_start

integer

default:0

A millisecond into the music track at which we start playing. Equivalent to trimming thebeginning of the music track. Defaults to 0 (i.e. no trimming)

music_spec.playback_end

integer | null

How many milliseconds into the music should we playback. Equivalent to trimming up to this numberof milliseconds from the music track. Defaults to the entire music track.

music_spec.volume

number

default:0.05

The volume to apply to the music track. Defaults to 0.05. Must be between 0.0 and 1.0

music_spec.loop

boolean

default:false

Whether to loop the music track. Defaults to False.

Response

Successful Response

job_id

string<uuid>

required

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

Generate AI-scripted podcast with 2 hosts using Convo Mode Create any audio content with an AI-generated script

⌘I

API Documentation

Endpoint Examples

Authorizations

Body

Response