openai/gpt-image-2.5/sunburst/edit

Editing built for the tightest control, edits scoped precisely to the instruction, with subject and composition preserved across many rounds of revision.

Inference

Commercial use

Partner

Schema

LLMs

Playground API Examples

About

Edit images with the selected GPT Image 2.5 model.

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("openai/gpt-image-2.5/sunburst/edit", {
  input: {
    prompt: "Same workers, same beam, same lunch boxes - but they're all on their phones now. One is taking a selfie. One is on a call looking annoyed. Same danger, new priorities. A hard hat has AirPods.",
    image_urls: ["https://v3b.fal.media/files/b/0a8691af/9Se_1_VX1wzTjjTOpWbs9_bb39c2eb-1a41-4749-b1d0-cf134abc8bbf.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 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("openai/gpt-image-2.5/sunburst/edit", {
  input: {
    prompt: "Same workers, same beam, same lunch boxes - but they're all on their phones now. One is taking a selfie. One is on a call looking annoyed. Same danger, new priorities. A hard hat has AirPods.",
    image_urls: ["https://v3b.fal.media/files/b/0a8691af/9Se_1_VX1wzTjjTOpWbs9_bb39c2eb-1a41-4749-b1d0-cf134abc8bbf.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("openai/gpt-image-2.5/sunburst/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("openai/gpt-image-2.5/sunburst/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#

prompt string* required

The prompt for image generation

image_urls list<string>* required

The URLs of the images to use as a reference for the generation. A maximum of 16 images are allowed.

mask_url string

The URL of the mask image to use for the generation. This indicates what part of the image to edit.

image_size ImageSize | Enum

The size of the generated image. Use 'auto' to infer from input images. Default value: auto

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

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

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

background BackgroundEnum

Background for the generated image Default value: "auto"

Possible enum values: auto, transparent, opaque

quality QualityEnum

Quality for the generated image. Higher settings increase detail, latency, and token usage. Use 'auto' to let the model choose. Default value: "high"

Possible enum values: auto, low, medium, high, xhigh, max

num_images integer

Number of images to generate Default value: 1

output_format OutputFormatEnum

Output format for the images Default value: "png"

Possible enum values: jpeg, png, webp

output_compression integer

Compression level from 0 to 100. Only supported when output_format is 'jpeg' or 'webp'.

sync_mode boolean

If True, the media will be returned as a data URI and the output data won't be available in the request history.

{
  "prompt": "Same workers, same beam, same lunch boxes - but they're all on their phones now. One is taking a selfie. One is on a call looking annoyed. Same danger, new priorities. A hard hat has AirPods.",
  "image_urls": [
    "https://v3b.fal.media/files/b/0a8691af/9Se_1_VX1wzTjjTOpWbs9_bb39c2eb-1a41-4749-b1d0-cf134abc8bbf.png"
  ],
  "image_size": "auto",
  "background": "auto",
  "quality": "high",
  "num_images": 1,
  "output_format": "png"
}

Output#

images list<ImageFile>* required

The generated images.

{
  "images": [
    {
      "height": 1024,
      "file_name": "yUt7tifLSbg1WzWWgfj2o.png",
      "url": "https://v3b.fal.media/files/b/0a8691b0/yUt7tifLSbg1WzWWgfj2o.png",
      "width": 1024,
      "content_type": "image/png"
    }
  ]
}

Other types#

ImageFile#

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

height integer

The height of the image

ImageSize#

width integer

The width of the generated image. Default value: 512

height integer

The height of the generated image. Default value: 512

GPTImage25TextToImageRequest#

prompt string* required

The prompt for image generation

image_size ImageSize | Enum

The size of the generated image. Supports preset names, explicit {width, height}, or 'auto' to let the model pick the best size. Concrete sizes must have both dimensions as multiples of 16, max edge 3840px, aspect ratio <= 3:1, total pixels between 655,360 and 8,294,400. Default value: landscape_4_3

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

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

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

background BackgroundEnum

Background for the generated image Default value: "auto"

Possible enum values: auto, transparent, opaque

quality QualityEnum

Quality for the generated image. Higher settings increase detail, latency, and token usage. Use 'auto' to let the model choose. Default value: "high"

Possible enum values: auto, low, medium, high, xhigh, max

num_images integer

Number of images to generate Default value: 1

output_format OutputFormatEnum

Output format for the images Default value: "png"

Possible enum values: jpeg, png, webp

output_compression integer

Compression level from 0 to 100. Only supported when output_format is 'jpeg' or 'webp'.

sync_mode boolean

If True, the media will be returned as a data URI and the output data won't be available in the request history.

GPTImage25EditImageStreamRequest#

prompt string* required

The prompt for image generation

image_urls list<string>* required

The URLs of the images to use as a reference for the generation. A maximum of 16 images are allowed.

mask_url string

The URL of the mask image to use for the generation. This indicates what part of the image to edit.

image_size ImageSize | Enum

The size of the generated image. Use 'auto' to infer from input images. Default value: auto

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

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

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

background BackgroundEnum

Background for the generated image Default value: "auto"

Possible enum values: auto, transparent, opaque

quality QualityEnum

Quality for the generated image. Higher settings increase detail, latency, and token usage. Use 'auto' to let the model choose. Default value: "high"

Possible enum values: auto, low, medium, high, xhigh, max

num_images integer

Number of images to generate Default value: 1

output_format OutputFormatEnum

Output format for the images Default value: "png"

Possible enum values: jpeg, png, webp

output_compression integer

Compression level from 0 to 100. Only supported when output_format is 'jpeg' or 'webp'.

partial_images integer

Number of intermediate images to request before the final image. Each emitted partial image adds 100 output image tokens. Default value: 3

sync_mode boolean

If True, the media will be returned as a data URI and the output data won't be available in the request history.

GPTImage25TextToImageStreamRequest#

prompt string* required

The prompt for image generation

image_size ImageSize | Enum

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

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

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

background BackgroundEnum

Background for the generated image Default value: "auto"

Possible enum values: auto, transparent, opaque

quality QualityEnum

Quality for the generated image. Higher settings increase detail, latency, and token usage. Use 'auto' to let the model choose. Default value: "high"

Possible enum values: auto, low, medium, high, xhigh, max

num_images integer

Number of images to generate Default value: 1

output_format OutputFormatEnum

Output format for the images Default value: "png"

Possible enum values: jpeg, png, webp

output_compression integer

Compression level from 0 to 100. Only supported when output_format is 'jpeg' or 'webp'.

partial_images integer

Number of intermediate images to request before the final image. Each emitted partial image adds 100 output image tokens. Default value: 3

sync_mode boolean

If True, the media will be returned as a data URI and the output data won't be available in the request history.

ImageResponse#

images list<ImageFile>* required

The generated images.

openai/gpt-image-2.5/sunburst/edit

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

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#

ImageFile#

ImageSize#

GPTImage25TextToImageRequest#

GPTImage25EditImageStreamRequest#

GPTImage25TextToImageStreamRequest#

ImageResponse#

Related Models