generate_sfx
Describe a sound to generate a matching audio effect—one-shot, ambience, or seamless loop. Set duration, looping, and creativity, then poll the job ID for the result.
Instructions
Generate a sound effect — a one-shot, ambience, or seamless loop.
Returns a job_id immediately; poll with check_jobs([job_id]) for the file path.
Args: prompt: The sound to make ("heavy wooden door creak", "sci-fi UI blip", "rain on a tin roof, distant thunder"). duration_seconds: Length 0.5–30, or None to let the model choose. loop: True to produce a seamlessly loopable clip (great for ambience/BGM beds). prompt_influence: 0–1 (default ~0.3) — higher sticks closer to the prompt, lower gives the model more creative latitude. model: SFX model id override (default the current text-to-sound model). engine: Provider override. Defaults to ElevenLabs for SFX. format: Output format ("mp3" default, "wav" where supported).
Returns: {"job_id": ..., "status": "queued", "engine": ...} or {"error": ...}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| loop | No | ||
| model | No | ||
| engine | No | ||
| format | No | ||
| prompt | Yes | ||
| duration_seconds | No | ||
| prompt_influence | No |