Gemini 3.1 Flash Image is a text-to-image model that generates images from text descriptions.
The client provides a convenient way to interact with the model API.
npm install --save @fal-ai/clientThe @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.
Set FAL_KEY as an environment variable in your runtime.
export FAL_KEY="YOUR_API_KEY"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-3.1-flash-image-preview/edit", {
input: {
prompt: "make a photo of the man driving the car down the california coastline"
},
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);The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.
import { fal } from "@fal-ai/client";
fal.config({
credentials: "YOUR_FAL_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.
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-3.1-flash-image-preview/edit", {
input: {
prompt: "make a photo of the man driving the car down the california coastline"
},
webhookUrl: "https://optional.webhook.url/for/results",
});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-3.1-flash-image-preview/edit", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
logs: true,
});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-3.1-flash-image-preview/edit", {
requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);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.
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.
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.
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);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.
prompt string* requiredThe prompt for image editing.
num_images integerThe number of images to generate. Default value: 1
seed integerThe seed for the random number generator.
aspect_ratio EnumThe aspect ratio of the generated image. Supports extreme ratios: 4:1, 1:4, 8:1, 1:8. Default value: auto
Possible enum values: auto, 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16, 4:1, 1:4, 8:1, 1:8
output_format OutputFormatEnumThe format of the generated image. Default value: "png"
Possible enum values: jpeg, png, webp
safety_tolerance SafetyToleranceEnumThe safety tolerance level for content moderation. 1 is the most strict (blocks most content), 6 is the least strict. Default value: "4"
Possible enum values: 1, 2, 3, 4, 5, 6
Note: This property is only available through API calls.
sync_mode booleanIf True, the media will be returned as a data URI and the output data won't be available in the request history.
The URLs of the images to use for image-to-image generation or image editing. Optional when at least one of video_url, audio_url, or pdf_url is provided.
system_prompt stringOptional system instruction that steers the model's persona and output style across the request. Leave blank to omit; when provided, it is sent as the system instruction to Gemini (or as a system message on OpenAI-compatible providers). Default value: ""
resolution ResolutionEnumThe resolution of the image to generate. Default value: "1K"
Possible enum values: 0.5K, 1K, 2K, 4K
video_url stringOptional video to use as input context. Accepts an http(s)/data URL to a video file (downloaded and sent inline, max 15MB) or a YouTube URL (passed through to the model without downloading).
audio_url stringOptional audio file to use as input context. Accepts an http(s)/data URL (downloaded and sent inline, max 15MB).
pdf_url stringOptional PDF document to use as input context. Accepts an http(s)/data URL (downloaded and sent inline, max 15MB).
limit_generations booleanExperimental parameter to limit the number of generations from each round of prompting to 1. Set to True to to disregard any instructions in the prompt regarding the number of images to generate and ignore any intermediate images generated by the model. This may affect generation quality. Default value: true
enable_web_search booleanEnable web search for the image generation task. This will allow the model to use the latest information from the web to generate the image.
thinking_level EnumWhen set, enables model thinking with the given level ('minimal' or 'high') and includes thoughts in the generation. Omit to disable.
Possible enum values: minimal, high
{
"prompt": "make a photo of the man driving the car down the california coastline",
"num_images": 1,
"aspect_ratio": "auto",
"output_format": "png",
"safety_tolerance": "4",
"image_urls": [
"https://storage.googleapis.com/falserverless/example_inputs/nano-banana-edit-input.png",
"https://storage.googleapis.com/falserverless/example_inputs/nano-banana-edit-input-2.png"
],
"resolution": "1K",
"limit_generations": true
}The edited images.
description string* requiredThe description of the generated images.
{
"images": [
{
"content_type": "image/png",
"url": "https://storage.googleapis.com/falserverless/example_outputs/nano-banana-2-edit-output.png",
"file_name": "nano-banana-2-edit-output.png"
}
],
"description": ""
}url string* requiredThe URL where the file can be downloaded from.
content_type stringThe mime type of the file.
file_name stringThe name of the file. It will be auto-generated if not provided.
file_size integerThe size of the file in bytes.
width integerThe width of the image
height integerThe height of the image