SKILL.md
ElevenLabs Sound Effects
Generate sound effects from text descriptions — supports looping, custom duration, and prompt adherence control.
Setup: See [Installation Guide](references/installation.md). For JavaScript, use
@elevenlabs/*packages only.
Quick Start
Python
from elevenlabs import ElevenLabs
client = ElevenLabs()
audio = client.text_to_sound_effects.convert(
text="Thunder rumbling in the distance with light rain",
)
with open("thunder.mp3", "wb") as f:
for chunk in audio:
f.write(chunk)JavaScript
import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";
import { createWriteStream } from "fs";
const client = new ElevenLabsClient();
const audio = await client.textToSoundEffects.convert({
text: "Thunder rumbling in the distance with light rain",
});
audio.pipe(createWriteStream("thunder.mp3"));cURL
curl -X POST "https://api.elevenlabs.io/v1/sound-generation" \
-H "xi-api-key: $ELEVENLABS_API_KEY" -H "Content-Type: application/json" \
-d '{"text": "Thunder rumbling in the distance with light rain"}' \
--output thunder.mp3Parameters
| Parameter | Type | Default | Description | |
|---|---|---|---|---|
text |
string (required) | — | Description of the desired sound effect | |
model_id |
string | eleventexttosoundv2 |
Model to use | |
duration_seconds |
number \ | null | null (auto) | Duration 0.5–30s; auto-calculated if null |
prompt_influence |
number \ | null | 0.3 | How closely to follow the prompt (0–1) |
loop |
boolean | false | Generate a seamlessly looping sound (v2 model only) |
Examples with Parameters
# Looping ambient sound, 10 seconds
audio = client.text_to_sound_effects.convert(
text="Gentle forest ambiance with birds chirping",
duration_seconds=10.0,
prompt_influence=0.5,
loop=True,
)
# Short UI sound, high prompt adherence
audio = client.text_to_sound_effects.convert(
text="Soft notification chime",
duration_seconds=1.0,
prompt_influence=0.8,
)Output Formats
Pass output_format as a query parameter (cURL) or SDK parameter:
| Format | Description |
|---|---|
mp344100128 |
MP3 44.1kHz 128kbps (default) |
pcm_44100 |
Raw uncompressed CD quality |
opus48000128 |
Opus 48kHz 128kbps — efficient compressed |
ulaw_8000 |
μ-law 8kHz — telephony |
Full list: mp32205032, mp32400048, mp34410032, mp34410064, mp34410096, mp344100128, mp344100192, pcm8000, pcm16000, pcm22050, pcm24000, pcm32000, pcm44100, pcm48000, ulaw8000, alaw8000, opus4800032, opus4800064, opus4800096, opus48000128, opus48000_192.
Prompt Tips
- Be specific: "Heavy rain on a tin roof" > "Rain"
- Combine elements: "Footsteps on gravel with distant traffic"
- Specify style: "Cinematic braam, horror" or "8-bit retro jump sound"
- Mention mood/context: "Eerie wind howling through an abandoned building"
Error Handling
try:
audio = client.text_to_sound_effects.convert(text="Explosion")
except Exception as e:
print(f"API error: {e}")Common errors:
- 401: Invalid API key
- 422: Invalid parameters (check duration range, prompt_influence range)
- 429: Rate limit exceeded
References
- [Installation Guide](references/installation.md)