Convert plain text into Fibo-Lite's transparent JSON-structured prompts - Bria's unique controllability layer that no closed model offers. Built for agentic and enterprise workflows.

bria/fibo-lite/generate/structured_prompt

Convert plain text into Fibo-Lite's transparent JSON-structured prompts - Bria's unique controllability layer that no closed model offers. Built for agentic and enterprise workflows.

Inference

Commercial use

Partner

Schema

LLMs

Playground API

Loading API documentation…

bria/fibo-lite/generate/structured_prompt

Schema

LLMs

Loading API documentation…

Convert plain text into Fibo-Lite's transparent JSON-structured prompts - Bria's unique controllability layer that no closed model offers. Built for agentic and enterprise workflows.

bria/fibo-lite/generate/structured_prompt

Convert plain text into Fibo-Lite's transparent JSON-structured prompts - Bria's unique controllability layer that no closed model offers. Built for agentic and enterprise workflows.

Inference

Commercial use

Partner

Schema

LLMs

Playground API

About

Get Structured Prompt

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. Install the new package and update your imports — see client setup.

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", {
  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 an environment where you cannot set environment variables, you can configure the API key manually on the client.

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", {
  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", {
  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", {
  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

The prompt to generate.

structured_prompt StructuredPrompt

The structured prompt to generate.

image_url string

Input image URL

seed integer

Seed for the random number generator. Default value: 7

{
  "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
}

Output#

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.

{
  "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": ""
}

Other types#

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.

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.

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'.

Loading API documentation…

1. Calling the API

2. Authentication

API Key

3. Queue

4. Files

5. Schema

About

Get Structured Prompt

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. Install the new package and update your imports — see client setup.

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", {
  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 an environment where you cannot set environment variables, you can configure the API key manually on the client.

import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

Protect your API Key

3. Queue#

Long-running requests

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", {
  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", {
  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", {
  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)#

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

The prompt to generate.

structured_prompt StructuredPrompt

The structured prompt to generate.

image_url string

Input image URL

seed integer

Seed for the random number generator. Default value: 7

{
  "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
}

Output#

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.

{
  "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": ""
}

Other types#

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.

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.

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'.

bria/fibo-lite/generate/structured_prompt

bria/fibo-lite/generate/structured_prompt

bria/fibo-lite/generate/structured_prompt

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#

ObjectDescription#

LightingDetails#

TextRender#

AestheticsDetails#

PhotographicCharacteristicsDetails#

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#

ObjectDescription#

LightingDetails#

TextRender#

AestheticsDetails#

PhotographicCharacteristicsDetails#