Fibo Lite | Text to JSON

bria/fibo-lite/generate/structured_prompt/lite

Structured Prompt Generation endpoint for Fibo-Lite, Bria's SOTA Open source model

Inference

Commercial use

Partner

Schema

LLMs

Playground API

About

Get Structured Open

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

Migrate to @fal-ai/client

The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Please check the migration guide for more information.

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("bria/fibo-lite/generate/structured_prompt/lite", {
  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);

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"
});

Protect your API 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.

3. Queue#

Long-running requests

For long-running requests, such as training jobs or models with slower inference times, it is recommended to check the Queue status and rely on Webhooks instead of blocking while waiting for the result.

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("bria/fibo-lite/generate/structured_prompt/lite", {
  input: {},
  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("bria/fibo-lite/generate/structured_prompt/lite", {
  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("bria/fibo-lite/generate/structured_prompt/lite", {
  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);

Auto uploads

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.

5. Schema#

Input#

prompt string

Prompt for image generation.

structured_prompt bria_fibo-vlm_StructuredPrompt

The structured prompt to generate an image from.

image_url string

Reference image (file or URL).

seed integer

Random 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
}

Output#

Other types#

TextRender#

text string* required

The text content.

location string* required

E.g., 'center', 'top-left', 'bottom-right foreground'.

size string* required

E.g., 'small', 'medium', 'large within frame'.

color string* required

E.g., 'red', 'blue', 'green'.

font string* required

E.g., 'realistic', 'cartoonish', 'minimalist'.

appearance_details string

Any other notable visual details.

AestheticsDetails#

composition string* required

E.g., 'rule of thirds', 'symmetrical', 'centered', 'leading lines'.

color_scheme string* required

E.g., 'monochromatic blue', 'warm complementary colors', 'high contrast'.

mood_atmosphere string* required

E.g., 'serene', 'energetic', 'mysterious', 'joyful'.

aesthetic_score string* required

E.g., 'very low', 'low', 'medium', 'high', 'very high'.

preference_score string* required

E.g., 'very low', 'low', 'medium', 'high', 'very high'.

PhotographicCharacteristicsDetails#

depth_of_field string* required

E.g., 'shallow', 'deep', 'bokeh background'.

focus string* required

E.g., 'sharp focus on subject', 'soft focus', 'motion blur'.

camera_angle string* required

E.g., 'eye-level', 'low angle', 'high angle', 'dutch angle'.

lens_focal_length string* required

E.g., 'wide-angle', 'telephoto', 'macro', 'fisheye'.

LightingDetails#

conditions string* required

E.g., 'bright daylight', 'dim indoor', 'studio lighting', 'golden hour'.

direction string* required

E.g., 'front-lit', 'backlit', 'side-lit from left'.

shadows string

Describe the presence of shadows.

ObjectDescription#

description string* required

Short description of the object.

location string* required

E.g., 'center', 'top-left', 'bottom-right foreground'.

relationship string* required

Describe the relationship between the object and the other objects in the image.

relative_size string

E.g., 'small', 'medium', 'large within frame'.

shape_and_color string

Describe the basic shape and dominant color.

texture string

E.g., 'smooth', 'rough', 'metallic', 'furry'.

appearance_details string

Any other notable visual details.

number_of_objects integer

The number of objects in the cluster.

pose string

Describe the body position.

expression string

Describe facial expression.

clothing string

Describe attire.

action string

Describe the action of the human.

gender string

Describe the gender of the human.

skin_tone_and_texture string

Describe the skin tone and texture.

orientation string

Describe the orientation of the human.

StructuredPrompt#

short_description string* required

A concise summary of the image content, 200 words maximum.

objects list<ObjectDescription>* required

List of prominent foreground/midground objects.

background_setting string* required

Describe the overall environment, setting, or background, including any notable background elements.

lighting LightingDetails* required

Details about the lighting.

aesthetics AestheticsDetails* required

Details about the image aesthetics.

photographic_characteristics PhotographicCharacteristicsDetails

Details about photographic characteristics.

style_medium string

Identify the artistic style or medium.

text_render list<TextRender>

List of text renders in the image.

context string* required

Provide any additional context that helps understand the image better.

artistic_style string* required

describe specific artistic characteristics, 3 words maximum.

subject_emotions string

Explicitly describe any visible emotions or expressions on subjects.

Image#

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.

width integer

The width of the image in pixels.

height integer

The height of the image in pixels.

PhotographicCharacteristics#

depth_of_field string

The depth of field in the image to be generated.

focus string

The focus in the image to be generated.

camera_angle string

The angle of the camera in the image to be generated.

lens_focal_length string

The focal length of the lens in the image to be generated.

Lighting#

conditions string

The conditions of the lighting in the image to be generated.

direction string

The direction of the lighting in the image to be generated.

shadows string

The shadows in the image to be generated.

Aesthetics#

composition string

The composition of the image to be generated.

color_scheme string

The color scheme of the image to be generated.

mood_atmosphere string

The mood and atmosphere of the image to be generated.

aesthetic_score string* required

The aesthetic score of the image.

preference_score string* required

The preference score of the image.

PromptObject#

description string

A description of the object to be generated.

location string

The location of the object in the image.

relationship string* required

The relationship of the object to other objects in the image.

relative_size string

The relative size of the object in the image.

shape_and_color string

The shape and color of the object.

texture string

The texture of the object.

appearance_details string

The appearance details of the object.

number_of_objects integer

The number of objects in the image.

pose string

The pose of the object in the image.

expression string

The expression of the object in the image.

clothing string

The clothing of the object in the image.

action string

The action of the object in the image.

gender string

The gender of the object in the image.

skin_tone_and_texture string

The skin tone and texture of the object in the image.

orientation string

The orientation of the object in the image.

bria_fibo-vlm_StructuredPrompt#

short_description string

A short description of the image to be generated.

objects list<PromptObject>

A list of objects in the image to be generated, along with their attributes and relationships to other objects in the image.

background_setting string

The background setting of the image to be generated.

lighting Lighting

The lighting of the image to be generated.

aesthetics Aesthetics

The aesthetics of the image to be generated.

photographic_characteristics PhotographicCharacteristics

The photographic characteristics of the image to be generated.

style_medium string

The style medium of the image to be generated.

text_render list<void>

A list of text to be rendered in the image.

context string

The context of the image to be generated.

artistic_style string

The artistic style of the image to be generated.

Fibo Lite Text to JSON

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

TextRender#

AestheticsDetails#

PhotographicCharacteristicsDetails#

LightingDetails#

ObjectDescription#

StructuredPrompt#

Image#

PhotographicCharacteristics#

Lighting#

Aesthetics#

PromptObject#

bria_fibo-vlm_StructuredPrompt#