Images

Create image

ImagesResponse images().generate(ImageGenerateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post /images/generations

Creates an image given a prompt. Learn more.

Parameters

ImageGenerateParams params
- String prompt
  
  A text description of the desired image(s). The maximum length is 32000 characters for the GPT image models, 1000 characters for dall-e-2 and 4000 characters for dall-e-3.
- Optional<Background> background
  
  Allows to set transparency for the background of the generated image(s). This parameter is only supported for GPT image models that support transparent backgrounds. Must be one of transparent, opaque, or auto (default value). When auto is used, the model will automatically determine the best background for the image.
  
  gpt-image-2 and gpt-image-2-2026-04-21 do not support transparent backgrounds. Requests with background set to transparent will return an error for these models; use opaque or auto instead.
  
  If transparent, the output format needs to support transparency, so it should be set to either png (default value) or webp.
  - TRANSPARENT("transparent")
  - OPAQUE("opaque")
  - AUTO("auto")
- Optional<ImageModel> model
  
  The model to use for image generation. One of dall-e-2, dall-e-3, or a GPT image model (gpt-image-1, gpt-image-1-mini, gpt-image-1.5, gpt-image-2, or gpt-image-2-2026-04-21). Defaults to dall-e-2 unless a parameter specific to the GPT image models is used.
  - GPT_IMAGE_1("gpt-image-1")
  - GPT_IMAGE_1_MINI("gpt-image-1-mini")
  - GPT_IMAGE_2("gpt-image-2")
  - GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
  - GPT_IMAGE_1_5("gpt-image-1.5")
  - CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
  - DALL_E_2("dall-e-2")
  - DALL_E_3("dall-e-3")
- Optional<Moderation> moderation
  
  Control the content-moderation level for images generated by the GPT image models. Must be either low for less restrictive filtering or auto (default value).
  - LOW("low")
  - AUTO("auto")
- Optional<Long> n
  
  The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.
- Optional<Long> outputCompression
  
  The compression level (0-100%) for the generated images. This parameter is only supported for the GPT image models with the webp or jpeg output formats, and defaults to 100.
- Optional<OutputFormat> outputFormat
  
  The format in which the generated images are returned. This parameter is only supported for the GPT image models. Must be one of png, jpeg, or webp.
  - PNG("png")
  - JPEG("jpeg")
  - WEBP("webp")
- Optional<Long> partialImages
  
  The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event.
  
  Note that the final image may be sent before the full number of partial images are generated if the full image is generated more quickly.
- Optional<Quality> quality
  
  The quality of the image that will be generated.
  - auto (default value) will automatically select the best quality for the given model.
  - high, medium and low are supported for the GPT image models.
  - hd and standard are supported for dall-e-3.
  - standard is the only option for dall-e-2.
  - STANDARD("standard")
  - HD("hd")
  - LOW("low")
  - MEDIUM("medium")
  - HIGH("high")
  - AUTO("auto")
- Optional<ResponseFormat> responseFormat
  
  The format in which generated images with dall-e-2 and dall-e-3 are returned. Must be one of url or b64_json. URLs are only valid for 60 minutes after the image has been generated. This parameter isn't supported for the GPT image models, which always return base64-encoded images.
  - URL("url")
  - B64_JSON("b64_json")
- Optional<Size> size
  
  The size of the generated images. For gpt-image-2 and gpt-image-2-2026-04-21, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.
  - AUTO("auto")
  - _1024X1024("1024x1024")
  - _1536X1024("1536x1024")
  - _1024X1536("1024x1536")
  - _256X256("256x256")
  - _512X512("512x512")
  - _1792X1024("1792x1024")
  - _1024X1792("1024x1792")
- Optional<Style> style
  
  The style of the generated images. This parameter is only supported for dall-e-3. Must be one of vivid or natural. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images.
  - VIVID("vivid")
  - NATURAL("natural")
- Optional<String> user
  
  A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

Returns

class ImagesResponse:

The response from the image generation endpoint.
- long created
  
  The Unix timestamp (in seconds) of when the image was created.
- Optional<Background> background
  
  The background parameter used for the image generation. Either transparent or opaque.
  - TRANSPARENT("transparent")
  - OPAQUE("opaque")
- Optional<List<Image>> data
  
  The list of generated images.
  - Optional<String> b64Json
    
    The base64-encoded JSON of the generated image. Returned by default for the GPT image models, and only present if response_format is set to b64_json for dall-e-2 and dall-e-3.
  - Optional<String> revisedPrompt
    
    For dall-e-3 only, the revised prompt that was used to generate the image.
  - Optional<String> url
    
    When using dall-e-2 or dall-e-3, the URL of the generated image if response_format is set to url (default value). Unsupported for the GPT image models.
- Optional<OutputFormat> outputFormat
  
  The output format of the image generation. Either png, webp, or jpeg.
  - PNG("png")
  - WEBP("webp")
  - JPEG("jpeg")
- Optional<Quality> quality
  
  The quality of the image generated. Either low, medium, or high.
  - LOW("low")
  - MEDIUM("medium")
  - HIGH("high")
- Optional<Size> size
  
  The size of the image generated. Either 1024x1024, 1024x1536, or 1536x1024.
  - _1024X1024("1024x1024")
  - _1024X1536("1024x1536")
  - _1536X1024("1536x1024")
- Optional<Usage> usage
  
  For gpt-image-1 only, the token usage information for the image generation.
  - long inputTokens
    
    The number of tokens (images and text) in the input prompt.
  - InputTokensDetails inputTokensDetails
    
    The input tokens detailed information for the image generation.
    - long imageTokens
      
      The number of image tokens in the input prompt.
    - long textTokens
      
      The number of text tokens in the input prompt.
  - long outputTokens
    
    The number of output tokens generated by the model.
  - long totalTokens
    
    The total number of tokens (images and text) used for the image generation.
  - Optional<OutputTokensDetails> outputTokensDetails
    
    The output token details for the image generation.
    - long imageTokens
      
      The number of image output tokens generated by the model.
    - long textTokens
      
      The number of text output tokens generated by the model.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.images.ImageGenerateParams;
import com.openai.models.images.ImagesResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        ImageGenerateParams params = ImageGenerateParams.builder()
            .prompt("A cute baby sea otter")
            .build();
        ImagesResponse imagesResponse = client.images().generate(params);
    }
}

Response

{
  "created": 0,
  "background": "transparent",
  "data": [
    {
      "b64_json": "b64_json",
      "revised_prompt": "revised_prompt",
      "url": "https://example.com"
    }
  ],
  "output_format": "png",
  "quality": "low",
  "size": "1024x1024",
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "image_tokens": 0,
      "text_tokens": 0
    },
    "output_tokens": 0,
    "total_tokens": 0,
    "output_tokens_details": {
      "image_tokens": 0,
      "text_tokens": 0
    }
  }
}

Create image edit

ImagesResponse images().edit(ImageEditParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post /images/edits

Creates an edited or extended image given one or more source images and a prompt. This endpoint supports GPT Image models (gpt-image-1.5, gpt-image-1, gpt-image-1-mini, and chatgpt-image-latest) and dall-e-2.

Parameters

ImageEditParams params
- Image image
  
  The image(s) to edit. Must be a supported image file or an array of images.
  
  For the GPT image models (gpt-image-1, gpt-image-1-mini, gpt-image-1.5, gpt-image-2, gpt-image-2-2026-04-21, and chatgpt-image-latest), each image should be a png, webp, or jpg file less than 50MB. You can provide up to 16 images.
  
  For dall-e-2, you can only provide one image, and it should be a square png file less than 4MB.
  - String
  - List<String>
- String prompt
  
  A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2, and 32000 characters for the GPT image models.
- Optional<Background> background
  
  Allows to set transparency for the background of the generated image(s). This parameter is only supported for GPT image models that support transparent backgrounds. Must be one of transparent, opaque, or auto (default value). When auto is used, the model will automatically determine the best background for the image.
  
  gpt-image-2 and gpt-image-2-2026-04-21 do not support transparent backgrounds. Requests with background set to transparent will return an error for these models; use opaque or auto instead.
  
  If transparent, the output format needs to support transparency, so it should be set to either png (default value) or webp.
  - TRANSPARENT("transparent")
  - OPAQUE("opaque")
  - AUTO("auto")
- Optional<InputFidelity> inputFidelity
  
  Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.
  - HIGH("high")
  - LOW("low")
- Optional<String> mask
  
  An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. If there are multiple images provided, the mask will be applied on the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.
- Optional<ImageModel> model
  
  The model to use for image generation. One of dall-e-2 or a GPT image model (gpt-image-1, gpt-image-1-mini, gpt-image-1.5, gpt-image-2, gpt-image-2-2026-04-21, or chatgpt-image-latest). Defaults to gpt-image-1.5.
  - GPT_IMAGE_1("gpt-image-1")
  - GPT_IMAGE_1_MINI("gpt-image-1-mini")
  - GPT_IMAGE_2("gpt-image-2")
  - GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
  - GPT_IMAGE_1_5("gpt-image-1.5")
  - CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
  - DALL_E_2("dall-e-2")
  - DALL_E_3("dall-e-3")
- Optional<Long> n
  
  The number of images to generate. Must be between 1 and 10.
- Optional<Long> outputCompression
  
  The compression level (0-100%) for the generated images. This parameter is only supported for the GPT image models with the webp or jpeg output formats, and defaults to 100.
- Optional<OutputFormat> outputFormat
  
  The format in which the generated images are returned. This parameter is only supported for the GPT image models. Must be one of png, jpeg, or webp. The default value is png.
  - PNG("png")
  - JPEG("jpeg")
  - WEBP("webp")
- Optional<Long> partialImages
  
  The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event.
  
  Note that the final image may be sent before the full number of partial images are generated if the full image is generated more quickly.
- Optional<Quality> quality
  
  The quality of the image that will be generated for GPT image models. Defaults to auto.
  - STANDARD("standard")
  - LOW("low")
  - MEDIUM("medium")
  - HIGH("high")
  - AUTO("auto")
- Optional<ResponseFormat> responseFormat
  
  The format in which the generated images are returned. Must be one of url or b64_json. URLs are only valid for 60 minutes after the image has been generated. This parameter is only supported for dall-e-2 (default is url for dall-e-2), as GPT image models always return base64-encoded images.
  - URL("url")
  - B64_JSON("b64_json")
- Optional<Size> size
  
  The size of the generated images. For gpt-image-2 and gpt-image-2-2026-04-21, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.
  - _256X256("256x256")
  - _512X512("512x512")
  - _1024X1024("1024x1024")
  - _1536X1024("1536x1024")
  - _1024X1536("1024x1536")
  - AUTO("auto")
- Optional<String> user
  
  A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

Returns

class ImagesResponse:

The response from the image generation endpoint.
- long created
  
  The Unix timestamp (in seconds) of when the image was created.
- Optional<Background> background
  
  The background parameter used for the image generation. Either transparent or opaque.
  - TRANSPARENT("transparent")
  - OPAQUE("opaque")
- Optional<List<Image>> data
  
  The list of generated images.
  - Optional<String> b64Json
    
    The base64-encoded JSON of the generated image. Returned by default for the GPT image models, and only present if response_format is set to b64_json for dall-e-2 and dall-e-3.
  - Optional<String> revisedPrompt
    
    For dall-e-3 only, the revised prompt that was used to generate the image.
  - Optional<String> url
    
    When using dall-e-2 or dall-e-3, the URL of the generated image if response_format is set to url (default value). Unsupported for the GPT image models.
- Optional<OutputFormat> outputFormat
  
  The output format of the image generation. Either png, webp, or jpeg.
  - PNG("png")
  - WEBP("webp")
  - JPEG("jpeg")
- Optional<Quality> quality
  
  The quality of the image generated. Either low, medium, or high.
  - LOW("low")
  - MEDIUM("medium")
  - HIGH("high")
- Optional<Size> size
  
  The size of the image generated. Either 1024x1024, 1024x1536, or 1536x1024.
  - _1024X1024("1024x1024")
  - _1024X1536("1024x1536")
  - _1536X1024("1536x1024")
- Optional<Usage> usage
  
  For gpt-image-1 only, the token usage information for the image generation.
  - long inputTokens
    
    The number of tokens (images and text) in the input prompt.
  - InputTokensDetails inputTokensDetails
    
    The input tokens detailed information for the image generation.
    - long imageTokens
      
      The number of image tokens in the input prompt.
    - long textTokens
      
      The number of text tokens in the input prompt.
  - long outputTokens
    
    The number of output tokens generated by the model.
  - long totalTokens
    
    The total number of tokens (images and text) used for the image generation.
  - Optional<OutputTokensDetails> outputTokensDetails
    
    The output token details for the image generation.
    - long imageTokens
      
      The number of image output tokens generated by the model.
    - long textTokens
      
      The number of text output tokens generated by the model.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.images.ImageEditParams;
import com.openai.models.images.ImagesResponse;
import java.io.ByteArrayInputStream;
import java.io.InputStream;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        ImageEditParams params = ImageEditParams.builder()
            .image(new ByteArrayInputStream("Example data".getBytes()))
            .prompt("A cute baby sea otter wearing a beret")
            .build();
        ImagesResponse imagesResponse = client.images().edit(params);
    }
}

Response

{
  "created": 0,
  "background": "transparent",
  "data": [
    {
      "b64_json": "b64_json",
      "revised_prompt": "revised_prompt",
      "url": "https://example.com"
    }
  ],
  "output_format": "png",
  "quality": "low",
  "size": "1024x1024",
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "image_tokens": 0,
      "text_tokens": 0
    },
    "output_tokens": 0,
    "total_tokens": 0,
    "output_tokens_details": {
      "image_tokens": 0,
      "text_tokens": 0
    }
  }
}

Create image variation

ImagesResponse images().createVariation(ImageCreateVariationParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

post /images/variations

Creates a variation of a given image. This endpoint only supports dall-e-2.

Parameters

ImageCreateVariationParams params
- String image
  
  The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.
- Optional<ImageModel> model
  
  The model to use for image generation. Only dall-e-2 is supported at this time.
  - GPT_IMAGE_1("gpt-image-1")
  - GPT_IMAGE_1_MINI("gpt-image-1-mini")
  - GPT_IMAGE_2("gpt-image-2")
  - GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
  - GPT_IMAGE_1_5("gpt-image-1.5")
  - CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
  - DALL_E_2("dall-e-2")
  - DALL_E_3("dall-e-3")
- Optional<Long> n
  
  The number of images to generate. Must be between 1 and 10.
- Optional<ResponseFormat> responseFormat
  
  The format in which the generated images are returned. Must be one of url or b64_json. URLs are only valid for 60 minutes after the image has been generated.
  - URL("url")
  - B64_JSON("b64_json")
- Optional<Size> size
  
  The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.
  - _256X256("256x256")
  - _512X512("512x512")
  - _1024X1024("1024x1024")
- Optional<String> user
  
  A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

Returns

class ImagesResponse:

The response from the image generation endpoint.
- long created
  
  The Unix timestamp (in seconds) of when the image was created.
- Optional<Background> background
  
  The background parameter used for the image generation. Either transparent or opaque.
  - TRANSPARENT("transparent")
  - OPAQUE("opaque")
- Optional<List<Image>> data
  
  The list of generated images.
  - Optional<String> b64Json
    
    The base64-encoded JSON of the generated image. Returned by default for the GPT image models, and only present if response_format is set to b64_json for dall-e-2 and dall-e-3.
  - Optional<String> revisedPrompt
    
    For dall-e-3 only, the revised prompt that was used to generate the image.
  - Optional<String> url
    
    When using dall-e-2 or dall-e-3, the URL of the generated image if response_format is set to url (default value). Unsupported for the GPT image models.
- Optional<OutputFormat> outputFormat
  
  The output format of the image generation. Either png, webp, or jpeg.
  - PNG("png")
  - WEBP("webp")
  - JPEG("jpeg")
- Optional<Quality> quality
  
  The quality of the image generated. Either low, medium, or high.
  - LOW("low")
  - MEDIUM("medium")
  - HIGH("high")
- Optional<Size> size
  
  The size of the image generated. Either 1024x1024, 1024x1536, or 1536x1024.
  - _1024X1024("1024x1024")
  - _1024X1536("1024x1536")
  - _1536X1024("1536x1024")
- Optional<Usage> usage
  
  For gpt-image-1 only, the token usage information for the image generation.
  - long inputTokens
    
    The number of tokens (images and text) in the input prompt.
  - InputTokensDetails inputTokensDetails
    
    The input tokens detailed information for the image generation.
    - long imageTokens
      
      The number of image tokens in the input prompt.
    - long textTokens
      
      The number of text tokens in the input prompt.
  - long outputTokens
    
    The number of output tokens generated by the model.
  - long totalTokens
    
    The total number of tokens (images and text) used for the image generation.
  - Optional<OutputTokensDetails> outputTokensDetails
    
    The output token details for the image generation.
    - long imageTokens
      
      The number of image output tokens generated by the model.
    - long textTokens
      
      The number of text output tokens generated by the model.

Example

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.images.ImageCreateVariationParams;
import com.openai.models.images.ImagesResponse;
import java.io.ByteArrayInputStream;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        ImageCreateVariationParams params = ImageCreateVariationParams.builder()
            .image(new ByteArrayInputStream("Example data".getBytes()))
            .build();
        ImagesResponse imagesResponse = client.images().createVariation(params);
    }
}

Response

{
  "created": 0,
  "background": "transparent",
  "data": [
    {
      "b64_json": "b64_json",
      "revised_prompt": "revised_prompt",
      "url": "https://example.com"
    }
  ],
  "output_format": "png",
  "quality": "low",
  "size": "1024x1024",
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "image_tokens": 0,
      "text_tokens": 0
    },
    "output_tokens": 0,
    "total_tokens": 0,
    "output_tokens_details": {
      "image_tokens": 0,
      "text_tokens": 0
    }
  }
}

Domain Types

Image

class Image:

Represents the content or the URL of an image generated by the OpenAI API.
- Optional<String> b64Json
  
  The base64-encoded JSON of the generated image. Returned by default for the GPT image models, and only present if response_format is set to b64_json for dall-e-2 and dall-e-3.
- Optional<String> revisedPrompt
  
  For dall-e-3 only, the revised prompt that was used to generate the image.
- Optional<String> url
  
  When using dall-e-2 or dall-e-3, the URL of the generated image if response_format is set to url (default value). Unsupported for the GPT image models.

Image Edit Completed Event

class ImageEditCompletedEvent:

Emitted when image editing has completed and the final image is available.
- String b64Json
  
  Base64-encoded final edited image data, suitable for rendering as an image.
- Background background
  
  The background setting for the edited image.
  - TRANSPARENT("transparent")
  - OPAQUE("opaque")
  - AUTO("auto")
- long createdAt
  
  The Unix timestamp when the event was created.
- OutputFormat outputFormat
  
  The output format for the edited image.
  - PNG("png")
  - WEBP("webp")
  - JPEG("jpeg")
- Quality quality
  
  The quality setting for the edited image.
  - LOW("low")
  - MEDIUM("medium")
  - HIGH("high")
  - AUTO("auto")
- Size size
  
  The size of the edited image.
  - _1024X1024("1024x1024")
  - _1024X1536("1024x1536")
  - _1536X1024("1536x1024")
  - AUTO("auto")
- JsonValue; type "image_edit.completed"constant
  
  The type of the event. Always image_edit.completed.
  - IMAGE_EDIT_COMPLETED("image_edit.completed")
- Usage usage
  
  For the GPT image models only, the token usage information for the image generation.
  - long inputTokens
    
    The number of tokens (images and text) in the input prompt.
  - InputTokensDetails inputTokensDetails
    
    The input tokens detailed information for the image generation.
    - long imageTokens
      
      The number of image tokens in the input prompt.
    - long textTokens
      
      The number of text tokens in the input prompt.
  - long outputTokens
    
    The number of image tokens in the output image.
  - long totalTokens
    
    The total number of tokens (images and text) used for the image generation.

Image Edit Partial Image Event

class ImageEditPartialImageEvent:

Emitted when a partial image is available during image editing streaming.
- String b64Json
  
  Base64-encoded partial image data, suitable for rendering as an image.
- Background background
  
  The background setting for the requested edited image.
  - TRANSPARENT("transparent")
  - OPAQUE("opaque")
  - AUTO("auto")
- long createdAt
  
  The Unix timestamp when the event was created.
- OutputFormat outputFormat
  
  The output format for the requested edited image.
  - PNG("png")
  - WEBP("webp")
  - JPEG("jpeg")
- long partialImageIndex
  
  0-based index for the partial image (streaming).
- Quality quality
  
  The quality setting for the requested edited image.
  - LOW("low")
  - MEDIUM("medium")
  - HIGH("high")
  - AUTO("auto")
- Size size
  
  The size of the requested edited image.
  - _1024X1024("1024x1024")
  - _1024X1536("1024x1536")
  - _1536X1024("1536x1024")
  - AUTO("auto")
- JsonValue; type "image_edit.partial_image"constant
  
  The type of the event. Always image_edit.partial_image.
  - IMAGE_EDIT_PARTIAL_IMAGE("image_edit.partial_image")

Image Edit Stream Event

class ImageEditStreamEvent: A class that can be one of several variants.union

Emitted when a partial image is available during image editing streaming.
- class ImageEditPartialImageEvent:
  
  Emitted when a partial image is available during image editing streaming.
  - String b64Json
    
    Base64-encoded partial image data, suitable for rendering as an image.
  - Background background
    
    The background setting for the requested edited image.
    - TRANSPARENT("transparent")
    - OPAQUE("opaque")
    - AUTO("auto")
  - long createdAt
    
    The Unix timestamp when the event was created.
  - OutputFormat outputFormat
    
    The output format for the requested edited image.
    - PNG("png")
    - WEBP("webp")
    - JPEG("jpeg")
  - long partialImageIndex
    
    0-based index for the partial image (streaming).
  - Quality quality
    
    The quality setting for the requested edited image.
    - LOW("low")
    - MEDIUM("medium")
    - HIGH("high")
    - AUTO("auto")
  - Size size
    
    The size of the requested edited image.
    - _1024X1024("1024x1024")
    - _1024X1536("1024x1536")
    - _1536X1024("1536x1024")
    - AUTO("auto")
  - JsonValue; type "image_edit.partial_image"constant
    
    The type of the event. Always image_edit.partial_image.
    - IMAGE_EDIT_PARTIAL_IMAGE("image_edit.partial_image")
- class ImageEditCompletedEvent:
  
  Emitted when image editing has completed and the final image is available.
  - String b64Json
    
    Base64-encoded final edited image data, suitable for rendering as an image.
  - Background background
    
    The background setting for the edited image.
    - TRANSPARENT("transparent")
    - OPAQUE("opaque")
    - AUTO("auto")
  - long createdAt
    
    The Unix timestamp when the event was created.
  - OutputFormat outputFormat
    
    The output format for the edited image.
    - PNG("png")
    - WEBP("webp")
    - JPEG("jpeg")
  - Quality quality
    
    The quality setting for the edited image.
    - LOW("low")
    - MEDIUM("medium")
    - HIGH("high")
    - AUTO("auto")
  - Size size
    
    The size of the edited image.
    - _1024X1024("1024x1024")
    - _1024X1536("1024x1536")
    - _1536X1024("1536x1024")
    - AUTO("auto")
  - JsonValue; type "image_edit.completed"constant
    
    The type of the event. Always image_edit.completed.
    - IMAGE_EDIT_COMPLETED("image_edit.completed")
  - Usage usage
    
    For the GPT image models only, the token usage information for the image generation.
    - long inputTokens
      
      The number of tokens (images and text) in the input prompt.
    - InputTokensDetails inputTokensDetails
      
      The input tokens detailed information for the image generation.
      - long imageTokens
        
        The number of image tokens in the input prompt.
      - long textTokens
        
        The number of text tokens in the input prompt.
    - long outputTokens
      
      The number of image tokens in the output image.
    - long totalTokens
      
      The total number of tokens (images and text) used for the image generation.

Image Gen Completed Event

class ImageGenCompletedEvent:

Emitted when image generation has completed and the final image is available.
- String b64Json
  
  Base64-encoded image data, suitable for rendering as an image.
- Background background
  
  The background setting for the generated image.
  - TRANSPARENT("transparent")
  - OPAQUE("opaque")
  - AUTO("auto")
- long createdAt
  
  The Unix timestamp when the event was created.
- OutputFormat outputFormat
  
  The output format for the generated image.
  - PNG("png")
  - WEBP("webp")
  - JPEG("jpeg")
- Quality quality
  
  The quality setting for the generated image.
  - LOW("low")
  - MEDIUM("medium")
  - HIGH("high")
  - AUTO("auto")
- Size size
  
  The size of the generated image.
  - _1024X1024("1024x1024")
  - _1024X1536("1024x1536")
  - _1536X1024("1536x1024")
  - AUTO("auto")
- JsonValue; type "image_generation.completed"constant
  
  The type of the event. Always image_generation.completed.
  - IMAGE_GENERATION_COMPLETED("image_generation.completed")
- Usage usage
  
  For the GPT image models only, the token usage information for the image generation.
  - long inputTokens
    
    The number of tokens (images and text) in the input prompt.
  - InputTokensDetails inputTokensDetails
    
    The input tokens detailed information for the image generation.
    - long imageTokens
      
      The number of image tokens in the input prompt.
    - long textTokens
      
      The number of text tokens in the input prompt.
  - long outputTokens
    
    The number of image tokens in the output image.
  - long totalTokens
    
    The total number of tokens (images and text) used for the image generation.

Image Gen Partial Image Event

class ImageGenPartialImageEvent:

Emitted when a partial image is available during image generation streaming.
- String b64Json
  
  Base64-encoded partial image data, suitable for rendering as an image.
- Background background
  
  The background setting for the requested image.
  - TRANSPARENT("transparent")
  - OPAQUE("opaque")
  - AUTO("auto")
- long createdAt
  
  The Unix timestamp when the event was created.
- OutputFormat outputFormat
  
  The output format for the requested image.
  - PNG("png")
  - WEBP("webp")
  - JPEG("jpeg")
- long partialImageIndex
  
  0-based index for the partial image (streaming).
- Quality quality
  
  The quality setting for the requested image.
  - LOW("low")
  - MEDIUM("medium")
  - HIGH("high")
  - AUTO("auto")
- Size size
  
  The size of the requested image.
  - _1024X1024("1024x1024")
  - _1024X1536("1024x1536")
  - _1536X1024("1536x1024")
  - AUTO("auto")
- JsonValue; type "image_generation.partial_image"constant
  
  The type of the event. Always image_generation.partial_image.
  - IMAGE_GENERATION_PARTIAL_IMAGE("image_generation.partial_image")

Image Gen Stream Event

class ImageGenStreamEvent: A class that can be one of several variants.union

Emitted when a partial image is available during image generation streaming.
- class ImageGenPartialImageEvent:
  
  Emitted when a partial image is available during image generation streaming.
  - String b64Json
    
    Base64-encoded partial image data, suitable for rendering as an image.
  - Background background
    
    The background setting for the requested image.
    - TRANSPARENT("transparent")
    - OPAQUE("opaque")
    - AUTO("auto")
  - long createdAt
    
    The Unix timestamp when the event was created.
  - OutputFormat outputFormat
    
    The output format for the requested image.
    - PNG("png")
    - WEBP("webp")
    - JPEG("jpeg")
  - long partialImageIndex
    
    0-based index for the partial image (streaming).
  - Quality quality
    
    The quality setting for the requested image.
    - LOW("low")
    - MEDIUM("medium")
    - HIGH("high")
    - AUTO("auto")
  - Size size
    
    The size of the requested image.
    - _1024X1024("1024x1024")
    - _1024X1536("1024x1536")
    - _1536X1024("1536x1024")
    - AUTO("auto")
  - JsonValue; type "image_generation.partial_image"constant
    
    The type of the event. Always image_generation.partial_image.
    - IMAGE_GENERATION_PARTIAL_IMAGE("image_generation.partial_image")
- class ImageGenCompletedEvent:
  
  Emitted when image generation has completed and the final image is available.
  - String b64Json
    
    Base64-encoded image data, suitable for rendering as an image.
  - Background background
    
    The background setting for the generated image.
    - TRANSPARENT("transparent")
    - OPAQUE("opaque")
    - AUTO("auto")
  - long createdAt
    
    The Unix timestamp when the event was created.
  - OutputFormat outputFormat
    
    The output format for the generated image.
    - PNG("png")
    - WEBP("webp")
    - JPEG("jpeg")
  - Quality quality
    
    The quality setting for the generated image.
    - LOW("low")
    - MEDIUM("medium")
    - HIGH("high")
    - AUTO("auto")
  - Size size
    
    The size of the generated image.
    - _1024X1024("1024x1024")
    - _1024X1536("1024x1536")
    - _1536X1024("1536x1024")
    - AUTO("auto")
  - JsonValue; type "image_generation.completed"constant
    
    The type of the event. Always image_generation.completed.
    - IMAGE_GENERATION_COMPLETED("image_generation.completed")
  - Usage usage
    
    For the GPT image models only, the token usage information for the image generation.
    - long inputTokens
      
      The number of tokens (images and text) in the input prompt.
    - InputTokensDetails inputTokensDetails
      
      The input tokens detailed information for the image generation.
      - long imageTokens
        
        The number of image tokens in the input prompt.
      - long textTokens
        
        The number of text tokens in the input prompt.
    - long outputTokens
      
      The number of image tokens in the output image.
    - long totalTokens
      
      The total number of tokens (images and text) used for the image generation.

Image Model

enum ImageModel:
- GPT_IMAGE_1("gpt-image-1")
- GPT_IMAGE_1_MINI("gpt-image-1-mini")
- GPT_IMAGE_2("gpt-image-2")
- GPT_IMAGE_2_2026_04_21("gpt-image-2-2026-04-21")
- GPT_IMAGE_1_5("gpt-image-1.5")
- CHATGPT_IMAGE_LATEST("chatgpt-image-latest")
- DALL_E_2("dall-e-2")
- DALL_E_3("dall-e-3")

Images Response

class ImagesResponse:

The response from the image generation endpoint.
- long created
  
  The Unix timestamp (in seconds) of when the image was created.
- Optional<Background> background
  
  The background parameter used for the image generation. Either transparent or opaque.
  - TRANSPARENT("transparent")
  - OPAQUE("opaque")
- Optional<List<Image>> data
  
  The list of generated images.
  - Optional<String> b64Json
    
    The base64-encoded JSON of the generated image. Returned by default for the GPT image models, and only present if response_format is set to b64_json for dall-e-2 and dall-e-3.
  - Optional<String> revisedPrompt
    
    For dall-e-3 only, the revised prompt that was used to generate the image.
  - Optional<String> url
    
    When using dall-e-2 or dall-e-3, the URL of the generated image if response_format is set to url (default value). Unsupported for the GPT image models.
- Optional<OutputFormat> outputFormat
  
  The output format of the image generation. Either png, webp, or jpeg.
  - PNG("png")
  - WEBP("webp")
  - JPEG("jpeg")
- Optional<Quality> quality
  
  The quality of the image generated. Either low, medium, or high.
  - LOW("low")
  - MEDIUM("medium")
  - HIGH("high")
- Optional<Size> size
  
  The size of the image generated. Either 1024x1024, 1024x1536, or 1536x1024.
  - _1024X1024("1024x1024")
  - _1024X1536("1024x1536")
  - _1536X1024("1536x1024")
- Optional<Usage> usage
  
  For gpt-image-1 only, the token usage information for the image generation.
  - long inputTokens
    
    The number of tokens (images and text) in the input prompt.
  - InputTokensDetails inputTokensDetails
    
    The input tokens detailed information for the image generation.
    - long imageTokens
      
      The number of image tokens in the input prompt.
    - long textTokens
      
      The number of text tokens in the input prompt.
  - long outputTokens
    
    The number of output tokens generated by the model.
  - long totalTokens
    
    The total number of tokens (images and text) used for the image generation.
  - Optional<OutputTokensDetails> outputTokensDetails
    
    The output token details for the image generation.
    - long imageTokens
      
      The number of image output tokens generated by the model.
    - long textTokens
      
      The number of text output tokens generated by the model.

java/resources/images/index.md +30 −2

122 122

123 - `B64_JSON("b64_json")`123 - `B64_JSON("b64_json")`

124 124

125 - `Optional<String> size`125 - `Optional<Size> size`

126 126

127 The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.127 The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.

128 128

129 - `AUTO("auto")`

130

131 - `_1024X1024("1024x1024")`

132

133 - `_1536X1024("1536x1024")`

134

135 - `_1024X1536("1024x1536")`

136

137 - `_256X256("256x256")`

138

139 - `_512X512("512x512")`

140

141 - `_1792X1024("1792x1024")`

142

143 - `_1024X1792("1024x1792")`

144

129 - `Optional<Style> style`145 - `Optional<Style> style`

130 146

131 The style of the generated images. This parameter is only supported for `dall-e-3`. Must be one of `vivid` or `natural`. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images.147 The style of the generated images. This parameter is only supported for `dall-e-3`. Must be one of `vivid` or `natural`. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images.

437 453

438 - `B64_JSON("b64_json")`454 - `B64_JSON("b64_json")`

439 455

440 - `Optional<String> size`456 - `Optional<Size> size`

441 457

442 The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.458 The size of the generated images. For `gpt-image-2` and `gpt-image-2-2026-04-21`, arbitrary resolutions are supported as `WIDTHxHEIGHT` strings, for example `1536x864`. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above `2560x1440` are experimental, and the maximum supported resolution is `3840x2160`. The requested size must also satisfy the model's current pixel and edge limits. The standard sizes `1024x1024`, `1536x1024`, and `1024x1536` are supported by the GPT image models; `auto` is supported for models that allow automatic sizing. For `dall-e-2`, use one of `256x256`, `512x512`, or `1024x1024`. For `dall-e-3`, use one of `1024x1024`, `1792x1024`, or `1024x1792`.

443 459

460 - `_256X256("256x256")`

461

462 - `_512X512("512x512")`

463

464 - `_1024X1024("1024x1024")`

465

466 - `_1536X1024("1536x1024")`

467

468 - `_1024X1536("1024x1536")`

469

470 - `AUTO("auto")`

471

444 - `Optional<String> user`472 - `Optional<String> user`

445 473

446 A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).474 A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices#end-user-ids).

java/resources/images/index.md 2026-05-05 23:00 UTC to 2026-05-07 21:57 UTC

Images

Create image

Parameters

Returns

Example

Response

Create image edit

Parameters

Returns

Example

Response

Create image variation

Parameters

Returns

Example

Response

Domain Types

Image

Image Edit Completed Event

Image Edit Partial Image Event

Image Edit Stream Event

Image Gen Completed Event

Image Gen Partial Image Event

Image Gen Stream Event

Image Model

Images Response