Loading API documentation
Separate audio using temporal spans.
Isolates a specific sound from an audio mixture based on time spans where the target sound occurs. More precise than text-only prompting.
Provide spans with start/end times in seconds to indicate where the target sound occurs in the audio.
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientThe @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Install the new package and update your imports — see client setup.
Set FAL_KEY as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"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("fal-ai/sam-audio/span-separate", {
input: {
audio_url: "https://v3b.fal.media/files/b/0a8853d1/T7zRmsiculA6u_V6RCF2c_man.mp3",
spans: [{
start: 6,
include: true,
end: 10
}]
},
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);The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_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.
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("fal-ai/sam-audio/span-separate", {
input: {
audio_url: "https://v3b.fal.media/files/b/0a8853d1/T7zRmsiculA6u_V6RCF2c_man.mp3",
spans: [{
start: 6,
include: true,
end: 10
}]
},
webhookUrl: "https://optional.webhook.url/for/results",
});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("fal-ai/sam-audio/span-separate", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
logs: true,
});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("fal-ai/sam-audio/span-separate", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);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.
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.
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.
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);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.
audio_url string* requiredURL of the audio file to process.
prompt stringText prompt describing the sound to isolate. Optional but recommended - helps the model identify what type of sound to extract from the span.
Time spans where the target sound occurs which should be isolated.
reranking_candidates integerNumber of candidates to generate and rank. Higher improves quality but increases latency and cost. Requires text prompt; ignored for span-only separation. Default value: 1
acceleration AccelerationEnumThe acceleration level to use. Default value: "balanced"
Possible enum values: fast, balanced, quality
max_chunk_duration floatMaximum audio duration (in seconds) to process in a single pass. Longer audio will be chunked with overlap and blended. Default value: 60
chunk_overlap floatOverlap duration (in seconds) between chunks for crossfade blending. Default value: 5
use_sound_activity_ranking booleanUse sound activity detection to rank reranking candidates based on how well each candidate's non-silent regions match the provided spans. Enables effective reranking even without a text prompt (span-only separation). Requires reranking_candidates > 1.
trim_to_span booleanTrim output audio to only include the specified span time range. If False, returns the full audio length with the target sound isolated throughout.
output_format OutputFormatEnumOutput audio format. Default value: "wav"
Possible enum values: wav, mp3
{
"audio_url": "https://v3b.fal.media/files/b/0a8853d1/T7zRmsiculA6u_V6RCF2c_man.mp3",
"prompt": "man singing",
"spans": [
{
"start": 6,
"include": true,
"end": 10
}
],
"reranking_candidates": 1,
"acceleration": "balanced",
"max_chunk_duration": 60,
"chunk_overlap": 5,
"output_format": "wav"
}The isolated target sound.
Everything else in the audio.
duration float* requiredDuration of the output audio in seconds.
sample_rate integerSample rate of the output audio in Hz. Default value: 48000
{
"target": {
"content_type": "audio/wav",
"url": "https://v3b.fal.media/files/b/0a89374c/mImRbqrjB72o9vEmIrSmW_tmpp2rmotgs.wav"
},
"residual": {
"content_type": "audio/wav",
"url": "https://v3b.fal.media/files/b/0a89374d/suELShppRlPCTAVnbWRqj_tmpr8shao_e.wav"
},
"duration": 81.96,
"sample_rate": 48000
}start float* requiredStart time of the span in seconds
end float* requiredEnd time of the span in seconds
include booleanWhether to include (True) or exclude (False) sounds in this span Default value: true
url string* requiredThe URL where the file can be downloaded from.
content_type stringThe mime type of the file.
file_name stringThe name of the file. It will be auto-generated if not provided.
file_size integerThe size of the file in bytes.