gpt-image-1 | Text to Image

fal-ai/gpt-image-1/text-to-image

OpenAI's latest image generation and editing model: gpt-1-image.

Inference

Commercial use

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 a text-to-image 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

Migrate to @fal-ai/client

The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Please check the migration guide for more information.

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/text-to-image", {
  input: {
    prompt: "A serene cyberpunk cityscape at twilight, with neon signs glowing in vibrant blues and purples, reflecting on rain-slick streets. Sleek futuristic buildings tower above, connected by glowing skybridges. A lone figure in a hooded jacket stands under a streetlamp, backlit by soft mist. The atmosphere is cinematic, moody"
  },
  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"
});

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("fal-ai/gpt-image-1/text-to-image", {
  input: {
    prompt: "A serene cyberpunk cityscape at twilight, with neon signs glowing in vibrant blues and purples, reflecting on rain-slick streets. Sleek futuristic buildings tower above, connected by glowing skybridges. A lone figure in a hooded jacket stands under a streetlamp, backlit by soft mist. The atmosphere is cinematic, moody"
  },
  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/text-to-image", {
  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/text-to-image", {
  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_size ImageSizeEnum

Aspect ratio for the generated image Default value: "auto"

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

background BackgroundEnum

Background for the generated image Default value: "auto"

Possible enum values: auto, transparent, opaque

quality QualityEnum

Quality for the generated image Default value: "auto"

Possible enum values: auto, low, medium, high

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

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": "A serene cyberpunk cityscape at twilight, with neon signs glowing in vibrant blues and purples, reflecting on rain-slick streets. Sleek futuristic buildings tower above, connected by glowing skybridges. A lone figure in a hooded jacket stands under a streetlamp, backlit by soft mist. The atmosphere is cinematic, moody",
  "image_size": "auto",
  "background": "auto",
  "quality": "auto",
  "num_images": 1,
  "output_format": "png"
}

Output#

images list<ImageFile>* required

The generated images.

{
  "images": [
    {
      "height": 1536,
      "file_name": "cyberpunk.png",
      "content_type": "image/png",
      "url": "https://storage.googleapis.com/falserverless/model_tests/gpt-image-1/cyberpunk.png",
      "width": 1024
    }
  ]
}

Other types#

EditImageRequest#

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.

image_size ImageSizeEnum

Aspect ratio for the generated image Default value: "auto"

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

background BackgroundEnum

Background for the generated image Default value: "auto"

Possible enum values: auto, transparent, opaque

quality QualityEnum

Quality for the generated image Default value: "auto"

Possible enum values: auto, low, medium, high

input_fidelity InputFidelityEnum

Input fidelity for the generated image Default value: "high"

Possible enum values: low, high

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

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.

BYOKTextToImageRequest#

prompt string* required

The prompt for image generation

image_size ImageSizeEnum

Aspect ratio for the generated image Default value: "auto"

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

background BackgroundEnum

Background for the generated image Default value: "auto"

Possible enum values: auto, transparent, opaque

quality QualityEnum

Quality for the generated image Default value: "auto"

Possible enum values: auto, low, medium, high

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

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.

openai_api_key string* required

Your OpenAI API key

OpenAIUsage#

input_tokens integer

The number of tokens used in the input.

input_tokens_details OpenAIInputTokenDetails

The details of the input tokens.

output_tokens integer

The number of tokens used in the output.

total_tokens integer

The total number of tokens used.

OpenAIInputTokenDetails#

image_tokens integer

The number of tokens used in the images.

text_tokens integer

The number of tokens used in the prompt.

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.

file_data string

File data

width integer

The width of the image

height integer

The height of the image

BYOKImageResponse#

images list<ImageFile>* required

The generated images.

usage OpenAIUsage* required

The usage of the OpenAI API.

BYOKEditImageRequest#

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.

image_size ImageSizeEnum

Aspect ratio for the generated image Default value: "auto"

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

background BackgroundEnum

Background for the generated image Default value: "auto"

Possible enum values: auto, transparent, opaque

quality QualityEnum

Quality for the generated image Default value: "auto"

Possible enum values: auto, low, medium, high

input_fidelity InputFidelityEnum

Input fidelity for the generated image Default value: "high"

Possible enum values: low, high

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

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.

openai_api_key string* required

Your OpenAI API key

EditImageResponse#

images list<ImageFile>* required

The generated images.

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#

EditImageRequest#

BYOKTextToImageRequest#

OpenAIUsage#

OpenAIInputTokenDetails#

ImageFile#

BYOKImageResponse#

BYOKEditImageRequest#

EditImageResponse#

Related Models

gpt-image-1 Text to Image

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#

EditImageRequest#

BYOKTextToImageRequest#

OpenAIUsage#

OpenAIInputTokenDetails#

ImageFile#

BYOKImageResponse#

BYOKEditImageRequest#

EditImageResponse#

Related Models