sound-generation

Sound Generation

Changed on

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

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/sound-generation
  • Auth
    none declared

Query parameters

'wav_8000' | 'wav_16000' | 'wav_22050' | 'wav_24000' | 'wav_32000' | 'wav_44100' | 'wav_48000'
OR
'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'
enable_loggingboolean

When enable_logging is set to false zero retention mode will be used for the request. Zero retention mode may only be used by enterprise customers.

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.

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_id'eleven_text_to_sound_v2' | 'eleven_text_to_sound_v3'

Example request

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

Response

The generated sound effect audio, encoded in the specified output_format.

Changes

  • 70227534bb54Revision changes
    • info

      added the new eleven_text_to_sound_v3 enum value to the request property

  • 4bbdfda3e711Revision changes
    • info

      added the new enum value wav_16000 to the query request parameter output_format

    • info

      added the new enum value wav_22050 to the query request parameter output_format

    • info

      added the new enum value wav_24000 to the query request parameter output_format

    • info

      added the new enum value wav_32000 to the query request parameter output_format

    • info

      added the new enum value wav_44100 to the query request parameter output_format

    • info

      added the new enum value wav_48000 to the query request parameter output_format

    • info

      added the new enum value wav_8000 to the query request parameter output_format

    • info

      for the query request parameter output_format, the type was generalized from string to no type