Loading API documentation
Generate
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/video-prompt-generator", {
input: {
input_concept: "A futuristic city at dusk"
},
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/video-prompt-generator", {
input: {
input_concept: "A futuristic city at dusk"
},
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/video-prompt-generator", {
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/video-prompt-generator", {
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.
input_concept string* requiredCore concept or thematic input for the video prompt
style StyleEnumStyle of the video prompt Default value: "Simple"
Possible enum values: Minimalist, Simple, Detailed, Descriptive, Dynamic, Cinematic, Documentary, Animation, Action, Experimental
camera_style CameraStyleEnumCamera movement style Default value: "None"
Possible enum values: None, Steadicam flow, Drone aerials, Handheld urgency, Crane elegance, Dolly precision, VR 360, Multi-angle rig, Static tripod, Gimbal smoothness, Slider motion, Jib sweep, POV immersion, Time-slice array, Macro extreme, Tilt-shift miniature, Snorricam character, Whip pan dynamics, Dutch angle tension, Underwater housing, Periscope lens
camera_direction CameraDirectionEnumCamera direction Default value: "None"
Possible enum values: None, Zoom in, Zoom out, Pan left, Pan right, Tilt up, Tilt down, Orbital rotation, Push in, Pull out, Track forward, Track backward, Spiral in, Spiral out, Arc movement, Diagonal traverse, Vertical rise, Vertical descent
pacing PacingEnumPacing rhythm Default value: "None"
Possible enum values: None, Slow burn, Rhythmic pulse, Frantic energy, Ebb and flow, Hypnotic drift, Time-lapse rush, Stop-motion staccato, Gradual build, Quick cut rhythm, Long take meditation, Jump cut energy, Match cut flow, Cross-dissolve dreamscape, Parallel action, Slow motion impact, Ramping dynamics, Montage tempo, Continuous flow, Episodic breaks
special_effects SpecialEffectsEnumSpecial effects approach Default value: "None"
Possible enum values: None, Practical effects, CGI enhancement, Analog glitches, Light painting, Projection mapping, Nanosecond exposures, Double exposure, Smoke diffusion, Lens flare artistry, Particle systems, Holographic overlay, Chromatic aberration, Digital distortion, Wire removal, Motion capture, Miniature integration, Weather simulation, Color grading, Mixed media composite, Neural style transfer
custom_elements stringCustom technical elements (optional) Default value: ""
image_url stringURL of an image to analyze and incorporate into the video prompt (optional)
model ModelEnumModel to use Default value: "google/gemini-2.5-flash-lite"
Possible enum values: anthropic/claude-3-haiku, google/gemini-2.5-flash, google/gemini-2.5-flash-lite, meta-llama/llama-3.1-8b-instruct, meta-llama/llama-3.1-70b-instruct, openai/gpt-4o-mini, openai/gpt-4o
prompt_length PromptLengthEnumLength of the prompt Default value: "Medium"
Possible enum values: Short, Medium, Long
{
"input_concept": "A futuristic city at dusk",
"style": "Simple",
"camera_style": "None",
"camera_direction": "None",
"pacing": "None",
"special_effects": "None",
"model": "google/gemini-2.5-flash-lite",
"prompt_length": "Medium"
}prompt string* requiredGenerated video prompt
{
"prompt": "A futuristic city glows softly at dusk, captured with smooth gimbal movements and a slow burn pacing, enhanced by subtle holographic overlays."
}