Sound Effect Generation Text to Audio
About
🎵 AI Sound Effect Generation API
Transform your ideas into high-quality sound effects with our advanced AI sound designer. This API uses state-of-the-art diffusion models to generate original sound effects from text descriptions, perfect for content creators, game developers, and filmmakers.
Key Features:
- Text-to-Sound-Effect Generation: Create sound effects from detailed text prompts.
- Customizable Duration: Generate sounds from 1.0 seconds to 35.0 seconds.
- Professional Quality: 44.1kHz stereo output suitable for production use.
- Style Versatility: Supports a wide range of soundscapes, from foley to abstract sounds.
- Reproducible Results: Use seeds for consistent outputs across generations.
Perfect for:
- Sound design for films and animations
- Game audio and interactive experiences
- UI sounds for applications
- Content creation workflows
- Educational and research projects
Example Prompts:
- "Footsteps on gravel"
- "A cinematic explosion with debris falling"
- "Rain falling on a window pane"
- "A futuristic spaceship door opening"
- "Unintelligible live announcements in an airport, with the general airport chaos all around."
- "Powerful helicopter takeoff: rapidly building rotor blades whirring and chopping, increasing engine whine, ground vibrations, then lifting and fading chop as it ascends"
1. Calling the API#
Install the client#
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/client
Migrate to @fal-ai/client
The @fal-ai/serverless-client
package has been deprecated in favor of @fal-ai/client
. Please check the migration guide for more information.
Setup your API Key#
Set FAL_KEY
as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"
Submit a request#
The client API handles the API submit protocol. It will handle the request status updates and return the result when the request is completed.
import { fal } from "@fal-ai/client";
const result = await fal.subscribe("beatoven/sound-effect-generation", {
input: {
prompt: "Powerful helicopter takeoff: rapidly building rotor blades whirring and chopping, increasing engine whine, ground vibrations."
},
logs: true,
onQueueUpdate: (update) => {
if (update.status === "IN_PROGRESS") {
update.logs.map((log) => log.message).forEach(console.log);
}
},
});
console.log(result.data);
console.log(result.requestId);
2. Authentication#
The API uses an API Key for authentication. It is recommended you set the FAL_KEY
environment variable in your runtime when possible.
API Key#
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_KEY"
});
Protect your API Key
When running code on the client-side (e.g. in a browser, mobile app or GUI applications), make sure to not expose your FAL_KEY
. Instead, use a server-side proxy to make requests to the API. For more information, check out our server-side integration guide.
3. Queue#
Submit a request#
The client API provides a convenient way to submit requests to the model.
import { fal } from "@fal-ai/client";
const { request_id } = await fal.queue.submit("beatoven/sound-effect-generation", {
input: {
prompt: "Powerful helicopter takeoff: rapidly building rotor blades whirring and chopping, increasing engine whine, ground vibrations."
},
webhookUrl: "https://optional.webhook.url/for/results",
});
Fetch request status#
You can fetch the status of a request to check if it is completed or still in progress.
import { fal } from "@fal-ai/client";
const status = await fal.queue.status("beatoven/sound-effect-generation", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
logs: true,
});
Get the result#
Once the request is completed, you can fetch the result. See the Output Schema for the expected result format.
import { fal } from "@fal-ai/client";
const result = await fal.queue.result("beatoven/sound-effect-generation", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);
4. Files#
Some attributes in the API accept file URLs as input. Whenever that's the case you can pass your own URL or a Base64 data URI.
Data URI (base64)#
You can pass a Base64 data URI as a file input. The API will handle the file decoding for you. Keep in mind that for large files, this alternative although convenient can impact the request performance.
Hosted files (URL)#
You can also pass your own URLs as long as they are publicly accessible. Be aware that some hosts might block cross-site requests, rate-limit, or consider the request as a bot.
Uploading files#
We provide a convenient file storage that allows you to upload files and use them in your requests. You can upload files using the client API and use the returned URL in your requests.
import { fal } from "@fal-ai/client";
const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);
Auto uploads
The client will auto-upload the file for you if you pass a binary object (e.g. File
, Data
).
Read more about file handling in our file upload guide.
5. Schema#
Input#
prompt
string
* requiredDescribe the sound effect you want to generate
negative_prompt
string
Describe the types of sounds you don't want to generate in the output, avoid double-negatives, compare with positive prompts Default value: ""
duration
float
Length of the generated sound effect in seconds Default value: 5
refinement
integer
Refinement level - Higher values may improve quality but take longer Default value: 40
creativity
float
Creativity level - higher values allow more creative interpretation of the prompt Default value: 16
seed
integer
Random seed for reproducible results - leave empty for random generation
{
"prompt": "Powerful helicopter takeoff: rapidly building rotor blades whirring and chopping, increasing engine whine, ground vibrations.",
"negative_prompt": "Low-pitched hum",
"duration": 7,
"refinement": 40,
"creativity": 16
}
Output#
Generated audio file in WAV format
prompt
string
* requiredThe processed prompt used for generation
Generation metadata including duration, sample rate, and parameters
{
"audio": {
"url": "https://v3b.fal.media/files/b/lion/9Uo4MoD-efg4sjcDyI6Nl_sfx_QHCg3z.wav"
},
"prompt": ""
}
Other types#
File#
url
string
* requiredThe URL where the file can be downloaded from.
content_type
string
The mime type of the file.
file_name
string
The name of the file. It will be auto-generated if not provided.
file_size
integer
The size of the file in bytes.