DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Gemini Flash Edit Multi Image Image to Image

fal-ai/gemini-flash-edit
Gemini Flash Edit is a model that can edit single image using a text prompt and a reference image.
Inference
Commercial use
Partner
PlaygroundAPI

About

Generate or edit an image using Gemini

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/gemini-flash-edit", {
  input: {
    prompt: "Make the car black",
    image_url: "https://storage.googleapis.com/falserverless/web-examples/gemini-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/gemini-flash-edit", {
  input: {
    prompt: "Make the car black",
    image_url: "https://storage.googleapis.com/falserverless/web-examples/gemini-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/gemini-flash-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/gemini-flash-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 prompt for image generation or editing Default value: undefined

image_url string* required

Optional URL of an input image for editing. If not provided, generates a new image. Default value: undefined

{
  "prompt": "Make the car black",
  "image_url": "https://storage.googleapis.com/falserverless/web-examples/gemini-edit/input.png"
}

Output#

image Image* required

The generated or edited image Default value: undefined

description string* required

Text description or response from Gemini Default value: undefined

{
  "image": {
    "url": "",
    "content_type": "image/png",
    "file_name": "z9RV14K95DvU.png",
    "file_size": 4404019,
    "width": 1024,
    "height": 1024
  },
  "description": ""
}

Other types#

Image#

url string* required

The URL where the file can be downloaded from. Default value: undefined

content_type string

The mime type of the file. Default value: undefined

file_name string

The name of the file. It will be auto-generated if not provided. Default value: undefined

file_size integer

The size of the file in bytes. Default value: undefined

width integer

The width of the image in pixels. Default value: undefined

height integer

The height of the image in pixels. Default value: undefined

GeminiMultiImageRequest#

prompt string* required

The prompt for image generation or editing Default value: undefined

input_image_urls list<string>* required

List of URLs of input images for editing Default value: undefined

Related Models