Loading API documentation
Generate
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientSet 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/void-video-inpainting", {
input: {
video_url: "https://storage.googleapis.com/falserverless/kontext-blog/input_video.mp4",
prompt: "a video of buildings reflecting on a calm river"
},
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"
});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/void-video-inpainting", {
input: {
video_url: "https://storage.googleapis.com/falserverless/kontext-blog/input_video.mp4",
prompt: "a video of buildings reflecting on a calm river"
},
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/void-video-inpainting", {
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/void-video-inpainting", {
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);Read more about file handling in our file upload guide.
video_url string* requiredURL of the input video containing the object to remove.
quad_mask_video_url stringURL of a mask video for the removal target. For best results this should be a VOID-style quadmask video with 4 grayscale values: 0=object to remove, 63=overlap, 127=affected region, 255=background to keep. A simple binary mask (0=remove, 255=keep) also works. If omitted, the app will generate a temporary mask video from mask_prompt using the SAM-3 video endpoint and convert it to a quadmask automatically. Default value: ""
mask_prompt stringText description of what should be masked in the input video, such as the object or person to remove. Used to generate a temporary mask video with SAM-3 when quad_mask_video_url is not provided.
prompt string* requiredText description of the desired background after object removal.
enable_pass2_refinement booleanRun VOID Pass 2 warped-noise refinement after Pass 1. This is slower but can improve temporal consistency on longer clips.
negative_prompt stringNegative prompt to guide generation away from undesired outputs. Default value: "The video is not of a high quality, it has a low resolution. Watermark present in each frame. The background is solid. Strange body and strange trajectory. Distortion."
num_inference_steps integerNumber of denoising steps. Higher values improve quality but increase latency. Default value: 30
guidance_scale floatClassifier-free guidance scale. Default value: 1
strength floatDenoising strength. 1.0 means full denoising. Default value: 1
seed integerRandom seed for reproducibility.
num_frames integerTemporal window size for inference. The backend snaps this to the nearest CogVideoX-safe value that works with temporal compression and patching. Valid outputs are 69, 77, 85, ..., 197. Default value: 85
enable_safety_checker booleanEnable content safety checking on the output. Default value: true
{
"video_url": "https://storage.googleapis.com/falserverless/kontext-blog/input_video.mp4",
"quad_mask_video_url": "https://storage.googleapis.com/falserverless/kontext-blog/trimask_quadmask.mp4",
"mask_prompt": "the person walking through the hallway",
"prompt": "a video of buildings reflecting on a calm river",
"negative_prompt": "The video is not of a high quality, it has a low resolution. Watermark present in each frame. The background is solid. Strange body and strange trajectory. Distortion.",
"num_inference_steps": 30,
"guidance_scale": 1,
"strength": 1,
"num_frames": 85,
"enable_safety_checker": true
}The output video with the object removed.
seed integer* requiredThe seed used for generation.
Timing breakdown for pipeline stages.
{
"video": {
"url": "https://v3b.fal.media/files/b/0a95b6f4/D89J5QV-wztq3B0OI44Sl_tmpl1cf522v.mp4"
}
}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.