Get Structured Open
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/generate/structured_prompt", {
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/generate/structured_prompt", {
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/generate/structured_prompt", {
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/generate/structured_prompt", {
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 stringPrompt for image generation.
The structured prompt to generate an image from.
image_url stringReference image (file or URL).
seed integerRandom seed for reproducibility. Default value: 5555
{
"prompt": "A hyper-detailed, ultra-fluffy owl sitting in the trees at night, looking directly at the camera with wide, adorable, expressive eyes. Its feathers are soft and voluminous, catching the cool moonlight with subtle silver highlights. The owl’s gaze is curious and full of charm, giving it a whimsical, storybook-like personality.",
"seed": 5555
}short_description stringA short description of the image to be generated.
A list of objects in the image to be generated, along with their attributes and relationships to other objects in the image.
background_setting stringThe background setting of the image to be generated.
The lighting of the image to be generated.
The aesthetics of the image to be generated.
The photographic characteristics of the image to be generated.
style_medium stringThe style medium of the image to be generated.
A list of text to be rendered in the image.
context stringThe context of the image to be generated.
artistic_style stringThe artistic style of the image to be generated.
{
"objects": [],
"text_render": []
}short_description stringA short description of the image to be generated.
A list of objects in the image to be generated, along with their attributes and relationships to other objects in the image.
background_setting stringThe background setting of the image to be generated.
The lighting of the image to be generated.
The aesthetics of the image to be generated.
The photographic characteristics of the image to be generated.
style_medium stringThe style medium of the image to be generated.
A list of text to be rendered in the image.
context stringThe context of the image to be generated.
artistic_style stringThe artistic style of the image to be generated.
trigger_word stringsub_trigger_word stringart_direction stringaction_description stringactor_prefix stringconditions stringThe conditions of the lighting in the image to be generated.
direction stringThe direction of the lighting in the image to be generated.
shadows stringThe shadows in the image to be generated.
composition stringThe composition of the image to be generated.
color_scheme stringThe color scheme of the image to be generated.
mood_atmosphere stringThe mood and atmosphere of the image to be generated.
aesthetic_score stringThe aesthetic score of the image to be generated.
preference_score stringThe preference score of the image to be generated.
depth_of_field stringThe depth of field in the image to be generated.
focus stringThe focus in the image to be generated.
camera_angle stringThe angle of the camera in the image to be generated.
lens_focal_length stringThe focal length of the lens in the image to be generated.
description stringA description of the object to be generated.
location stringThe location of the object in the image.
relationship string* requiredThe relationship of the object to other objects in the image.
relative_size stringThe relative size of the object in the image.
shape_and_color stringThe shape and color of the object.
texture stringThe texture of the object.
appearance_details stringThe appearance details of the object.
number_of_objects integerThe number of objects in the image.
pose stringThe pose of the object in the image.
expression stringThe expression of the object in the image.
clothing stringThe clothing of the object in the image.
action stringThe action of the object in the image.
gender stringThe gender of the object in the image.
skin_tone_and_texture stringThe skin tone and texture of the object in the image.
orientation stringThe orientation of the object in the image.