DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

gpt-image-1 Image to Image

fal-ai/gpt-image-1/edit-image/byok
OpenAI's latest image generation and editing model: gpt-1-image. Currently powered with bring-your-own-key.
Inference
Commercial use
PlaygroundAPI

About

GPT Image 1 is OpenAI's new state-of-the-art image generation model. It is a natively multimodal language model that accepts both text and image inputs, and produces image outputs. It is the successor to DALL-E 2 and DALL-E 3.

Use it as an image-to-image (editing) API through fal!

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/gpt-image-1/edit-image/byok", {
  input: {
    image_urls: ["https://storage.googleapis.com/falserverless/model_tests/gpt-image-1/cyberpunk.png"],
    prompt: "Make this pixel-art style.",
    openai_api_key: ""
  },
  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/gpt-image-1/edit-image/byok", {
  input: {
    image_urls: ["https://storage.googleapis.com/falserverless/model_tests/gpt-image-1/cyberpunk.png"],
    prompt: "Make this pixel-art style.",
    openai_api_key: ""
  },
  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/gpt-image-1/edit-image/byok", {
  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/gpt-image-1/edit-image/byok", {
  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_urls list<string>* required

The URLs of the images to use as a reference for the generation.

prompt string* required

The prompt to edit the image from.

image_size ImageSizeEnum

The size of the image to generate. Default value: "auto"

Possible enum values: auto, 1024x1024, 1536x1024, 1024x1536

num_images integer

The number of images to generate. Default value: 1

quality QualityEnum

The quality of the image to generate. Default value: "auto"

Possible enum values: auto, low, medium, high

openai_api_key string* required

The OpenAI API key to use for the image generation. This endpoint is currently powered by bring-your-own-key system.

{
  "image_urls": [
    "https://storage.googleapis.com/falserverless/model_tests/gpt-image-1/cyberpunk.png"
  ],
  "prompt": "Make this pixel-art style.",
  "image_size": "auto",
  "num_images": 1,
  "quality": "auto",
  "openai_api_key": ""
}

Output#

images list<Image>* required

The edited images.

{
  "images": [
    {
      "url": "https://storage.googleapis.com/falserverless/model_tests/gpt-image-1/cyberpunk_pixel.png"
    }
  ]
}

Other types#

BYOKTextToImageRequest#

prompt string* required

The prompt to generate the image from.

image_size ImageSizeEnum

The size of the image to generate. Default value: "auto"

Possible enum values: auto, 1024x1024, 1536x1024, 1024x1536

num_images integer

The number of images to generate. Default value: 1

quality QualityEnum

The quality of the image to generate. Default value: "auto"

Possible enum values: auto, low, medium, high

background BackgroundEnum

The background of the image to generate. Default value: "auto"

Possible enum values: auto, transparent, opaque

openai_api_key string* required

The OpenAI API key to use for the image generation. This endpoint is currently powered by bring-your-own-key system.

ImageGenerationResponse#

images list<Image>* required

The generated images.

TextToImageRequest#

prompt string* required

The prompt to generate the image from.

image_size ImageSizeEnum

The size of the image to generate. Default value: "auto"

Possible enum values: auto, 1024x1024, 1536x1024, 1024x1536

num_images integer

The number of images to generate. Default value: 1

quality QualityEnum

The quality of the image to generate. Default value: "auto"

Possible enum values: auto, low, medium, high

background BackgroundEnum

The background of the image to generate. Default value: "auto"

Possible enum values: auto, transparent, opaque

ImageEditRequest#

image_urls list<string>* required

The URLs of the images to use as a reference for the generation.

prompt string* required

The prompt to edit the image from.

image_size ImageSizeEnum

The size of the image to generate. Default value: "auto"

Possible enum values: auto, 1024x1024, 1536x1024, 1024x1536

num_images integer

The number of images to generate. Default value: 1

quality QualityEnum

The quality of the image to generate. Default value: "auto"

Possible enum values: auto, low, medium, high

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.

Related Models