DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Bria Expand Image Image to Image

fal-ai/bria/expand
Bria Expand expands images beyond their borders in high quality. Trained exclusively on licensed data for safe and risk-free commercial use. Access the model's source code and weights: https://bria.ai/contact-us
Inference
Commercial use
Partner
PlaygroundAPI

About

Image Expansion

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

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("fal-ai/bria/expand", {
  input: {
    image_url: "https://storage.googleapis.com/falserverless/model_tests/orange.png",
    canvas_size: [1200, 674],
    original_image_size: [610, 855],
    original_image_location: [301, -66]
  },
  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"
});

3. Queue#

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("fal-ai/bria/expand", {
  input: {
    image_url: "https://storage.googleapis.com/falserverless/model_tests/orange.png",
    canvas_size: [1200, 674],
    original_image_size: [610, 855],
    original_image_location: [301, -66]
  },
  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("fal-ai/bria/expand", {
  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("fal-ai/bria/expand", {
  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);

Read more about file handling in our file upload guide.

5. Schema#

Input#

image_url string* required

The URL of the input image.

canvas_size list<integer>* required

The desired size of the final image, after the expansion. should have an area of less than 5000x5000 pixels.

original_image_size list<integer>* required

The desired size of the original image, inside the full canvas. Ensure that the ratio of input image foreground or main subject to the canvas area is greater than 15% to achieve optimal results.

original_image_location list<integer>* required

The desired location of the original image, inside the full canvas. Provide the location of the upper left corner of the original image. The location can also be outside the canvas (the original image will be cropped).

prompt string

Text on which you wish to base the image expansion. This parameter is optional. Bria currently supports prompts in English only, excluding special characters. Default value: ""

seed integer

You can choose whether you want your generated expension to be random or predictable. You can recreate the same result in the future by using the seed value of a result from the response. You can exclude this parameter if you are not interested in recreating your results. This parameter is optional.

negative_prompt string

The negative prompt you would like to use to generate images. Default value: ""

num_images integer

Number of Images to generate. Default value: 1

sync_mode boolean

If set to true, the function will wait for the image to be generated and uploaded before returning the response. This will increase the latency of the function but it allows you to get the image directly in the response without going through the CDN.

{
  "image_url": "https://storage.googleapis.com/falserverless/model_tests/orange.png",
  "canvas_size": [
    1200,
    674
  ],
  "original_image_size": [
    610,
    855
  ],
  "original_image_location": [
    301,
    -66
  ],
  "num_images": 1
}

Output#

image Image* required

The generated image

seed integer* required

Seed value used for generation.

{
  "image": {
    "file_size": 1471342,
    "height": 674,
    "file_name": "afa402a35ea742cdb5c3e219b2b19bfb.png",
    "content_type": "image/png",
    "url": "https://v3.fal.media/files/koala/8np-spgxxG-I1r3cjthRV_afa402a35ea742cdb5c3e219b2b19bfb.png",
    "width": 1200
  }
}

Other types#

TextToImageRequest#

prompt string* required

The prompt you would like to use to generate images.

negative_prompt string

The negative prompt you would like to use to generate images. Default value: ""

num_images integer

How many images you would like to generate. When using any Guidance Method, Value is set to 1. Default value: 4

aspect_ratio AspectRatioEnum

The aspect ratio of the image. When a guidance method is being used, the aspect ratio is defined by the guidance image and this parameter is ignored. 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

seed integer

The same seed and the same prompt given to the same version of the model will output the same image every time.

num_inference_steps integer

The number of iterations the model goes through to refine the generated image. This parameter is optional. Default value: 30

guidance_scale float

The CFG (Classifier Free Guidance) scale is a measure of how close you want the model to stick to your prompt when looking for a related image to show you. Default value: 5

prompt_enhancement boolean

When set to true, enhances the provided prompt by generating additional, more descriptive variations, resulting in more diverse and creative output images.

medium MediumEnum

Which medium should be included in your generated images. This parameter is optional.

Possible enum values: photography, art

guidance list<GuidanceInput>

Guidance images to use for the generation. Up to 4 guidance methods can be combined during a single inference. Default value: ``

sync_mode boolean

If set to true, the function will wait for the image to be generated and uploaded before returning the response. This will increase the latency of the function but it allows you to get the image directly in the response without going through the CDN.

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.

file_data string

File data

width integer

The width of the image in pixels.

height integer

The height of the image in pixels.

FastTextToImageRequest#

prompt string* required

The prompt you would like to use to generate images.

negative_prompt string

The negative prompt you would like to use to generate images. Default value: ""

num_images integer

How many images you would like to generate. When using any Guidance Method, Value is set to 1. Default value: 4

aspect_ratio AspectRatioEnum

The aspect ratio of the image. When a guidance method is being used, the aspect ratio is defined by the guidance image and this parameter is ignored. 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

seed integer

The same seed and the same prompt given to the same version of the model will output the same image every time.

num_inference_steps integer

The number of iterations the model goes through to refine the generated image. This parameter is optional. Default value: 8

guidance_scale float

The CFG (Classifier Free Guidance) scale is a measure of how close you want the model to stick to your prompt when looking for a related image to show you. Default value: 5

prompt_enhancement boolean

When set to true, enhances the provided prompt by generating additional, more descriptive variations, resulting in more diverse and creative output images.

medium MediumEnum

Which medium should be included in your generated images. This parameter is optional.

Possible enum values: photography, art

guidance list<GuidanceInput>

Guidance images to use for the generation. Up to 4 guidance methods can be combined during a single inference. Default value: ``

sync_mode boolean

If set to true, the function will wait for the image to be generated and uploaded before returning the response. This will increase the latency of the function but it allows you to get the image directly in the response without going through the CDN.

Related Models