fal Assets is now live!
Docs
Log-inSign-up

fal-ai/boogu-image/edit

Image To Image Model using Boogu-Image
Inference
Commercial use
Schema
LLMs
PlaygroundAPIExamples

Table of contents

About

Edit

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/boogu-image/edit", {
  input: {
    prompt: "Change the background to a sunny garden while preserving the person.",
    image_url: "https://storage.googleapis.com/falserverless/example_inputs/flux2_dev_edit_input.png"
  },
  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/boogu-image/edit", {
  input: {
    prompt: "Change the background to a sunny garden while preserving the person.",
    image_url: "https://storage.googleapis.com/falserverless/example_inputs/flux2_dev_edit_input.png"
  },
  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/boogu-image/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("fal-ai/boogu-image/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);

Read more about file handling in our file upload guide.

5. Schema#

Input#

prompt string* required

The edit instruction describing how to transform the input image. Boogu-Image supports English and Chinese instructions.

image_url string* required

URL of the input image to edit.

negative_prompt string

Describes what should NOT appear in the edited image. Used for classifier-free guidance; leave empty to disable text negative guidance. Default value: ""

image_size ImageSize | Enum

The output size. If omitted, the edited image follows the input image aspect ratio while respecting the model's 2K native limit.

Possible enum values: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9

Note: For custom image sizes, you can pass the width and height as an object:

"image_size": {
  "width": 1280,
  "height": 720
}
num_inference_steps integer

The number of denoising steps to perform. Default value: 30

guidance_scale float

Controls how closely the edit follows the text instruction. Higher values stick more closely to the prompt. Default value: 4

image_guidance_scale float

Reference-image guidance strength. A value of 1.0 disables image CFG; higher values preserve the input image more strongly. Default value: 1

cfg_range_start float

Start of the timestep fraction over which CFG is applied.

cfg_range_end float

End of the timestep fraction over which CFG is applied. Default value: 1

num_images integer

The number of edited images to generate. Default value: 1

seed integer

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

enable_safety_checker boolean

If true, the safety checker is run on the input and output images. Default value: true

output_format OutputFormatEnum

The format of the generated image. Default value: "jpeg"

Possible enum values: jpeg, png

sync_mode boolean

If true, the media is returned as a data URI and the output is not available in the request history.

{
  "prompt": "Change the background to a sunny garden while preserving the person.",
  "image_url": "https://storage.googleapis.com/falserverless/example_inputs/flux2_dev_edit_input.png",
  "num_inference_steps": 30,
  "guidance_scale": 4,
  "image_guidance_scale": 1,
  "cfg_range_end": 1,
  "num_images": 1,
  "enable_safety_checker": true,
  "output_format": "jpeg"
}

Output#

images list<Image>* required

The generated images.

timings Timings* required
seed integer* required

Seed of the generated Image. It will be the same value of the one passed in the input or the randomly generated that was used in case none was passed.

has_nsfw_concepts list<boolean>* required

Whether the generated images contain NSFW concepts.

prompt string* required

The prompt used for generating the image.

{
  "images": {
    "height": 1024,
    "width": 1024,
    "url": "https://storage.googleapis.com/falserverless/example_outputs/boogu_image_t2i.jpeg",
    "content_type": "image/jpeg"
  },
  "prompt": ""
}

Other types#

Image#

url string* required
width integer* required
height integer* required
content_type string

Default value: "image/jpeg"

ImageSize#

width integer

The width of the generated image. Default value: 512

height integer

The height of the generated image. Default value: 512

Related Models