v4

OpenAPI 3.1.02026-07-313621,3961.8 MB

sound-generation

Sound Generation

Turn text into sound effects for your videos, voice-overs or video games using the most advanced sound effects models in the world.

post/v1/sound-generation

Query parameters

output_format'mp3_22050_32' | 'mp3_24000_48' | 'mp3_44100_32' | 'mp3_44100_64' | 'mp3_44100_96' | 'mp3_44100_128' | 'mp3_44100_192' | 'pcm_8000' | 'pcm_16000' | 'pcm_22050' | 'pcm_24000' | 'pcm_32000' | 'pcm_44100' | 'pcm_48000' | 'ulaw_8000' | 'alaw_8000' | 'opus_48000_32' | 'opus_48000_64' | 'opus_48000_96' | 'opus_48000_128' | 'opus_48000_192'

Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

textstring required

The text that will get converted into a sound effect.

loopboolean

Whether to create a sound effect that loops smoothly. Only available for the 'eleven_text_to_sound_v2 model'.

duration_secondsnumber nullable

The duration of the sound which will be generated in seconds. Must be at least 0.5 and at most 30. If set to None we will guess the optimal duration using the prompt. Defaults to None.

prompt_influencenumber nullable

A higher prompt influence makes your generation follow the prompt more closely while also making generations less variable. Must be a value between 0 and 1. Defaults to 0.3.

model_idstring

The model ID to use for the sound generation.

Example request

{
  "text": "A large, ancient wooden door slowly opening in an eerie, abandoned castle..",
  "model_id": "eleven_text_to_sound_v2"
}

Response

The generated sound effect as an MP3 file