High-fidelity image editing model with state-of-the-art controllability. Combines JSON + Mask + Image for precise, fine-grained edits ideal for production and enterprise workflows. Trained on licensed data - safe for commercial use.

bria/fibo-edit/edit

Inference

Commercial use

Partner

Schema

Playground API Examples

SandboxOpen in Sandbox

bria/fibo-edit/edit

Schema

SandboxOpen in Sandbox

bria/fibo-edit/edit

Inference

Commercial use

Partner

Schema

Playground API Examples

SandboxOpen in Sandbox

About

Edit 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. 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-edit/edit", {
  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-edit/edit", {
  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-edit/edit", {
  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-edit/edit", {
  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#

image_url string

Reference image (file or URL).

mask_url string

Mask image (file or URL). Optional

instruction string

Instruction for image editing.

vgl Vgl

A pre-built VGL document, edited from verbatim instead of building one from instruction. Send this or instruction, not both.

original_vgl Vgl

The VGL of the image as it is now. With new_vgl, edits by the difference between the two.

new_vgl Vgl

The VGL of the image as it should end up. Requires original_vgl.

seed integer

Random seed for reproducibility. Default value: 5555

steps_num integer

Number of inference steps. Default value: 30

negative_prompt string

Negative prompt for image generation. Default value: ""

guidance_scale float | integer

Guidance scale for text. Default value: 5

sync_mode boolean

If true, returns the image directly in the response (increases latency).

{
  "image_url": "https://v3b.fal.media/files/b/0a8b07e8/GYKVk2EVivg_MC3jRRZi3_png%20-%202026-01-13T094835.850%20(3).png",
  "instruction": "change lighting to starlight nighttime",
  "seed": 5555,
  "steps_num": 30,
  "guidance_scale": 5
}

Output#

image Image* required

Generated image.

images list<Image>

Generated images.

vgl Vgl* required

The VGL document the image was generated from.

{
  "image": {
    "url": "",
    "content_type": "image/png",
    "file_name": "z9RV14K95DvU.png",
    "file_size": 4404019,
    "width": 1024,
    "height": 1024
  },
  "images": [
    {
      "url": "https://bria-datasets.s3.us-east-1.amazonaws.com/Liza/ewT7wv-jMgkqs7z7xQNNL_e8707c299d034feab7a64d903118098f.png"
    }
  ],
  "vgl": {
    "objects": [],
    "text_render": []
  }
}

Other types#

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.

Vgl#

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.

edit_instruction string

The edit instruction for the image.

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.

preference_score string

The preference score of the image to be generated.

aesthetic_score string

The aesthetic score of the image to be generated.

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.

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.

Related Models

About

Edit 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. 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-edit/edit", {
  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-edit/edit", {
  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-edit/edit", {
  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-edit/edit", {
  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#

image_url string

Reference image (file or URL).

mask_url string

Mask image (file or URL). Optional

instruction string

Instruction for image editing.

vgl Vgl

A pre-built VGL document, edited from verbatim instead of building one from instruction. Send this or instruction, not both.

original_vgl Vgl

The VGL of the image as it is now. With new_vgl, edits by the difference between the two.

new_vgl Vgl

The VGL of the image as it should end up. Requires original_vgl.

seed integer

Random seed for reproducibility. Default value: 5555

steps_num integer

Number of inference steps. Default value: 30

negative_prompt string

Negative prompt for image generation. Default value: ""

guidance_scale float | integer

Guidance scale for text. Default value: 5

sync_mode boolean

If true, returns the image directly in the response (increases latency).

{
  "image_url": "https://v3b.fal.media/files/b/0a8b07e8/GYKVk2EVivg_MC3jRRZi3_png%20-%202026-01-13T094835.850%20(3).png",
  "instruction": "change lighting to starlight nighttime",
  "seed": 5555,
  "steps_num": 30,
  "guidance_scale": 5
}

Output#

image Image* required

Generated image.

images list<Image>

Generated images.

vgl Vgl* required

The VGL document the image was generated from.

{
  "image": {
    "url": "",
    "content_type": "image/png",
    "file_name": "z9RV14K95DvU.png",
    "file_size": 4404019,
    "width": 1024,
    "height": 1024
  },
  "images": [
    {
      "url": "https://bria-datasets.s3.us-east-1.amazonaws.com/Liza/ewT7wv-jMgkqs7z7xQNNL_e8707c299d034feab7a64d903118098f.png"
    }
  ],
  "vgl": {
    "objects": [],
    "text_render": []
  }
}

Other types#

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.

Vgl#

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.

edit_instruction string

The edit instruction for the image.

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.

preference_score string

The preference score of the image to be generated.

aesthetic_score string

The aesthetic score of the image to be generated.

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.

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.

Related Models

Fibo Edit Image to Image API Docs | fal

bria/fibo-edit/edit

Table of contents

Table of contents

bria/fibo-edit/edit

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#

Image#

Vgl#

Aesthetics#

PromptObject#

PhotographicCharacteristics#

Lighting#

Related Models

Table of contents

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#

Image#

Vgl#

Aesthetics#

PromptObject#

PhotographicCharacteristics#

Lighting#

Related Models