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("bria/fibo-lite/generate", {
input: {},
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("bria/fibo-lite/generate", {
input: {},
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("bria/fibo-lite/generate", {
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("bria/fibo-lite/generate", {
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.
prompt stringThe prompt to generate.
The structured prompt to generate.
image_url stringInput image URL
seed integerSeed for the random number generator. Default value: 7
aspect_ratio AspectRatioEnumAspect ratio. Options: 1:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9 Default value: "1:1"
Possible enum values: 1:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9
sync_mode booleanIf true, returns the image directly in the response (increases latency).
{
"prompt": "Oil painting of a fluffy, wide-eyed cat sitting upright, holding a small wooden sign reading \"Feed Me.\" Rich textures, dramatic brushstrokes, warm tones, and vintage charm.",
"seed": 7,
"aspect_ratio": "1:1"
}Generated image.
Generated images.
Current prompt.
{
"image": {
"url": "",
"content_type": "image/png",
"file_name": "z9RV14K95DvU.png",
"file_size": 4404019,
"width": 1024,
"height": 1024
},
"structured_prompt": {
"short_description": "",
"objects": [
{
"description": "",
"location": "",
"relationship": ""
}
],
"background_setting": "",
"lighting": {
"conditions": "",
"direction": ""
},
"aesthetics": {
"composition": "",
"color_scheme": "",
"mood_atmosphere": "",
"aesthetic_score": "",
"preference_score": ""
},
"text_render": [
{
"text": "",
"location": "",
"size": "",
"color": "",
"font": ""
}
],
"context": "",
"artistic_style": ""
}
}short_description string* requiredA concise summary of the image content, 200 words maximum.
List of prominent foreground/midground objects.
background_setting string* requiredDescribe the overall environment, setting, or background, including any notable background elements.
Details about the lighting.
Details about the image aesthetics.
Details about photographic characteristics.
style_medium stringIdentify the artistic style or medium.
List of text renders in the image.
context string* requiredProvide any additional context that helps understand the image better.
artistic_style string* requireddescribe specific artistic characteristics, 3 words maximum.
subject_emotions stringExplicitly describe any visible emotions or expressions on subjects.
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.
width integerThe width of the image in pixels.
height integerThe height of the image in pixels.
depth_of_field string* requiredE.g., 'shallow', 'deep', 'bokeh background'.
focus string* requiredE.g., 'sharp focus on subject', 'soft focus', 'motion blur'.
camera_angle string* requiredE.g., 'eye-level', 'low angle', 'high angle', 'dutch angle'.
lens_focal_length string* requiredE.g., 'wide-angle', 'telephoto', 'macro', 'fisheye'.
composition string* requiredE.g., 'rule of thirds', 'symmetrical', 'centered', 'leading lines'.
color_scheme string* requiredE.g., 'monochromatic blue', 'warm complementary colors', 'high contrast'.
mood_atmosphere string* requiredE.g., 'serene', 'energetic', 'mysterious', 'joyful'.
aesthetic_score string* requiredE.g., 'very low', 'low', 'medium', 'high', 'very high'.
preference_score string* requiredE.g., 'very low', 'low', 'medium', 'high', 'very high'.
text string* requiredThe text content.
location string* requiredE.g., 'center', 'top-left', 'bottom-right foreground'.
size string* requiredE.g., 'small', 'medium', 'large within frame'.
color string* requiredE.g., 'red', 'blue', 'green'.
font string* requiredE.g., 'realistic', 'cartoonish', 'minimalist'.
appearance_details stringAny other notable visual details.
description string* requiredShort description of the object.
location string* requiredE.g., 'center', 'top-left', 'bottom-right foreground'.
relationship string* requiredDescribe the relationship between the object and the other objects in the image.
relative_size stringE.g., 'small', 'medium', 'large within frame'.
shape_and_color stringDescribe the basic shape and dominant color.
texture stringE.g., 'smooth', 'rough', 'metallic', 'furry'.
appearance_details stringAny other notable visual details.
number_of_objects integerThe number of objects in the cluster.
pose stringDescribe the body position.
expression stringDescribe facial expression.
clothing stringDescribe attire.
action stringDescribe the action of the human.
gender stringDescribe the gender of the human.
skin_tone_and_texture stringDescribe the skin tone and texture.
orientation stringDescribe the orientation of the human.
conditions string* requiredE.g., 'bright daylight', 'dim indoor', 'studio lighting', 'golden hour'.
direction string* requiredE.g., 'front-lit', 'backlit', 'side-lit from left'.
shadows stringDescribe the presence of shadows.