Run the latest models all in one Sandbox 🏖️

Sam Audio Video to Audio

fal-ai/sam-audio/visual-separate
Audio separation with SAM Audio. Isolate any sound using natural language—professional-grade audio editing made simple for creators, researchers, and accessibility applications.
Inference
Commercial use

About

Separate audio using visual prompts from video.

Isolates sounds associated with masked objects in a video. The mask video should be a binary mask where the target object is black and the background is white.

Uses the -tv model variants which are optimized for visual prompting.

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

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("fal-ai/sam-audio/visual-separate", {
  input: {
    video_url: "https://v3b.fal.media/files/b/0a8850d1/gff7zKI-6XwIbBBip4946_office.mp4"
  },
  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#

In case your app is running in an environment where you cannot set environment variables, you can set the API Key manually as a client configuration.
import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

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("fal-ai/sam-audio/visual-separate", {
  input: {
    video_url: "https://v3b.fal.media/files/b/0a8850d1/gff7zKI-6XwIbBBip4946_office.mp4"
  },
  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("fal-ai/sam-audio/visual-separate", {
  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("fal-ai/sam-audio/visual-separate", {
  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);

Read more about file handling in our file upload guide.

5. Schema#

Input#

video_url string* required

URL of the video file to process (MP4, MOV, etc.)

mask_video_url string

URL of the mask video (binary mask indicating target object). Black=target, White=background.

prompt string

Text prompt to assist with separation. Use natural language to describe the target sound. Default value: ""

reranking_candidates integer

Number of candidates to generate and rank. Higher improves quality but increases latency and cost. Default value: 1

acceleration AccelerationEnum

The acceleration level to use. Default value: "balanced"

Possible enum values: fast, balanced, quality

output_format OutputFormatEnum

Output audio format. Default value: "wav"

Possible enum values: wav, mp3

{
  "video_url": "https://v3b.fal.media/files/b/0a8850d1/gff7zKI-6XwIbBBip4946_office.mp4",
  "prompt": "man on the left",
  "reranking_candidates": 1,
  "acceleration": "balanced",
  "output_format": "wav"
}

Output#

target File* required

The isolated target sound.

residual File* required

Everything else in the audio.

duration float* required

Duration of the output audio in seconds.

sample_rate integer

Sample rate of the output audio in Hz. Default value: 48000

{
  "target": {
    "content_type": "audio/wav",
    "url": "https://v3b.fal.media/files/b/0a88550c/CVyBZ1Cxka1vLxVwOfUcc_tmpzzftm934.wav"
  },
  "residual": {
    "content_type": "audio/wav",
    "url": "https://v3b.fal.media/files/b/0a88550c/pdOH_J84S-197LRjMQDrz_tmprx375uix.wav"
  },
  "duration": 15,
  "sample_rate": 48000
}

Other types#

AudioTimeSpan#

start float* required

Start time of the span in seconds

end float* required

End time of the span in seconds

include boolean

Whether to include (True) or exclude (False) sounds in this span Default value: true

File#

url string* required

The 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.

file_data string

File data

Related Models