Images

Create image

client.Images.Generate(ctx, body) (*ImagesResponse, error)

post /images/generations

Creates an image given a prompt. Learn more.

Parameters

body ImageGenerateParams
- Prompt param.Field[string]
  
  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.
- Background param.Field[ImageGenerateParamsBackground]
  
  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.
  - const ImageGenerateParamsBackgroundTransparent ImageGenerateParamsBackground = "transparent"
  - const ImageGenerateParamsBackgroundOpaque ImageGenerateParamsBackground = "opaque"
  - const ImageGenerateParamsBackgroundAuto ImageGenerateParamsBackground = "auto"
- Model param.Field[ImageModel]
  
  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.
  - string
  - type ImageModel string
    - const ImageModelGPTImage1 ImageModel = "gpt-image-1"
    - const ImageModelGPTImage1Mini ImageModel = "gpt-image-1-mini"
    - const ImageModelGPTImage2 ImageModel = "gpt-image-2"
    - const ImageModelGPTImage2_2026_04_21 ImageModel = "gpt-image-2-2026-04-21"
    - const ImageModelGPTImage1_5 ImageModel = "gpt-image-1.5"
    - const ImageModelChatgptImageLatest ImageModel = "chatgpt-image-latest"
    - const ImageModelDallE2 ImageModel = "dall-e-2"
    - const ImageModelDallE3 ImageModel = "dall-e-3"
- Moderation param.Field[ImageGenerateParamsModeration]
  
  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).
  - const ImageGenerateParamsModerationLow ImageGenerateParamsModeration = "low"
  - const ImageGenerateParamsModerationAuto ImageGenerateParamsModeration = "auto"
- N param.Field[int64]
  
  The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.
- OutputCompression param.Field[int64]
  
  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.
- OutputFormat param.Field[ImageGenerateParamsOutputFormat]
  
  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.
  - const ImageGenerateParamsOutputFormatPNG ImageGenerateParamsOutputFormat = "png"
  - const ImageGenerateParamsOutputFormatJPEG ImageGenerateParamsOutputFormat = "jpeg"
  - const ImageGenerateParamsOutputFormatWebP ImageGenerateParamsOutputFormat = "webp"
- PartialImages param.Field[int64]
  
  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.
- Quality param.Field[ImageGenerateParamsQuality]
  
  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.
  - const ImageGenerateParamsQualityStandard ImageGenerateParamsQuality = "standard"
  - const ImageGenerateParamsQualityHD ImageGenerateParamsQuality = "hd"
  - const ImageGenerateParamsQualityLow ImageGenerateParamsQuality = "low"
  - const ImageGenerateParamsQualityMedium ImageGenerateParamsQuality = "medium"
  - const ImageGenerateParamsQualityHigh ImageGenerateParamsQuality = "high"
  - const ImageGenerateParamsQualityAuto ImageGenerateParamsQuality = "auto"
- ResponseFormat param.Field[ImageGenerateParamsResponseFormat]
  
  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.
  - const ImageGenerateParamsResponseFormatURL ImageGenerateParamsResponseFormat = "url"
  - const ImageGenerateParamsResponseFormatB64JSON ImageGenerateParamsResponseFormat = "b64_json"
- Size param.Field[string]
  
  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.
- ``
- Style param.Field[ImageGenerateParamsStyle]
  
  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.
  - const ImageGenerateParamsStyleVivid ImageGenerateParamsStyle = "vivid"
  - const ImageGenerateParamsStyleNatural ImageGenerateParamsStyle = "natural"
- User param.Field[string]
  
  A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

Returns

type ImagesResponse struct{…}

The response from the image generation endpoint.
- Created int64
  
  The Unix timestamp (in seconds) of when the image was created.
- Background ImagesResponseBackground
  
  The background parameter used for the image generation. Either transparent or opaque.
  - const ImagesResponseBackgroundTransparent ImagesResponseBackground = "transparent"
  - const ImagesResponseBackgroundOpaque ImagesResponseBackground = "opaque"
- Data []Image
  
  The list of generated images.
  - B64JSON string
    
    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.
  - RevisedPrompt string
    
    For dall-e-3 only, the revised prompt that was used to generate the image.
  - URL string
    
    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.
- OutputFormat ImagesResponseOutputFormat
  
  The output format of the image generation. Either png, webp, or jpeg.
  - const ImagesResponseOutputFormatPNG ImagesResponseOutputFormat = "png"
  - const ImagesResponseOutputFormatWebP ImagesResponseOutputFormat = "webp"
  - const ImagesResponseOutputFormatJPEG ImagesResponseOutputFormat = "jpeg"
- Quality ImagesResponseQuality
  
  The quality of the image generated. Either low, medium, or high.
  - const ImagesResponseQualityLow ImagesResponseQuality = "low"
  - const ImagesResponseQualityMedium ImagesResponseQuality = "medium"
  - const ImagesResponseQualityHigh ImagesResponseQuality = "high"
- Size ImagesResponseSize
  
  The size of the image generated. Either 1024x1024, 1024x1536, or 1536x1024.
  - const ImagesResponseSize1024x1024 ImagesResponseSize = "1024x1024"
  - const ImagesResponseSize1024x1536 ImagesResponseSize = "1024x1536"
  - const ImagesResponseSize1536x1024 ImagesResponseSize = "1536x1024"
- Usage ImagesResponseUsage
  
  For gpt-image-1 only, the token usage information for the image generation.
  - InputTokens int64
    
    The number of tokens (images and text) in the input prompt.
  - InputTokensDetails ImagesResponseUsageInputTokensDetails
    
    The input tokens detailed information for the image generation.
    - ImageTokens int64
      
      The number of image tokens in the input prompt.
    - TextTokens int64
      
      The number of text tokens in the input prompt.
  - OutputTokens int64
    
    The number of output tokens generated by the model.
  - TotalTokens int64
    
    The total number of tokens (images and text) used for the image generation.
  - OutputTokensDetails ImagesResponseUsageOutputTokensDetails
    
    The output token details for the image generation.
    - ImageTokens int64
      
      The number of image output tokens generated by the model.
    - TextTokens int64
      
      The number of text output tokens generated by the model.

Example

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  imagesResponse, err := client.Images.Generate(context.TODO(), openai.ImageGenerateParams{
    Prompt: "A cute baby sea otter",
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", imagesResponse)
}

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

client.Images.Edit(ctx, body) (*ImagesResponse, error)

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

body ImageEditParams
- Image param.Field[ImageEditParamsImageUnion]
  
  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.
  - Reader
  - []Reader
- Prompt param.Field[string]
  
  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.
- Background param.Field[ImageEditParamsBackground]
  
  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.
  - const ImageEditParamsBackgroundTransparent ImageEditParamsBackground = "transparent"
  - const ImageEditParamsBackgroundOpaque ImageEditParamsBackground = "opaque"
  - const ImageEditParamsBackgroundAuto ImageEditParamsBackground = "auto"
- InputFidelity param.Field[ImageEditParamsInputFidelity]
  
  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.
  - const ImageEditParamsInputFidelityHigh ImageEditParamsInputFidelity = "high"
  - const ImageEditParamsInputFidelityLow ImageEditParamsInputFidelity = "low"
- Mask param.Field[Reader]
  
  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.
- Model param.Field[ImageModel]
  
  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.
  - string
  - type ImageModel string
    - const ImageModelGPTImage1 ImageModel = "gpt-image-1"
    - const ImageModelGPTImage1Mini ImageModel = "gpt-image-1-mini"
    - const ImageModelGPTImage2 ImageModel = "gpt-image-2"
    - const ImageModelGPTImage2_2026_04_21 ImageModel = "gpt-image-2-2026-04-21"
    - const ImageModelGPTImage1_5 ImageModel = "gpt-image-1.5"
    - const ImageModelChatgptImageLatest ImageModel = "chatgpt-image-latest"
    - const ImageModelDallE2 ImageModel = "dall-e-2"
    - const ImageModelDallE3 ImageModel = "dall-e-3"
- N param.Field[int64]
  
  The number of images to generate. Must be between 1 and 10.
- OutputCompression param.Field[int64]
  
  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.
- OutputFormat param.Field[ImageEditParamsOutputFormat]
  
  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.
  - const ImageEditParamsOutputFormatPNG ImageEditParamsOutputFormat = "png"
  - const ImageEditParamsOutputFormatJPEG ImageEditParamsOutputFormat = "jpeg"
  - const ImageEditParamsOutputFormatWebP ImageEditParamsOutputFormat = "webp"
- PartialImages param.Field[int64]
  
  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.
- Quality param.Field[ImageEditParamsQuality]
  
  The quality of the image that will be generated for GPT image models. Defaults to auto.
  - const ImageEditParamsQualityStandard ImageEditParamsQuality = "standard"
  - const ImageEditParamsQualityLow ImageEditParamsQuality = "low"
  - const ImageEditParamsQualityMedium ImageEditParamsQuality = "medium"
  - const ImageEditParamsQualityHigh ImageEditParamsQuality = "high"
  - const ImageEditParamsQualityAuto ImageEditParamsQuality = "auto"
- ResponseFormat param.Field[ImageEditParamsResponseFormat]
  
  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.
  - const ImageEditParamsResponseFormatURL ImageEditParamsResponseFormat = "url"
  - const ImageEditParamsResponseFormatB64JSON ImageEditParamsResponseFormat = "b64_json"
- Size param.Field[string]
  
  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.
- ``
- User param.Field[string]
  
  A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

Returns

type ImagesResponse struct{…}

The response from the image generation endpoint.
- Created int64
  
  The Unix timestamp (in seconds) of when the image was created.
- Background ImagesResponseBackground
  
  The background parameter used for the image generation. Either transparent or opaque.
  - const ImagesResponseBackgroundTransparent ImagesResponseBackground = "transparent"
  - const ImagesResponseBackgroundOpaque ImagesResponseBackground = "opaque"
- Data []Image
  
  The list of generated images.
  - B64JSON string
    
    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.
  - RevisedPrompt string
    
    For dall-e-3 only, the revised prompt that was used to generate the image.
  - URL string
    
    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.
- OutputFormat ImagesResponseOutputFormat
  
  The output format of the image generation. Either png, webp, or jpeg.
  - const ImagesResponseOutputFormatPNG ImagesResponseOutputFormat = "png"
  - const ImagesResponseOutputFormatWebP ImagesResponseOutputFormat = "webp"
  - const ImagesResponseOutputFormatJPEG ImagesResponseOutputFormat = "jpeg"
- Quality ImagesResponseQuality
  
  The quality of the image generated. Either low, medium, or high.
  - const ImagesResponseQualityLow ImagesResponseQuality = "low"
  - const ImagesResponseQualityMedium ImagesResponseQuality = "medium"
  - const ImagesResponseQualityHigh ImagesResponseQuality = "high"
- Size ImagesResponseSize
  
  The size of the image generated. Either 1024x1024, 1024x1536, or 1536x1024.
  - const ImagesResponseSize1024x1024 ImagesResponseSize = "1024x1024"
  - const ImagesResponseSize1024x1536 ImagesResponseSize = "1024x1536"
  - const ImagesResponseSize1536x1024 ImagesResponseSize = "1536x1024"
- Usage ImagesResponseUsage
  
  For gpt-image-1 only, the token usage information for the image generation.
  - InputTokens int64
    
    The number of tokens (images and text) in the input prompt.
  - InputTokensDetails ImagesResponseUsageInputTokensDetails
    
    The input tokens detailed information for the image generation.
    - ImageTokens int64
      
      The number of image tokens in the input prompt.
    - TextTokens int64
      
      The number of text tokens in the input prompt.
  - OutputTokens int64
    
    The number of output tokens generated by the model.
  - TotalTokens int64
    
    The total number of tokens (images and text) used for the image generation.
  - OutputTokensDetails ImagesResponseUsageOutputTokensDetails
    
    The output token details for the image generation.
    - ImageTokens int64
      
      The number of image output tokens generated by the model.
    - TextTokens int64
      
      The number of text output tokens generated by the model.

Example

package main

import (
  "bytes"
  "context"
  "fmt"
  "io"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  imagesResponse, err := client.Images.Edit(context.TODO(), openai.ImageEditParams{
    Image: openai.ImageEditParamsImageUnion{
      OfFile: io.Reader(bytes.NewBuffer([]byte("Example data"))),
    },
    Prompt: "A cute baby sea otter wearing a beret",
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", imagesResponse)
}

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

client.Images.NewVariation(ctx, body) (*ImagesResponse, error)

post /images/variations

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

Parameters

body ImageNewVariationParams
- Image param.Field[Reader]
  
  The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.
- Model param.Field[ImageModel]
  
  The model to use for image generation. Only dall-e-2 is supported at this time.
  - string
  - type ImageModel string
    - const ImageModelGPTImage1 ImageModel = "gpt-image-1"
    - const ImageModelGPTImage1Mini ImageModel = "gpt-image-1-mini"
    - const ImageModelGPTImage2 ImageModel = "gpt-image-2"
    - const ImageModelGPTImage2_2026_04_21 ImageModel = "gpt-image-2-2026-04-21"
    - const ImageModelGPTImage1_5 ImageModel = "gpt-image-1.5"
    - const ImageModelChatgptImageLatest ImageModel = "chatgpt-image-latest"
    - const ImageModelDallE2 ImageModel = "dall-e-2"
    - const ImageModelDallE3 ImageModel = "dall-e-3"
- N param.Field[int64]
  
  The number of images to generate. Must be between 1 and 10.
- ResponseFormat param.Field[ImageNewVariationParamsResponseFormat]
  
  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.
  - const ImageNewVariationParamsResponseFormatURL ImageNewVariationParamsResponseFormat = "url"
  - const ImageNewVariationParamsResponseFormatB64JSON ImageNewVariationParamsResponseFormat = "b64_json"
- Size param.Field[ImageNewVariationParamsSize]
  
  The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.
  - const ImageNewVariationParamsSize256x256 ImageNewVariationParamsSize = "256x256"
  - const ImageNewVariationParamsSize512x512 ImageNewVariationParamsSize = "512x512"
  - const ImageNewVariationParamsSize1024x1024 ImageNewVariationParamsSize = "1024x1024"
- User param.Field[string]
  
  A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

Returns

type ImagesResponse struct{…}

The response from the image generation endpoint.
- Created int64
  
  The Unix timestamp (in seconds) of when the image was created.
- Background ImagesResponseBackground
  
  The background parameter used for the image generation. Either transparent or opaque.
  - const ImagesResponseBackgroundTransparent ImagesResponseBackground = "transparent"
  - const ImagesResponseBackgroundOpaque ImagesResponseBackground = "opaque"
- Data []Image
  
  The list of generated images.
  - B64JSON string
    
    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.
  - RevisedPrompt string
    
    For dall-e-3 only, the revised prompt that was used to generate the image.
  - URL string
    
    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.
- OutputFormat ImagesResponseOutputFormat
  
  The output format of the image generation. Either png, webp, or jpeg.
  - const ImagesResponseOutputFormatPNG ImagesResponseOutputFormat = "png"
  - const ImagesResponseOutputFormatWebP ImagesResponseOutputFormat = "webp"
  - const ImagesResponseOutputFormatJPEG ImagesResponseOutputFormat = "jpeg"
- Quality ImagesResponseQuality
  
  The quality of the image generated. Either low, medium, or high.
  - const ImagesResponseQualityLow ImagesResponseQuality = "low"
  - const ImagesResponseQualityMedium ImagesResponseQuality = "medium"
  - const ImagesResponseQualityHigh ImagesResponseQuality = "high"
- Size ImagesResponseSize
  
  The size of the image generated. Either 1024x1024, 1024x1536, or 1536x1024.
  - const ImagesResponseSize1024x1024 ImagesResponseSize = "1024x1024"
  - const ImagesResponseSize1024x1536 ImagesResponseSize = "1024x1536"
  - const ImagesResponseSize1536x1024 ImagesResponseSize = "1536x1024"
- Usage ImagesResponseUsage
  
  For gpt-image-1 only, the token usage information for the image generation.
  - InputTokens int64
    
    The number of tokens (images and text) in the input prompt.
  - InputTokensDetails ImagesResponseUsageInputTokensDetails
    
    The input tokens detailed information for the image generation.
    - ImageTokens int64
      
      The number of image tokens in the input prompt.
    - TextTokens int64
      
      The number of text tokens in the input prompt.
  - OutputTokens int64
    
    The number of output tokens generated by the model.
  - TotalTokens int64
    
    The total number of tokens (images and text) used for the image generation.
  - OutputTokensDetails ImagesResponseUsageOutputTokensDetails
    
    The output token details for the image generation.
    - ImageTokens int64
      
      The number of image output tokens generated by the model.
    - TextTokens int64
      
      The number of text output tokens generated by the model.

Example

package main

import (
  "bytes"
  "context"
  "fmt"
  "io"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/option"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  imagesResponse, err := client.Images.NewVariation(context.TODO(), openai.ImageNewVariationParams{
    Image: io.Reader(bytes.NewBuffer([]byte("Example data"))),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", imagesResponse.Created)
}

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

type Image struct{…}

Represents the content or the URL of an image generated by the OpenAI API.
- B64JSON string
  
  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.
- RevisedPrompt string
  
  For dall-e-3 only, the revised prompt that was used to generate the image.
- URL string
  
  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

type ImageEditCompletedEvent struct{…}

Emitted when image editing has completed and the final image is available.
- B64JSON string
  
  Base64-encoded final edited image data, suitable for rendering as an image.
- Background ImageEditCompletedEventBackground
  
  The background setting for the edited image.
  - const ImageEditCompletedEventBackgroundTransparent ImageEditCompletedEventBackground = "transparent"
  - const ImageEditCompletedEventBackgroundOpaque ImageEditCompletedEventBackground = "opaque"
  - const ImageEditCompletedEventBackgroundAuto ImageEditCompletedEventBackground = "auto"
- CreatedAt int64
  
  The Unix timestamp when the event was created.
- OutputFormat ImageEditCompletedEventOutputFormat
  
  The output format for the edited image.
  - const ImageEditCompletedEventOutputFormatPNG ImageEditCompletedEventOutputFormat = "png"
  - const ImageEditCompletedEventOutputFormatWebP ImageEditCompletedEventOutputFormat = "webp"
  - const ImageEditCompletedEventOutputFormatJPEG ImageEditCompletedEventOutputFormat = "jpeg"
- Quality ImageEditCompletedEventQuality
  
  The quality setting for the edited image.
  - const ImageEditCompletedEventQualityLow ImageEditCompletedEventQuality = "low"
  - const ImageEditCompletedEventQualityMedium ImageEditCompletedEventQuality = "medium"
  - const ImageEditCompletedEventQualityHigh ImageEditCompletedEventQuality = "high"
  - const ImageEditCompletedEventQualityAuto ImageEditCompletedEventQuality = "auto"
- Size ImageEditCompletedEventSize
  
  The size of the edited image.
  - const ImageEditCompletedEventSize1024x1024 ImageEditCompletedEventSize = "1024x1024"
  - const ImageEditCompletedEventSize1024x1536 ImageEditCompletedEventSize = "1024x1536"
  - const ImageEditCompletedEventSize1536x1024 ImageEditCompletedEventSize = "1536x1024"
  - const ImageEditCompletedEventSizeAuto ImageEditCompletedEventSize = "auto"
- Type ImageEditCompleted
  
  The type of the event. Always image_edit.completed.
  - const ImageEditCompletedImageEditCompleted ImageEditCompleted = "image_edit.completed"
- Usage ImageEditCompletedEventUsage
  
  For the GPT image models only, the token usage information for the image generation.
  - InputTokens int64
    
    The number of tokens (images and text) in the input prompt.
  - InputTokensDetails ImageEditCompletedEventUsageInputTokensDetails
    
    The input tokens detailed information for the image generation.
    - ImageTokens int64
      
      The number of image tokens in the input prompt.
    - TextTokens int64
      
      The number of text tokens in the input prompt.
  - OutputTokens int64
    
    The number of image tokens in the output image.
  - TotalTokens int64
    
    The total number of tokens (images and text) used for the image generation.

Image Edit Partial Image Event

type ImageEditPartialImageEvent struct{…}

Emitted when a partial image is available during image editing streaming.
- B64JSON string
  
  Base64-encoded partial image data, suitable for rendering as an image.
- Background ImageEditPartialImageEventBackground
  
  The background setting for the requested edited image.
  - const ImageEditPartialImageEventBackgroundTransparent ImageEditPartialImageEventBackground = "transparent"
  - const ImageEditPartialImageEventBackgroundOpaque ImageEditPartialImageEventBackground = "opaque"
  - const ImageEditPartialImageEventBackgroundAuto ImageEditPartialImageEventBackground = "auto"
- CreatedAt int64
  
  The Unix timestamp when the event was created.
- OutputFormat ImageEditPartialImageEventOutputFormat
  
  The output format for the requested edited image.
  - const ImageEditPartialImageEventOutputFormatPNG ImageEditPartialImageEventOutputFormat = "png"
  - const ImageEditPartialImageEventOutputFormatWebP ImageEditPartialImageEventOutputFormat = "webp"
  - const ImageEditPartialImageEventOutputFormatJPEG ImageEditPartialImageEventOutputFormat = "jpeg"
- PartialImageIndex int64
  
  0-based index for the partial image (streaming).
- Quality ImageEditPartialImageEventQuality
  
  The quality setting for the requested edited image.
  - const ImageEditPartialImageEventQualityLow ImageEditPartialImageEventQuality = "low"
  - const ImageEditPartialImageEventQualityMedium ImageEditPartialImageEventQuality = "medium"
  - const ImageEditPartialImageEventQualityHigh ImageEditPartialImageEventQuality = "high"
  - const ImageEditPartialImageEventQualityAuto ImageEditPartialImageEventQuality = "auto"
- Size ImageEditPartialImageEventSize
  
  The size of the requested edited image.
  - const ImageEditPartialImageEventSize1024x1024 ImageEditPartialImageEventSize = "1024x1024"
  - const ImageEditPartialImageEventSize1024x1536 ImageEditPartialImageEventSize = "1024x1536"
  - const ImageEditPartialImageEventSize1536x1024 ImageEditPartialImageEventSize = "1536x1024"
  - const ImageEditPartialImageEventSizeAuto ImageEditPartialImageEventSize = "auto"
- Type ImageEditPartialImage
  
  The type of the event. Always image_edit.partial_image.
  - const ImageEditPartialImageImageEditPartialImage ImageEditPartialImage = "image_edit.partial_image"

Image Edit Stream Event

type ImageEditStreamEventUnion interface{…}

Emitted when a partial image is available during image editing streaming.
- type ImageEditPartialImageEvent struct{…}
  
  Emitted when a partial image is available during image editing streaming.
  - B64JSON string
    
    Base64-encoded partial image data, suitable for rendering as an image.
  - Background ImageEditPartialImageEventBackground
    
    The background setting for the requested edited image.
    - const ImageEditPartialImageEventBackgroundTransparent ImageEditPartialImageEventBackground = "transparent"
    - const ImageEditPartialImageEventBackgroundOpaque ImageEditPartialImageEventBackground = "opaque"
    - const ImageEditPartialImageEventBackgroundAuto ImageEditPartialImageEventBackground = "auto"
  - CreatedAt int64
    
    The Unix timestamp when the event was created.
  - OutputFormat ImageEditPartialImageEventOutputFormat
    
    The output format for the requested edited image.
    - const ImageEditPartialImageEventOutputFormatPNG ImageEditPartialImageEventOutputFormat = "png"
    - const ImageEditPartialImageEventOutputFormatWebP ImageEditPartialImageEventOutputFormat = "webp"
    - const ImageEditPartialImageEventOutputFormatJPEG ImageEditPartialImageEventOutputFormat = "jpeg"
  - PartialImageIndex int64
    
    0-based index for the partial image (streaming).
  - Quality ImageEditPartialImageEventQuality
    
    The quality setting for the requested edited image.
    - const ImageEditPartialImageEventQualityLow ImageEditPartialImageEventQuality = "low"
    - const ImageEditPartialImageEventQualityMedium ImageEditPartialImageEventQuality = "medium"
    - const ImageEditPartialImageEventQualityHigh ImageEditPartialImageEventQuality = "high"
    - const ImageEditPartialImageEventQualityAuto ImageEditPartialImageEventQuality = "auto"
  - Size ImageEditPartialImageEventSize
    
    The size of the requested edited image.
    - const ImageEditPartialImageEventSize1024x1024 ImageEditPartialImageEventSize = "1024x1024"
    - const ImageEditPartialImageEventSize1024x1536 ImageEditPartialImageEventSize = "1024x1536"
    - const ImageEditPartialImageEventSize1536x1024 ImageEditPartialImageEventSize = "1536x1024"
    - const ImageEditPartialImageEventSizeAuto ImageEditPartialImageEventSize = "auto"
  - Type ImageEditPartialImage
    
    The type of the event. Always image_edit.partial_image.
    - const ImageEditPartialImageImageEditPartialImage ImageEditPartialImage = "image_edit.partial_image"
- type ImageEditCompletedEvent struct{…}
  
  Emitted when image editing has completed and the final image is available.
  - B64JSON string
    
    Base64-encoded final edited image data, suitable for rendering as an image.
  - Background ImageEditCompletedEventBackground
    
    The background setting for the edited image.
    - const ImageEditCompletedEventBackgroundTransparent ImageEditCompletedEventBackground = "transparent"
    - const ImageEditCompletedEventBackgroundOpaque ImageEditCompletedEventBackground = "opaque"
    - const ImageEditCompletedEventBackgroundAuto ImageEditCompletedEventBackground = "auto"
  - CreatedAt int64
    
    The Unix timestamp when the event was created.
  - OutputFormat ImageEditCompletedEventOutputFormat
    
    The output format for the edited image.
    - const ImageEditCompletedEventOutputFormatPNG ImageEditCompletedEventOutputFormat = "png"
    - const ImageEditCompletedEventOutputFormatWebP ImageEditCompletedEventOutputFormat = "webp"
    - const ImageEditCompletedEventOutputFormatJPEG ImageEditCompletedEventOutputFormat = "jpeg"
  - Quality ImageEditCompletedEventQuality
    
    The quality setting for the edited image.
    - const ImageEditCompletedEventQualityLow ImageEditCompletedEventQuality = "low"
    - const ImageEditCompletedEventQualityMedium ImageEditCompletedEventQuality = "medium"
    - const ImageEditCompletedEventQualityHigh ImageEditCompletedEventQuality = "high"
    - const ImageEditCompletedEventQualityAuto ImageEditCompletedEventQuality = "auto"
  - Size ImageEditCompletedEventSize
    
    The size of the edited image.
    - const ImageEditCompletedEventSize1024x1024 ImageEditCompletedEventSize = "1024x1024"
    - const ImageEditCompletedEventSize1024x1536 ImageEditCompletedEventSize = "1024x1536"
    - const ImageEditCompletedEventSize1536x1024 ImageEditCompletedEventSize = "1536x1024"
    - const ImageEditCompletedEventSizeAuto ImageEditCompletedEventSize = "auto"
  - Type ImageEditCompleted
    
    The type of the event. Always image_edit.completed.
    - const ImageEditCompletedImageEditCompleted ImageEditCompleted = "image_edit.completed"
  - Usage ImageEditCompletedEventUsage
    
    For the GPT image models only, the token usage information for the image generation.
    - InputTokens int64
      
      The number of tokens (images and text) in the input prompt.
    - InputTokensDetails ImageEditCompletedEventUsageInputTokensDetails
      
      The input tokens detailed information for the image generation.
      - ImageTokens int64
        
        The number of image tokens in the input prompt.
      - TextTokens int64
        
        The number of text tokens in the input prompt.
    - OutputTokens int64
      
      The number of image tokens in the output image.
    - TotalTokens int64
      
      The total number of tokens (images and text) used for the image generation.

Image Gen Completed Event

type ImageGenCompletedEvent struct{…}

Emitted when image generation has completed and the final image is available.
- B64JSON string
  
  Base64-encoded image data, suitable for rendering as an image.
- Background ImageGenCompletedEventBackground
  
  The background setting for the generated image.
  - const ImageGenCompletedEventBackgroundTransparent ImageGenCompletedEventBackground = "transparent"
  - const ImageGenCompletedEventBackgroundOpaque ImageGenCompletedEventBackground = "opaque"
  - const ImageGenCompletedEventBackgroundAuto ImageGenCompletedEventBackground = "auto"
- CreatedAt int64
  
  The Unix timestamp when the event was created.
- OutputFormat ImageGenCompletedEventOutputFormat
  
  The output format for the generated image.
  - const ImageGenCompletedEventOutputFormatPNG ImageGenCompletedEventOutputFormat = "png"
  - const ImageGenCompletedEventOutputFormatWebP ImageGenCompletedEventOutputFormat = "webp"
  - const ImageGenCompletedEventOutputFormatJPEG ImageGenCompletedEventOutputFormat = "jpeg"
- Quality ImageGenCompletedEventQuality
  
  The quality setting for the generated image.
  - const ImageGenCompletedEventQualityLow ImageGenCompletedEventQuality = "low"
  - const ImageGenCompletedEventQualityMedium ImageGenCompletedEventQuality = "medium"
  - const ImageGenCompletedEventQualityHigh ImageGenCompletedEventQuality = "high"
  - const ImageGenCompletedEventQualityAuto ImageGenCompletedEventQuality = "auto"
- Size ImageGenCompletedEventSize
  
  The size of the generated image.
  - const ImageGenCompletedEventSize1024x1024 ImageGenCompletedEventSize = "1024x1024"
  - const ImageGenCompletedEventSize1024x1536 ImageGenCompletedEventSize = "1024x1536"
  - const ImageGenCompletedEventSize1536x1024 ImageGenCompletedEventSize = "1536x1024"
  - const ImageGenCompletedEventSizeAuto ImageGenCompletedEventSize = "auto"
- Type ImageGenerationCompleted
  
  The type of the event. Always image_generation.completed.
  - const ImageGenerationCompletedImageGenerationCompleted ImageGenerationCompleted = "image_generation.completed"
- Usage ImageGenCompletedEventUsage
  
  For the GPT image models only, the token usage information for the image generation.
  - InputTokens int64
    
    The number of tokens (images and text) in the input prompt.
  - InputTokensDetails ImageGenCompletedEventUsageInputTokensDetails
    
    The input tokens detailed information for the image generation.
    - ImageTokens int64
      
      The number of image tokens in the input prompt.
    - TextTokens int64
      
      The number of text tokens in the input prompt.
  - OutputTokens int64
    
    The number of image tokens in the output image.
  - TotalTokens int64
    
    The total number of tokens (images and text) used for the image generation.

Image Gen Partial Image Event

type ImageGenPartialImageEvent struct{…}

Emitted when a partial image is available during image generation streaming.
- B64JSON string
  
  Base64-encoded partial image data, suitable for rendering as an image.
- Background ImageGenPartialImageEventBackground
  
  The background setting for the requested image.
  - const ImageGenPartialImageEventBackgroundTransparent ImageGenPartialImageEventBackground = "transparent"
  - const ImageGenPartialImageEventBackgroundOpaque ImageGenPartialImageEventBackground = "opaque"
  - const ImageGenPartialImageEventBackgroundAuto ImageGenPartialImageEventBackground = "auto"
- CreatedAt int64
  
  The Unix timestamp when the event was created.
- OutputFormat ImageGenPartialImageEventOutputFormat
  
  The output format for the requested image.
  - const ImageGenPartialImageEventOutputFormatPNG ImageGenPartialImageEventOutputFormat = "png"
  - const ImageGenPartialImageEventOutputFormatWebP ImageGenPartialImageEventOutputFormat = "webp"
  - const ImageGenPartialImageEventOutputFormatJPEG ImageGenPartialImageEventOutputFormat = "jpeg"
- PartialImageIndex int64
  
  0-based index for the partial image (streaming).
- Quality ImageGenPartialImageEventQuality
  
  The quality setting for the requested image.
  - const ImageGenPartialImageEventQualityLow ImageGenPartialImageEventQuality = "low"
  - const ImageGenPartialImageEventQualityMedium ImageGenPartialImageEventQuality = "medium"
  - const ImageGenPartialImageEventQualityHigh ImageGenPartialImageEventQuality = "high"
  - const ImageGenPartialImageEventQualityAuto ImageGenPartialImageEventQuality = "auto"
- Size ImageGenPartialImageEventSize
  
  The size of the requested image.
  - const ImageGenPartialImageEventSize1024x1024 ImageGenPartialImageEventSize = "1024x1024"
  - const ImageGenPartialImageEventSize1024x1536 ImageGenPartialImageEventSize = "1024x1536"
  - const ImageGenPartialImageEventSize1536x1024 ImageGenPartialImageEventSize = "1536x1024"
  - const ImageGenPartialImageEventSizeAuto ImageGenPartialImageEventSize = "auto"
- Type ImageGenerationPartialImage
  
  The type of the event. Always image_generation.partial_image.
  - const ImageGenerationPartialImageImageGenerationPartialImage ImageGenerationPartialImage = "image_generation.partial_image"

Image Gen Stream Event

type ImageGenStreamEventUnion interface{…}

Emitted when a partial image is available during image generation streaming.
- type ImageGenPartialImageEvent struct{…}
  
  Emitted when a partial image is available during image generation streaming.
  - B64JSON string
    
    Base64-encoded partial image data, suitable for rendering as an image.
  - Background ImageGenPartialImageEventBackground
    
    The background setting for the requested image.
    - const ImageGenPartialImageEventBackgroundTransparent ImageGenPartialImageEventBackground = "transparent"
    - const ImageGenPartialImageEventBackgroundOpaque ImageGenPartialImageEventBackground = "opaque"
    - const ImageGenPartialImageEventBackgroundAuto ImageGenPartialImageEventBackground = "auto"
  - CreatedAt int64
    
    The Unix timestamp when the event was created.
  - OutputFormat ImageGenPartialImageEventOutputFormat
    
    The output format for the requested image.
    - const ImageGenPartialImageEventOutputFormatPNG ImageGenPartialImageEventOutputFormat = "png"
    - const ImageGenPartialImageEventOutputFormatWebP ImageGenPartialImageEventOutputFormat = "webp"
    - const ImageGenPartialImageEventOutputFormatJPEG ImageGenPartialImageEventOutputFormat = "jpeg"
  - PartialImageIndex int64
    
    0-based index for the partial image (streaming).
  - Quality ImageGenPartialImageEventQuality
    
    The quality setting for the requested image.
    - const ImageGenPartialImageEventQualityLow ImageGenPartialImageEventQuality = "low"
    - const ImageGenPartialImageEventQualityMedium ImageGenPartialImageEventQuality = "medium"
    - const ImageGenPartialImageEventQualityHigh ImageGenPartialImageEventQuality = "high"
    - const ImageGenPartialImageEventQualityAuto ImageGenPartialImageEventQuality = "auto"
  - Size ImageGenPartialImageEventSize
    
    The size of the requested image.
    - const ImageGenPartialImageEventSize1024x1024 ImageGenPartialImageEventSize = "1024x1024"
    - const ImageGenPartialImageEventSize1024x1536 ImageGenPartialImageEventSize = "1024x1536"
    - const ImageGenPartialImageEventSize1536x1024 ImageGenPartialImageEventSize = "1536x1024"
    - const ImageGenPartialImageEventSizeAuto ImageGenPartialImageEventSize = "auto"
  - Type ImageGenerationPartialImage
    
    The type of the event. Always image_generation.partial_image.
    - const ImageGenerationPartialImageImageGenerationPartialImage ImageGenerationPartialImage = "image_generation.partial_image"
- type ImageGenCompletedEvent struct{…}
  
  Emitted when image generation has completed and the final image is available.
  - B64JSON string
    
    Base64-encoded image data, suitable for rendering as an image.
  - Background ImageGenCompletedEventBackground
    
    The background setting for the generated image.
    - const ImageGenCompletedEventBackgroundTransparent ImageGenCompletedEventBackground = "transparent"
    - const ImageGenCompletedEventBackgroundOpaque ImageGenCompletedEventBackground = "opaque"
    - const ImageGenCompletedEventBackgroundAuto ImageGenCompletedEventBackground = "auto"
  - CreatedAt int64
    
    The Unix timestamp when the event was created.
  - OutputFormat ImageGenCompletedEventOutputFormat
    
    The output format for the generated image.
    - const ImageGenCompletedEventOutputFormatPNG ImageGenCompletedEventOutputFormat = "png"
    - const ImageGenCompletedEventOutputFormatWebP ImageGenCompletedEventOutputFormat = "webp"
    - const ImageGenCompletedEventOutputFormatJPEG ImageGenCompletedEventOutputFormat = "jpeg"
  - Quality ImageGenCompletedEventQuality
    
    The quality setting for the generated image.
    - const ImageGenCompletedEventQualityLow ImageGenCompletedEventQuality = "low"
    - const ImageGenCompletedEventQualityMedium ImageGenCompletedEventQuality = "medium"
    - const ImageGenCompletedEventQualityHigh ImageGenCompletedEventQuality = "high"
    - const ImageGenCompletedEventQualityAuto ImageGenCompletedEventQuality = "auto"
  - Size ImageGenCompletedEventSize
    
    The size of the generated image.
    - const ImageGenCompletedEventSize1024x1024 ImageGenCompletedEventSize = "1024x1024"
    - const ImageGenCompletedEventSize1024x1536 ImageGenCompletedEventSize = "1024x1536"
    - const ImageGenCompletedEventSize1536x1024 ImageGenCompletedEventSize = "1536x1024"
    - const ImageGenCompletedEventSizeAuto ImageGenCompletedEventSize = "auto"
  - Type ImageGenerationCompleted
    
    The type of the event. Always image_generation.completed.
    - const ImageGenerationCompletedImageGenerationCompleted ImageGenerationCompleted = "image_generation.completed"
  - Usage ImageGenCompletedEventUsage
    
    For the GPT image models only, the token usage information for the image generation.
    - InputTokens int64
      
      The number of tokens (images and text) in the input prompt.
    - InputTokensDetails ImageGenCompletedEventUsageInputTokensDetails
      
      The input tokens detailed information for the image generation.
      - ImageTokens int64
        
        The number of image tokens in the input prompt.
      - TextTokens int64
        
        The number of text tokens in the input prompt.
    - OutputTokens int64
      
      The number of image tokens in the output image.
    - TotalTokens int64
      
      The total number of tokens (images and text) used for the image generation.

Image Model

type ImageModel string
- const ImageModelGPTImage1 ImageModel = "gpt-image-1"
- const ImageModelGPTImage1Mini ImageModel = "gpt-image-1-mini"
- const ImageModelGPTImage2 ImageModel = "gpt-image-2"
- const ImageModelGPTImage2_2026_04_21 ImageModel = "gpt-image-2-2026-04-21"
- const ImageModelGPTImage1_5 ImageModel = "gpt-image-1.5"
- const ImageModelChatgptImageLatest ImageModel = "chatgpt-image-latest"
- const ImageModelDallE2 ImageModel = "dall-e-2"
- const ImageModelDallE3 ImageModel = "dall-e-3"

Images Response

type ImagesResponse struct{…}

The response from the image generation endpoint.
- Created int64
  
  The Unix timestamp (in seconds) of when the image was created.
- Background ImagesResponseBackground
  
  The background parameter used for the image generation. Either transparent or opaque.
  - const ImagesResponseBackgroundTransparent ImagesResponseBackground = "transparent"
  - const ImagesResponseBackgroundOpaque ImagesResponseBackground = "opaque"
- Data []Image
  
  The list of generated images.
  - B64JSON string
    
    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.
  - RevisedPrompt string
    
    For dall-e-3 only, the revised prompt that was used to generate the image.
  - URL string
    
    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.
- OutputFormat ImagesResponseOutputFormat
  
  The output format of the image generation. Either png, webp, or jpeg.
  - const ImagesResponseOutputFormatPNG ImagesResponseOutputFormat = "png"
  - const ImagesResponseOutputFormatWebP ImagesResponseOutputFormat = "webp"
  - const ImagesResponseOutputFormatJPEG ImagesResponseOutputFormat = "jpeg"
- Quality ImagesResponseQuality
  
  The quality of the image generated. Either low, medium, or high.
  - const ImagesResponseQualityLow ImagesResponseQuality = "low"
  - const ImagesResponseQualityMedium ImagesResponseQuality = "medium"
  - const ImagesResponseQualityHigh ImagesResponseQuality = "high"
- Size ImagesResponseSize
  
  The size of the image generated. Either 1024x1024, 1024x1536, or 1536x1024.
  - const ImagesResponseSize1024x1024 ImagesResponseSize = "1024x1024"
  - const ImagesResponseSize1024x1536 ImagesResponseSize = "1024x1536"
  - const ImagesResponseSize1536x1024 ImagesResponseSize = "1536x1024"
- Usage ImagesResponseUsage
  
  For gpt-image-1 only, the token usage information for the image generation.
  - InputTokens int64
    
    The number of tokens (images and text) in the input prompt.
  - InputTokensDetails ImagesResponseUsageInputTokensDetails
    
    The input tokens detailed information for the image generation.
    - ImageTokens int64
      
      The number of image tokens in the input prompt.
    - TextTokens int64
      
      The number of text tokens in the input prompt.
  - OutputTokens int64
    
    The number of output tokens generated by the model.
  - TotalTokens int64
    
    The total number of tokens (images and text) used for the image generation.
  - OutputTokensDetails ImagesResponseUsageOutputTokensDetails
    
    The output token details for the image generation.
    - ImageTokens int64
      
      The number of image output tokens generated by the model.
    - TextTokens int64
      
      The number of text output tokens generated by the model.

go/resources/images/index.md +1648 −0 created

1# Images

3## Create image

5`client.Images.Generate(ctx, body) (*ImagesResponse, error)`

7**post** `/images/generations`

9Creates an image given a prompt. [Learn more](https://platform.openai.com/docs/guides/images).

11### Parameters

13- `body ImageGenerateParams`

15 - `Prompt param.Field[string]`

17 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`.

19 - `Background param.Field[ImageGenerateParamsBackground]`

21 Allows to set transparency for the background of the generated image(s).

22 This parameter is only supported for GPT image models that support

23 transparent backgrounds. Must be one of `transparent`, `opaque`, or

24 `auto` (default value). When `auto` is used, the model will

25 automatically determine the best background for the image.

27 `gpt-image-2` and `gpt-image-2-2026-04-21` do not support

28 transparent backgrounds. Requests with `background` set to

29 `transparent` will return an error for these models; use `opaque` or

30 `auto` instead.

32 If `transparent`, the output format needs to support transparency,

33 so it should be set to either `png` (default value) or `webp`.

35 - `const ImageGenerateParamsBackgroundTransparent ImageGenerateParamsBackground = "transparent"`

37 - `const ImageGenerateParamsBackgroundOpaque ImageGenerateParamsBackground = "opaque"`

39 - `const ImageGenerateParamsBackgroundAuto ImageGenerateParamsBackground = "auto"`

41 - `Model param.Field[ImageModel]`

43 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.

45 - `string`

47 - `type ImageModel string`

49 - `const ImageModelGPTImage1 ImageModel = "gpt-image-1"`

51 - `const ImageModelGPTImage1Mini ImageModel = "gpt-image-1-mini"`

53 - `const ImageModelGPTImage2 ImageModel = "gpt-image-2"`

55 - `const ImageModelGPTImage2_2026_04_21 ImageModel = "gpt-image-2-2026-04-21"`

57 - `const ImageModelGPTImage1_5 ImageModel = "gpt-image-1.5"`

59 - `const ImageModelChatgptImageLatest ImageModel = "chatgpt-image-latest"`

61 - `const ImageModelDallE2 ImageModel = "dall-e-2"`

63 - `const ImageModelDallE3 ImageModel = "dall-e-3"`

65 - `Moderation param.Field[ImageGenerateParamsModeration]`

67 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).

69 - `const ImageGenerateParamsModerationLow ImageGenerateParamsModeration = "low"`

71 - `const ImageGenerateParamsModerationAuto ImageGenerateParamsModeration = "auto"`

73 - `N param.Field[int64]`

75 The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported.

77 - `OutputCompression param.Field[int64]`

79 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.

81 - `OutputFormat param.Field[ImageGenerateParamsOutputFormat]`

83 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`.

85 - `const ImageGenerateParamsOutputFormatPNG ImageGenerateParamsOutputFormat = "png"`

87 - `const ImageGenerateParamsOutputFormatJPEG ImageGenerateParamsOutputFormat = "jpeg"`

89 - `const ImageGenerateParamsOutputFormatWebP ImageGenerateParamsOutputFormat = "webp"`

91 - `PartialImages param.Field[int64]`

93 The number of partial images to generate. This parameter is used for

94 streaming responses that return partial images. Value must be between 0 and 3.

95 When set to 0, the response will be a single image sent in one streaming event.

97 Note that the final image may be sent before the full number of partial images

98 are generated if the full image is generated more quickly.

100 - `Quality param.Field[ImageGenerateParamsQuality]`

101

102 The quality of the image that will be generated.

103

104 - `auto` (default value) will automatically select the best quality for the given model.

105 - `high`, `medium` and `low` are supported for the GPT image models.

106 - `hd` and `standard` are supported for `dall-e-3`.

107 - `standard` is the only option for `dall-e-2`.

108

109 - `const ImageGenerateParamsQualityStandard ImageGenerateParamsQuality = "standard"`

110

111 - `const ImageGenerateParamsQualityHD ImageGenerateParamsQuality = "hd"`

112

113 - `const ImageGenerateParamsQualityLow ImageGenerateParamsQuality = "low"`

114

115 - `const ImageGenerateParamsQualityMedium ImageGenerateParamsQuality = "medium"`

116

117 - `const ImageGenerateParamsQualityHigh ImageGenerateParamsQuality = "high"`

118

119 - `const ImageGenerateParamsQualityAuto ImageGenerateParamsQuality = "auto"`

120

121 - `ResponseFormat param.Field[ImageGenerateParamsResponseFormat]`

122

123 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.

124

125 - `const ImageGenerateParamsResponseFormatURL ImageGenerateParamsResponseFormat = "url"`

126

127 - `const ImageGenerateParamsResponseFormatB64JSON ImageGenerateParamsResponseFormat = "b64_json"`

128

129 - `Size param.Field[string]`

130

131 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`.

132

133 - ``

134

135 - `Style param.Field[ImageGenerateParamsStyle]`

136

137 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.

138

139 - `const ImageGenerateParamsStyleVivid ImageGenerateParamsStyle = "vivid"`

140

141 - `const ImageGenerateParamsStyleNatural ImageGenerateParamsStyle = "natural"`

142

143 - `User param.Field[string]`

144

145 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).

146

147### Returns

148

149- `type ImagesResponse struct{…}`

150

151 The response from the image generation endpoint.

152

153 - `Created int64`

154

155 The Unix timestamp (in seconds) of when the image was created.

156

157 - `Background ImagesResponseBackground`

158

159 The background parameter used for the image generation. Either `transparent` or `opaque`.

160

161 - `const ImagesResponseBackgroundTransparent ImagesResponseBackground = "transparent"`

162

163 - `const ImagesResponseBackgroundOpaque ImagesResponseBackground = "opaque"`

164

165 - `Data []Image`

166

167 The list of generated images.

168

169 - `B64JSON string`

170

171 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`.

172

173 - `RevisedPrompt string`

174

175 For `dall-e-3` only, the revised prompt that was used to generate the image.

176

177 - `URL string`

178

179 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.

180

181 - `OutputFormat ImagesResponseOutputFormat`

182

183 The output format of the image generation. Either `png`, `webp`, or `jpeg`.

184

185 - `const ImagesResponseOutputFormatPNG ImagesResponseOutputFormat = "png"`

186

187 - `const ImagesResponseOutputFormatWebP ImagesResponseOutputFormat = "webp"`

188

189 - `const ImagesResponseOutputFormatJPEG ImagesResponseOutputFormat = "jpeg"`

190

191 - `Quality ImagesResponseQuality`

192

193 The quality of the image generated. Either `low`, `medium`, or `high`.

194

195 - `const ImagesResponseQualityLow ImagesResponseQuality = "low"`

196

197 - `const ImagesResponseQualityMedium ImagesResponseQuality = "medium"`

198

199 - `const ImagesResponseQualityHigh ImagesResponseQuality = "high"`

200

201 - `Size ImagesResponseSize`

202

203 The size of the image generated. Either `1024x1024`, `1024x1536`, or `1536x1024`.

204

205 - `const ImagesResponseSize1024x1024 ImagesResponseSize = "1024x1024"`

206

207 - `const ImagesResponseSize1024x1536 ImagesResponseSize = "1024x1536"`

208

209 - `const ImagesResponseSize1536x1024 ImagesResponseSize = "1536x1024"`

210

211 - `Usage ImagesResponseUsage`

212

213 For `gpt-image-1` only, the token usage information for the image generation.

214

215 - `InputTokens int64`

216

217 The number of tokens (images and text) in the input prompt.

218

219 - `InputTokensDetails ImagesResponseUsageInputTokensDetails`

220

221 The input tokens detailed information for the image generation.

222

223 - `ImageTokens int64`

224

225 The number of image tokens in the input prompt.

226

227 - `TextTokens int64`

228

229 The number of text tokens in the input prompt.

230

231 - `OutputTokens int64`

232

233 The number of output tokens generated by the model.

234

235 - `TotalTokens int64`

236

237 The total number of tokens (images and text) used for the image generation.

238

239 - `OutputTokensDetails ImagesResponseUsageOutputTokensDetails`

240

241 The output token details for the image generation.

242

243 - `ImageTokens int64`

244

245 The number of image output tokens generated by the model.

246

247 - `TextTokens int64`

248

249 The number of text output tokens generated by the model.

250

251### Example

252

253```go

254package main

255

256import (

257 "context"

258 "fmt"

259

260 "github.com/openai/openai-go"

261 "github.com/openai/openai-go/option"

262)

263

264func main() {

265 client := openai.NewClient(

266 option.WithAPIKey("My API Key"),

267 )

268 imagesResponse, err := client.Images.Generate(context.TODO(), openai.ImageGenerateParams{

269 Prompt: "A cute baby sea otter",

270 })

271 if err != nil {

272 panic(err.Error())

273 }

274 fmt.Printf("%+v\n", imagesResponse)

275}

276```

277

278#### Response

279

280```json

281{

282 "created": 0,

283 "background": "transparent",

284 "data": [

285 {

286 "b64_json": "b64_json",

287 "revised_prompt": "revised_prompt",

288 "url": "https://example.com"

289 }

290 ],

291 "output_format": "png",

292 "quality": "low",

293 "size": "1024x1024",

294 "usage": {

295 "input_tokens": 0,

296 "input_tokens_details": {

297 "image_tokens": 0,

298 "text_tokens": 0

299 },

300 "output_tokens": 0,

301 "total_tokens": 0,

302 "output_tokens_details": {

303 "image_tokens": 0,

304 "text_tokens": 0

305 }

306 }

307}

308```

309

310## Create image edit

311

312`client.Images.Edit(ctx, body) (*ImagesResponse, error)`

313

314**post** `/images/edits`

315

316Creates 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`.

317

318### Parameters

319

320- `body ImageEditParams`

321

322 - `Image param.Field[ImageEditParamsImageUnion]`

323

324 The image(s) to edit. Must be a supported image file or an array of images.

325

326 For the GPT image models (`gpt-image-1`, `gpt-image-1-mini`,

327 `gpt-image-1.5`, `gpt-image-2`, `gpt-image-2-2026-04-21`, and

328 `chatgpt-image-latest`), each image should be a `png`, `webp`, or

329 `jpg` file less than 50MB. You can provide up to 16 images.

330

331 For `dall-e-2`, you can only provide one image, and it should be a

332 square `png` file less than 4MB.

333

334 - `Reader`

335

336 - `[]Reader`

337

338 - `Prompt param.Field[string]`

339

340 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.

341

342 - `Background param.Field[ImageEditParamsBackground]`

343

344 Allows to set transparency for the background of the generated image(s).

345 This parameter is only supported for GPT image models that support

346 transparent backgrounds. Must be one of `transparent`, `opaque`, or

347 `auto` (default value). When `auto` is used, the model will

348 automatically determine the best background for the image.

349

350 `gpt-image-2` and `gpt-image-2-2026-04-21` do not support

351 transparent backgrounds. Requests with `background` set to

352 `transparent` will return an error for these models; use `opaque` or

353 `auto` instead.

354

355 If `transparent`, the output format needs to support transparency,

356 so it should be set to either `png` (default value) or `webp`.

357

358 - `const ImageEditParamsBackgroundTransparent ImageEditParamsBackground = "transparent"`

359

360 - `const ImageEditParamsBackgroundOpaque ImageEditParamsBackground = "opaque"`

361

362 - `const ImageEditParamsBackgroundAuto ImageEditParamsBackground = "auto"`

363

364 - `InputFidelity param.Field[ImageEditParamsInputFidelity]`

365

366 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`.

367

368 - `const ImageEditParamsInputFidelityHigh ImageEditParamsInputFidelity = "high"`

369

370 - `const ImageEditParamsInputFidelityLow ImageEditParamsInputFidelity = "low"`

371

372 - `Mask param.Field[Reader]`

373

374 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`.

375

376 - `Model param.Field[ImageModel]`

377

378 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`.

379

380 - `string`

381

382 - `type ImageModel string`

383

384 - `const ImageModelGPTImage1 ImageModel = "gpt-image-1"`

385

386 - `const ImageModelGPTImage1Mini ImageModel = "gpt-image-1-mini"`

387

388 - `const ImageModelGPTImage2 ImageModel = "gpt-image-2"`

389

390 - `const ImageModelGPTImage2_2026_04_21 ImageModel = "gpt-image-2-2026-04-21"`

391

392 - `const ImageModelGPTImage1_5 ImageModel = "gpt-image-1.5"`

393

394 - `const ImageModelChatgptImageLatest ImageModel = "chatgpt-image-latest"`

395

396 - `const ImageModelDallE2 ImageModel = "dall-e-2"`

397

398 - `const ImageModelDallE3 ImageModel = "dall-e-3"`

399

400 - `N param.Field[int64]`

401

402 The number of images to generate. Must be between 1 and 10.

403

404 - `OutputCompression param.Field[int64]`

405

406 The compression level (0-100%) for the generated images. This parameter

407 is only supported for the GPT image models with the `webp` or `jpeg` output

408 formats, and defaults to 100.

409

410 - `OutputFormat param.Field[ImageEditParamsOutputFormat]`

411

412 The format in which the generated images are returned. This parameter is

413 only supported for the GPT image models. Must be one of `png`, `jpeg`, or `webp`.

414 The default value is `png`.

415

416 - `const ImageEditParamsOutputFormatPNG ImageEditParamsOutputFormat = "png"`

417

418 - `const ImageEditParamsOutputFormatJPEG ImageEditParamsOutputFormat = "jpeg"`

419

420 - `const ImageEditParamsOutputFormatWebP ImageEditParamsOutputFormat = "webp"`

421

422 - `PartialImages param.Field[int64]`

423

424 The number of partial images to generate. This parameter is used for

425 streaming responses that return partial images. Value must be between 0 and 3.

426 When set to 0, the response will be a single image sent in one streaming event.

427

428 Note that the final image may be sent before the full number of partial images

429 are generated if the full image is generated more quickly.

430

431 - `Quality param.Field[ImageEditParamsQuality]`

432

433 The quality of the image that will be generated for GPT image models. Defaults to `auto`.

434

435 - `const ImageEditParamsQualityStandard ImageEditParamsQuality = "standard"`

436

437 - `const ImageEditParamsQualityLow ImageEditParamsQuality = "low"`

438

439 - `const ImageEditParamsQualityMedium ImageEditParamsQuality = "medium"`

440

441 - `const ImageEditParamsQualityHigh ImageEditParamsQuality = "high"`

442

443 - `const ImageEditParamsQualityAuto ImageEditParamsQuality = "auto"`

444

445 - `ResponseFormat param.Field[ImageEditParamsResponseFormat]`

446

447 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.

448

449 - `const ImageEditParamsResponseFormatURL ImageEditParamsResponseFormat = "url"`

450

451 - `const ImageEditParamsResponseFormatB64JSON ImageEditParamsResponseFormat = "b64_json"`

452

453 - `Size param.Field[string]`

454

455 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`.

456

457 - ``

458

459 - `User param.Field[string]`

460

461 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).

462

463### Returns

464

465- `type ImagesResponse struct{…}`

466

467 The response from the image generation endpoint.

468

469 - `Created int64`

470

471 The Unix timestamp (in seconds) of when the image was created.

472

473 - `Background ImagesResponseBackground`

474

475 The background parameter used for the image generation. Either `transparent` or `opaque`.

476

477 - `const ImagesResponseBackgroundTransparent ImagesResponseBackground = "transparent"`

478

479 - `const ImagesResponseBackgroundOpaque ImagesResponseBackground = "opaque"`

480

481 - `Data []Image`

482

483 The list of generated images.

484

485 - `B64JSON string`

486

487 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`.

488

489 - `RevisedPrompt string`

490

491 For `dall-e-3` only, the revised prompt that was used to generate the image.

492

493 - `URL string`

494

495 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.

496

497 - `OutputFormat ImagesResponseOutputFormat`

498

499 The output format of the image generation. Either `png`, `webp`, or `jpeg`.

500

501 - `const ImagesResponseOutputFormatPNG ImagesResponseOutputFormat = "png"`

502

503 - `const ImagesResponseOutputFormatWebP ImagesResponseOutputFormat = "webp"`

504

505 - `const ImagesResponseOutputFormatJPEG ImagesResponseOutputFormat = "jpeg"`

506

507 - `Quality ImagesResponseQuality`

508

509 The quality of the image generated. Either `low`, `medium`, or `high`.

510

511 - `const ImagesResponseQualityLow ImagesResponseQuality = "low"`

512

513 - `const ImagesResponseQualityMedium ImagesResponseQuality = "medium"`

514

515 - `const ImagesResponseQualityHigh ImagesResponseQuality = "high"`

516

517 - `Size ImagesResponseSize`

518

519 The size of the image generated. Either `1024x1024`, `1024x1536`, or `1536x1024`.

520

521 - `const ImagesResponseSize1024x1024 ImagesResponseSize = "1024x1024"`

522

523 - `const ImagesResponseSize1024x1536 ImagesResponseSize = "1024x1536"`

524

525 - `const ImagesResponseSize1536x1024 ImagesResponseSize = "1536x1024"`

526

527 - `Usage ImagesResponseUsage`

528

529 For `gpt-image-1` only, the token usage information for the image generation.

530

531 - `InputTokens int64`

532

533 The number of tokens (images and text) in the input prompt.

534

535 - `InputTokensDetails ImagesResponseUsageInputTokensDetails`

536

537 The input tokens detailed information for the image generation.

538

539 - `ImageTokens int64`

540

541 The number of image tokens in the input prompt.

542

543 - `TextTokens int64`

544

545 The number of text tokens in the input prompt.

546

547 - `OutputTokens int64`

548

549 The number of output tokens generated by the model.

550

551 - `TotalTokens int64`

552

553 The total number of tokens (images and text) used for the image generation.

554

555 - `OutputTokensDetails ImagesResponseUsageOutputTokensDetails`

556

557 The output token details for the image generation.

558

559 - `ImageTokens int64`

560

561 The number of image output tokens generated by the model.

562

563 - `TextTokens int64`

564

565 The number of text output tokens generated by the model.

566

567### Example

568

569```go

570package main

571

572import (

573 "bytes"

574 "context"

575 "fmt"

576 "io"

577

578 "github.com/openai/openai-go"

579 "github.com/openai/openai-go/option"

580)

581

582func main() {

583 client := openai.NewClient(

584 option.WithAPIKey("My API Key"),

585 )

586 imagesResponse, err := client.Images.Edit(context.TODO(), openai.ImageEditParams{

587 Image: openai.ImageEditParamsImageUnion{

588 OfFile: io.Reader(bytes.NewBuffer([]byte("Example data"))),

589 },

590 Prompt: "A cute baby sea otter wearing a beret",

591 })

592 if err != nil {

593 panic(err.Error())

594 }

595 fmt.Printf("%+v\n", imagesResponse)

596}

597```

598

599#### Response

600

601```json

602{

603 "created": 0,

604 "background": "transparent",

605 "data": [

606 {

607 "b64_json": "b64_json",

608 "revised_prompt": "revised_prompt",

609 "url": "https://example.com"

610 }

611 ],

612 "output_format": "png",

613 "quality": "low",

614 "size": "1024x1024",

615 "usage": {

616 "input_tokens": 0,

617 "input_tokens_details": {

618 "image_tokens": 0,

619 "text_tokens": 0

620 },

621 "output_tokens": 0,

622 "total_tokens": 0,

623 "output_tokens_details": {

624 "image_tokens": 0,

625 "text_tokens": 0

626 }

627 }

628}

629```

630

631## Create image variation

632

633`client.Images.NewVariation(ctx, body) (*ImagesResponse, error)`

634

635**post** `/images/variations`

636

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

638

639### Parameters

640

641- `body ImageNewVariationParams`

642

643 - `Image param.Field[Reader]`

644

645 The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.

646

647 - `Model param.Field[ImageModel]`

648

649 The model to use for image generation. Only `dall-e-2` is supported at this time.

650

651 - `string`

652

653 - `type ImageModel string`

654

655 - `const ImageModelGPTImage1 ImageModel = "gpt-image-1"`

656

657 - `const ImageModelGPTImage1Mini ImageModel = "gpt-image-1-mini"`

658

659 - `const ImageModelGPTImage2 ImageModel = "gpt-image-2"`

660

661 - `const ImageModelGPTImage2_2026_04_21 ImageModel = "gpt-image-2-2026-04-21"`

662

663 - `const ImageModelGPTImage1_5 ImageModel = "gpt-image-1.5"`

664

665 - `const ImageModelChatgptImageLatest ImageModel = "chatgpt-image-latest"`

666

667 - `const ImageModelDallE2 ImageModel = "dall-e-2"`

668

669 - `const ImageModelDallE3 ImageModel = "dall-e-3"`

670

671 - `N param.Field[int64]`

672

673 The number of images to generate. Must be between 1 and 10.

674

675 - `ResponseFormat param.Field[ImageNewVariationParamsResponseFormat]`

676

677 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.

678

679 - `const ImageNewVariationParamsResponseFormatURL ImageNewVariationParamsResponseFormat = "url"`

680

681 - `const ImageNewVariationParamsResponseFormatB64JSON ImageNewVariationParamsResponseFormat = "b64_json"`

682

683 - `Size param.Field[ImageNewVariationParamsSize]`

684

685 The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.

686

687 - `const ImageNewVariationParamsSize256x256 ImageNewVariationParamsSize = "256x256"`

688

689 - `const ImageNewVariationParamsSize512x512 ImageNewVariationParamsSize = "512x512"`

690

691 - `const ImageNewVariationParamsSize1024x1024 ImageNewVariationParamsSize = "1024x1024"`

692

693 - `User param.Field[string]`

694

695 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).

696

697### Returns

698

699- `type ImagesResponse struct{…}`

700

701 The response from the image generation endpoint.

702

703 - `Created int64`

704

705 The Unix timestamp (in seconds) of when the image was created.

706

707 - `Background ImagesResponseBackground`

708

709 The background parameter used for the image generation. Either `transparent` or `opaque`.

710

711 - `const ImagesResponseBackgroundTransparent ImagesResponseBackground = "transparent"`

712

713 - `const ImagesResponseBackgroundOpaque ImagesResponseBackground = "opaque"`

714

715 - `Data []Image`

716

717 The list of generated images.

718

719 - `B64JSON string`

720

721 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`.

722

723 - `RevisedPrompt string`

724

725 For `dall-e-3` only, the revised prompt that was used to generate the image.

726

727 - `URL string`

728

729 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.

730

731 - `OutputFormat ImagesResponseOutputFormat`

732

733 The output format of the image generation. Either `png`, `webp`, or `jpeg`.

734

735 - `const ImagesResponseOutputFormatPNG ImagesResponseOutputFormat = "png"`

736

737 - `const ImagesResponseOutputFormatWebP ImagesResponseOutputFormat = "webp"`

738

739 - `const ImagesResponseOutputFormatJPEG ImagesResponseOutputFormat = "jpeg"`

740

741 - `Quality ImagesResponseQuality`

742

743 The quality of the image generated. Either `low`, `medium`, or `high`.

744

745 - `const ImagesResponseQualityLow ImagesResponseQuality = "low"`

746

747 - `const ImagesResponseQualityMedium ImagesResponseQuality = "medium"`

748

749 - `const ImagesResponseQualityHigh ImagesResponseQuality = "high"`

750

751 - `Size ImagesResponseSize`

752

753 The size of the image generated. Either `1024x1024`, `1024x1536`, or `1536x1024`.

754

755 - `const ImagesResponseSize1024x1024 ImagesResponseSize = "1024x1024"`

756

757 - `const ImagesResponseSize1024x1536 ImagesResponseSize = "1024x1536"`

758

759 - `const ImagesResponseSize1536x1024 ImagesResponseSize = "1536x1024"`

760

761 - `Usage ImagesResponseUsage`

762

763 For `gpt-image-1` only, the token usage information for the image generation.

764

765 - `InputTokens int64`

766

767 The number of tokens (images and text) in the input prompt.

768

769 - `InputTokensDetails ImagesResponseUsageInputTokensDetails`

770

771 The input tokens detailed information for the image generation.

772

773 - `ImageTokens int64`

774

775 The number of image tokens in the input prompt.

776

777 - `TextTokens int64`

778

779 The number of text tokens in the input prompt.

780

781 - `OutputTokens int64`

782

783 The number of output tokens generated by the model.

784

785 - `TotalTokens int64`

786

787 The total number of tokens (images and text) used for the image generation.

788

789 - `OutputTokensDetails ImagesResponseUsageOutputTokensDetails`

790

791 The output token details for the image generation.

792

793 - `ImageTokens int64`

794

795 The number of image output tokens generated by the model.

796

797 - `TextTokens int64`

798

799 The number of text output tokens generated by the model.

800

801### Example

802

803```go

804package main

805

806import (

807 "bytes"

808 "context"

809 "fmt"

810 "io"

811

812 "github.com/openai/openai-go"

813 "github.com/openai/openai-go/option"

814)

815

816func main() {

817 client := openai.NewClient(

818 option.WithAPIKey("My API Key"),

819 )

820 imagesResponse, err := client.Images.NewVariation(context.TODO(), openai.ImageNewVariationParams{

821 Image: io.Reader(bytes.NewBuffer([]byte("Example data"))),

822 })

823 if err != nil {

824 panic(err.Error())

825 }

826 fmt.Printf("%+v\n", imagesResponse.Created)

827}

828```

829

830#### Response

831

832```json

833{

834 "created": 0,

835 "background": "transparent",

836 "data": [

837 {

838 "b64_json": "b64_json",

839 "revised_prompt": "revised_prompt",

840 "url": "https://example.com"

841 }

842 ],

843 "output_format": "png",

844 "quality": "low",

845 "size": "1024x1024",

846 "usage": {

847 "input_tokens": 0,

848 "input_tokens_details": {

849 "image_tokens": 0,

850 "text_tokens": 0

851 },

852 "output_tokens": 0,

853 "total_tokens": 0,

854 "output_tokens_details": {

855 "image_tokens": 0,

856 "text_tokens": 0

857 }

858 }

859}

860```

861

862## Domain Types

863

864### Image

865

866- `type Image struct{…}`

867

868 Represents the content or the URL of an image generated by the OpenAI API.

869

870 - `B64JSON string`

871

872 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`.

873

874 - `RevisedPrompt string`

875

876 For `dall-e-3` only, the revised prompt that was used to generate the image.

877

878 - `URL string`

879

880 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.

881

882### Image Edit Completed Event

883

884- `type ImageEditCompletedEvent struct{…}`

885

886 Emitted when image editing has completed and the final image is available.

887

888 - `B64JSON string`

889

890 Base64-encoded final edited image data, suitable for rendering as an image.

891

892 - `Background ImageEditCompletedEventBackground`

893

894 The background setting for the edited image.

895

896 - `const ImageEditCompletedEventBackgroundTransparent ImageEditCompletedEventBackground = "transparent"`

897

898 - `const ImageEditCompletedEventBackgroundOpaque ImageEditCompletedEventBackground = "opaque"`

899

900 - `const ImageEditCompletedEventBackgroundAuto ImageEditCompletedEventBackground = "auto"`

901

902 - `CreatedAt int64`

903

904 The Unix timestamp when the event was created.

905

906 - `OutputFormat ImageEditCompletedEventOutputFormat`

907

908 The output format for the edited image.

909

910 - `const ImageEditCompletedEventOutputFormatPNG ImageEditCompletedEventOutputFormat = "png"`

911

912 - `const ImageEditCompletedEventOutputFormatWebP ImageEditCompletedEventOutputFormat = "webp"`

913

914 - `const ImageEditCompletedEventOutputFormatJPEG ImageEditCompletedEventOutputFormat = "jpeg"`

915

916 - `Quality ImageEditCompletedEventQuality`

917

918 The quality setting for the edited image.

919

920 - `const ImageEditCompletedEventQualityLow ImageEditCompletedEventQuality = "low"`

921

922 - `const ImageEditCompletedEventQualityMedium ImageEditCompletedEventQuality = "medium"`

923

924 - `const ImageEditCompletedEventQualityHigh ImageEditCompletedEventQuality = "high"`

925

926 - `const ImageEditCompletedEventQualityAuto ImageEditCompletedEventQuality = "auto"`

927

928 - `Size ImageEditCompletedEventSize`

929

930 The size of the edited image.

931

932 - `const ImageEditCompletedEventSize1024x1024 ImageEditCompletedEventSize = "1024x1024"`

933

934 - `const ImageEditCompletedEventSize1024x1536 ImageEditCompletedEventSize = "1024x1536"`

935

936 - `const ImageEditCompletedEventSize1536x1024 ImageEditCompletedEventSize = "1536x1024"`

937

938 - `const ImageEditCompletedEventSizeAuto ImageEditCompletedEventSize = "auto"`

939

940 - `Type ImageEditCompleted`

941

942 The type of the event. Always `image_edit.completed`.

943

944 - `const ImageEditCompletedImageEditCompleted ImageEditCompleted = "image_edit.completed"`

945

946 - `Usage ImageEditCompletedEventUsage`

947

948 For the GPT image models only, the token usage information for the image generation.

949

950 - `InputTokens int64`

951

952 The number of tokens (images and text) in the input prompt.

953

954 - `InputTokensDetails ImageEditCompletedEventUsageInputTokensDetails`

955

956 The input tokens detailed information for the image generation.

957

958 - `ImageTokens int64`

959

960 The number of image tokens in the input prompt.

961

962 - `TextTokens int64`

963

964 The number of text tokens in the input prompt.

965

966 - `OutputTokens int64`

967

968 The number of image tokens in the output image.

969

970 - `TotalTokens int64`

971

972 The total number of tokens (images and text) used for the image generation.

973

974### Image Edit Partial Image Event

975

976- `type ImageEditPartialImageEvent struct{…}`

977

978 Emitted when a partial image is available during image editing streaming.

979

980 - `B64JSON string`

981

982 Base64-encoded partial image data, suitable for rendering as an image.

983

984 - `Background ImageEditPartialImageEventBackground`

985

986 The background setting for the requested edited image.

987

988 - `const ImageEditPartialImageEventBackgroundTransparent ImageEditPartialImageEventBackground = "transparent"`

989

990 - `const ImageEditPartialImageEventBackgroundOpaque ImageEditPartialImageEventBackground = "opaque"`

991

992 - `const ImageEditPartialImageEventBackgroundAuto ImageEditPartialImageEventBackground = "auto"`

993

994 - `CreatedAt int64`

995

996 The Unix timestamp when the event was created.

997

998 - `OutputFormat ImageEditPartialImageEventOutputFormat`

999

1000 The output format for the requested edited image.

1001

1002 - `const ImageEditPartialImageEventOutputFormatPNG ImageEditPartialImageEventOutputFormat = "png"`

1003

1004 - `const ImageEditPartialImageEventOutputFormatWebP ImageEditPartialImageEventOutputFormat = "webp"`

1005

1006 - `const ImageEditPartialImageEventOutputFormatJPEG ImageEditPartialImageEventOutputFormat = "jpeg"`

1007

1008 - `PartialImageIndex int64`

1009

1010 0-based index for the partial image (streaming).

1011

1012 - `Quality ImageEditPartialImageEventQuality`

1013

1014 The quality setting for the requested edited image.

1015

1016 - `const ImageEditPartialImageEventQualityLow ImageEditPartialImageEventQuality = "low"`

1017

1018 - `const ImageEditPartialImageEventQualityMedium ImageEditPartialImageEventQuality = "medium"`

1019

1020 - `const ImageEditPartialImageEventQualityHigh ImageEditPartialImageEventQuality = "high"`

1021

1022 - `const ImageEditPartialImageEventQualityAuto ImageEditPartialImageEventQuality = "auto"`

1023

1024 - `Size ImageEditPartialImageEventSize`

1025

1026 The size of the requested edited image.

1027

1028 - `const ImageEditPartialImageEventSize1024x1024 ImageEditPartialImageEventSize = "1024x1024"`

1029

1030 - `const ImageEditPartialImageEventSize1024x1536 ImageEditPartialImageEventSize = "1024x1536"`

1031

1032 - `const ImageEditPartialImageEventSize1536x1024 ImageEditPartialImageEventSize = "1536x1024"`

1033

1034 - `const ImageEditPartialImageEventSizeAuto ImageEditPartialImageEventSize = "auto"`

1035

1036 - `Type ImageEditPartialImage`

1037

1038 The type of the event. Always `image_edit.partial_image`.

1039

1040 - `const ImageEditPartialImageImageEditPartialImage ImageEditPartialImage = "image_edit.partial_image"`

1041

1042### Image Edit Stream Event

1043

1044- `type ImageEditStreamEventUnion interface{…}`

1045

1046 Emitted when a partial image is available during image editing streaming.

1047

1048 - `type ImageEditPartialImageEvent struct{…}`

1049

1050 Emitted when a partial image is available during image editing streaming.

1051

1052 - `B64JSON string`

1053

1054 Base64-encoded partial image data, suitable for rendering as an image.

1055

1056 - `Background ImageEditPartialImageEventBackground`

1057

1058 The background setting for the requested edited image.

1059

1060 - `const ImageEditPartialImageEventBackgroundTransparent ImageEditPartialImageEventBackground = "transparent"`

1061

1062 - `const ImageEditPartialImageEventBackgroundOpaque ImageEditPartialImageEventBackground = "opaque"`

1063

1064 - `const ImageEditPartialImageEventBackgroundAuto ImageEditPartialImageEventBackground = "auto"`

1065

1066 - `CreatedAt int64`

1067

1068 The Unix timestamp when the event was created.

1069

1070 - `OutputFormat ImageEditPartialImageEventOutputFormat`

1071

1072 The output format for the requested edited image.

1073

1074 - `const ImageEditPartialImageEventOutputFormatPNG ImageEditPartialImageEventOutputFormat = "png"`

1075

1076 - `const ImageEditPartialImageEventOutputFormatWebP ImageEditPartialImageEventOutputFormat = "webp"`

1077

1078 - `const ImageEditPartialImageEventOutputFormatJPEG ImageEditPartialImageEventOutputFormat = "jpeg"`

1079

1080 - `PartialImageIndex int64`

1081

1082 0-based index for the partial image (streaming).

1083

1084 - `Quality ImageEditPartialImageEventQuality`

1085

1086 The quality setting for the requested edited image.

1087

1088 - `const ImageEditPartialImageEventQualityLow ImageEditPartialImageEventQuality = "low"`

1089

1090 - `const ImageEditPartialImageEventQualityMedium ImageEditPartialImageEventQuality = "medium"`

1091

1092 - `const ImageEditPartialImageEventQualityHigh ImageEditPartialImageEventQuality = "high"`

1093

1094 - `const ImageEditPartialImageEventQualityAuto ImageEditPartialImageEventQuality = "auto"`

1095

1096 - `Size ImageEditPartialImageEventSize`

1097

1098 The size of the requested edited image.

1099

1100 - `const ImageEditPartialImageEventSize1024x1024 ImageEditPartialImageEventSize = "1024x1024"`

1101

1102 - `const ImageEditPartialImageEventSize1024x1536 ImageEditPartialImageEventSize = "1024x1536"`

1103

1104 - `const ImageEditPartialImageEventSize1536x1024 ImageEditPartialImageEventSize = "1536x1024"`

1105

1106 - `const ImageEditPartialImageEventSizeAuto ImageEditPartialImageEventSize = "auto"`

1107

1108 - `Type ImageEditPartialImage`

1109

1110 The type of the event. Always `image_edit.partial_image`.

1111

1112 - `const ImageEditPartialImageImageEditPartialImage ImageEditPartialImage = "image_edit.partial_image"`

1113

1114 - `type ImageEditCompletedEvent struct{…}`

1115

1116 Emitted when image editing has completed and the final image is available.

1117

1118 - `B64JSON string`

1119

1120 Base64-encoded final edited image data, suitable for rendering as an image.

1121

1122 - `Background ImageEditCompletedEventBackground`

1123

1124 The background setting for the edited image.

1125

1126 - `const ImageEditCompletedEventBackgroundTransparent ImageEditCompletedEventBackground = "transparent"`

1127

1128 - `const ImageEditCompletedEventBackgroundOpaque ImageEditCompletedEventBackground = "opaque"`

1129

1130 - `const ImageEditCompletedEventBackgroundAuto ImageEditCompletedEventBackground = "auto"`

1131

1132 - `CreatedAt int64`

1133

1134 The Unix timestamp when the event was created.

1135

1136 - `OutputFormat ImageEditCompletedEventOutputFormat`

1137

1138 The output format for the edited image.

1139

1140 - `const ImageEditCompletedEventOutputFormatPNG ImageEditCompletedEventOutputFormat = "png"`

1141

1142 - `const ImageEditCompletedEventOutputFormatWebP ImageEditCompletedEventOutputFormat = "webp"`

1143

1144 - `const ImageEditCompletedEventOutputFormatJPEG ImageEditCompletedEventOutputFormat = "jpeg"`

1145

1146 - `Quality ImageEditCompletedEventQuality`

1147

1148 The quality setting for the edited image.

1149

1150 - `const ImageEditCompletedEventQualityLow ImageEditCompletedEventQuality = "low"`

1151

1152 - `const ImageEditCompletedEventQualityMedium ImageEditCompletedEventQuality = "medium"`

1153

1154 - `const ImageEditCompletedEventQualityHigh ImageEditCompletedEventQuality = "high"`

1155

1156 - `const ImageEditCompletedEventQualityAuto ImageEditCompletedEventQuality = "auto"`

1157

1158 - `Size ImageEditCompletedEventSize`

1159

1160 The size of the edited image.

1161

1162 - `const ImageEditCompletedEventSize1024x1024 ImageEditCompletedEventSize = "1024x1024"`

1163

1164 - `const ImageEditCompletedEventSize1024x1536 ImageEditCompletedEventSize = "1024x1536"`

1165

1166 - `const ImageEditCompletedEventSize1536x1024 ImageEditCompletedEventSize = "1536x1024"`

1167

1168 - `const ImageEditCompletedEventSizeAuto ImageEditCompletedEventSize = "auto"`

1169

1170 - `Type ImageEditCompleted`

1171

1172 The type of the event. Always `image_edit.completed`.

1173

1174 - `const ImageEditCompletedImageEditCompleted ImageEditCompleted = "image_edit.completed"`

1175

1176 - `Usage ImageEditCompletedEventUsage`

1177

1178 For the GPT image models only, the token usage information for the image generation.

1179

1180 - `InputTokens int64`

1181

1182 The number of tokens (images and text) in the input prompt.

1183

1184 - `InputTokensDetails ImageEditCompletedEventUsageInputTokensDetails`

1185

1186 The input tokens detailed information for the image generation.

1187

1188 - `ImageTokens int64`

1189

1190 The number of image tokens in the input prompt.

1191

1192 - `TextTokens int64`

1193

1194 The number of text tokens in the input prompt.

1195

1196 - `OutputTokens int64`

1197

1198 The number of image tokens in the output image.

1199

1200 - `TotalTokens int64`

1201

1202 The total number of tokens (images and text) used for the image generation.

1203

1204### Image Gen Completed Event

1205

1206- `type ImageGenCompletedEvent struct{…}`

1207

1208 Emitted when image generation has completed and the final image is available.

1209

1210 - `B64JSON string`

1211

1212 Base64-encoded image data, suitable for rendering as an image.

1213

1214 - `Background ImageGenCompletedEventBackground`

1215

1216 The background setting for the generated image.

1217

1218 - `const ImageGenCompletedEventBackgroundTransparent ImageGenCompletedEventBackground = "transparent"`

1219

1220 - `const ImageGenCompletedEventBackgroundOpaque ImageGenCompletedEventBackground = "opaque"`

1221

1222 - `const ImageGenCompletedEventBackgroundAuto ImageGenCompletedEventBackground = "auto"`

1223

1224 - `CreatedAt int64`

1225

1226 The Unix timestamp when the event was created.

1227

1228 - `OutputFormat ImageGenCompletedEventOutputFormat`

1229

1230 The output format for the generated image.

1231

1232 - `const ImageGenCompletedEventOutputFormatPNG ImageGenCompletedEventOutputFormat = "png"`

1233

1234 - `const ImageGenCompletedEventOutputFormatWebP ImageGenCompletedEventOutputFormat = "webp"`

1235

1236 - `const ImageGenCompletedEventOutputFormatJPEG ImageGenCompletedEventOutputFormat = "jpeg"`

1237

1238 - `Quality ImageGenCompletedEventQuality`

1239

1240 The quality setting for the generated image.

1241

1242 - `const ImageGenCompletedEventQualityLow ImageGenCompletedEventQuality = "low"`

1243

1244 - `const ImageGenCompletedEventQualityMedium ImageGenCompletedEventQuality = "medium"`

1245

1246 - `const ImageGenCompletedEventQualityHigh ImageGenCompletedEventQuality = "high"`

1247

1248 - `const ImageGenCompletedEventQualityAuto ImageGenCompletedEventQuality = "auto"`

1249

1250 - `Size ImageGenCompletedEventSize`

1251

1252 The size of the generated image.

1253

1254 - `const ImageGenCompletedEventSize1024x1024 ImageGenCompletedEventSize = "1024x1024"`

1255

1256 - `const ImageGenCompletedEventSize1024x1536 ImageGenCompletedEventSize = "1024x1536"`

1257

1258 - `const ImageGenCompletedEventSize1536x1024 ImageGenCompletedEventSize = "1536x1024"`

1259

1260 - `const ImageGenCompletedEventSizeAuto ImageGenCompletedEventSize = "auto"`

1261

1262 - `Type ImageGenerationCompleted`

1263

1264 The type of the event. Always `image_generation.completed`.

1265

1266 - `const ImageGenerationCompletedImageGenerationCompleted ImageGenerationCompleted = "image_generation.completed"`

1267

1268 - `Usage ImageGenCompletedEventUsage`

1269

1270 For the GPT image models only, the token usage information for the image generation.

1271

1272 - `InputTokens int64`

1273

1274 The number of tokens (images and text) in the input prompt.

1275

1276 - `InputTokensDetails ImageGenCompletedEventUsageInputTokensDetails`

1277

1278 The input tokens detailed information for the image generation.

1279

1280 - `ImageTokens int64`

1281

1282 The number of image tokens in the input prompt.

1283

1284 - `TextTokens int64`

1285

1286 The number of text tokens in the input prompt.

1287

1288 - `OutputTokens int64`

1289

1290 The number of image tokens in the output image.

1291

1292 - `TotalTokens int64`

1293

1294 The total number of tokens (images and text) used for the image generation.

1295

1296### Image Gen Partial Image Event

1297

1298- `type ImageGenPartialImageEvent struct{…}`

1299

1300 Emitted when a partial image is available during image generation streaming.

1301

1302 - `B64JSON string`

1303

1304 Base64-encoded partial image data, suitable for rendering as an image.

1305

1306 - `Background ImageGenPartialImageEventBackground`

1307

1308 The background setting for the requested image.

1309

1310 - `const ImageGenPartialImageEventBackgroundTransparent ImageGenPartialImageEventBackground = "transparent"`

1311

1312 - `const ImageGenPartialImageEventBackgroundOpaque ImageGenPartialImageEventBackground = "opaque"`

1313

1314 - `const ImageGenPartialImageEventBackgroundAuto ImageGenPartialImageEventBackground = "auto"`

1315

1316 - `CreatedAt int64`

1317

1318 The Unix timestamp when the event was created.

1319

1320 - `OutputFormat ImageGenPartialImageEventOutputFormat`

1321

1322 The output format for the requested image.

1323

1324 - `const ImageGenPartialImageEventOutputFormatPNG ImageGenPartialImageEventOutputFormat = "png"`

1325

1326 - `const ImageGenPartialImageEventOutputFormatWebP ImageGenPartialImageEventOutputFormat = "webp"`

1327

1328 - `const ImageGenPartialImageEventOutputFormatJPEG ImageGenPartialImageEventOutputFormat = "jpeg"`

1329

1330 - `PartialImageIndex int64`

1331

1332 0-based index for the partial image (streaming).

1333

1334 - `Quality ImageGenPartialImageEventQuality`

1335

1336 The quality setting for the requested image.

1337

1338 - `const ImageGenPartialImageEventQualityLow ImageGenPartialImageEventQuality = "low"`

1339

1340 - `const ImageGenPartialImageEventQualityMedium ImageGenPartialImageEventQuality = "medium"`

1341

1342 - `const ImageGenPartialImageEventQualityHigh ImageGenPartialImageEventQuality = "high"`

1343

1344 - `const ImageGenPartialImageEventQualityAuto ImageGenPartialImageEventQuality = "auto"`

1345

1346 - `Size ImageGenPartialImageEventSize`

1347

1348 The size of the requested image.

1349

1350 - `const ImageGenPartialImageEventSize1024x1024 ImageGenPartialImageEventSize = "1024x1024"`

1351

1352 - `const ImageGenPartialImageEventSize1024x1536 ImageGenPartialImageEventSize = "1024x1536"`

1353

1354 - `const ImageGenPartialImageEventSize1536x1024 ImageGenPartialImageEventSize = "1536x1024"`

1355

1356 - `const ImageGenPartialImageEventSizeAuto ImageGenPartialImageEventSize = "auto"`

1357

1358 - `Type ImageGenerationPartialImage`

1359

1360 The type of the event. Always `image_generation.partial_image`.

1361

1362 - `const ImageGenerationPartialImageImageGenerationPartialImage ImageGenerationPartialImage = "image_generation.partial_image"`

1363

1364### Image Gen Stream Event

1365

1366- `type ImageGenStreamEventUnion interface{…}`

1367

1368 Emitted when a partial image is available during image generation streaming.

1369

1370 - `type ImageGenPartialImageEvent struct{…}`

1371

1372 Emitted when a partial image is available during image generation streaming.

1373

1374 - `B64JSON string`

1375

1376 Base64-encoded partial image data, suitable for rendering as an image.

1377

1378 - `Background ImageGenPartialImageEventBackground`

1379

1380 The background setting for the requested image.

1381

1382 - `const ImageGenPartialImageEventBackgroundTransparent ImageGenPartialImageEventBackground = "transparent"`

1383

1384 - `const ImageGenPartialImageEventBackgroundOpaque ImageGenPartialImageEventBackground = "opaque"`

1385

1386 - `const ImageGenPartialImageEventBackgroundAuto ImageGenPartialImageEventBackground = "auto"`

1387

1388 - `CreatedAt int64`

1389

1390 The Unix timestamp when the event was created.

1391

1392 - `OutputFormat ImageGenPartialImageEventOutputFormat`

1393

1394 The output format for the requested image.

1395

1396 - `const ImageGenPartialImageEventOutputFormatPNG ImageGenPartialImageEventOutputFormat = "png"`

1397

1398 - `const ImageGenPartialImageEventOutputFormatWebP ImageGenPartialImageEventOutputFormat = "webp"`

1399

1400 - `const ImageGenPartialImageEventOutputFormatJPEG ImageGenPartialImageEventOutputFormat = "jpeg"`

1401

1402 - `PartialImageIndex int64`

1403

1404 0-based index for the partial image (streaming).

1405

1406 - `Quality ImageGenPartialImageEventQuality`

1407

1408 The quality setting for the requested image.

1409

1410 - `const ImageGenPartialImageEventQualityLow ImageGenPartialImageEventQuality = "low"`

1411

1412 - `const ImageGenPartialImageEventQualityMedium ImageGenPartialImageEventQuality = "medium"`

1413

1414 - `const ImageGenPartialImageEventQualityHigh ImageGenPartialImageEventQuality = "high"`

1415

1416 - `const ImageGenPartialImageEventQualityAuto ImageGenPartialImageEventQuality = "auto"`

1417

1418 - `Size ImageGenPartialImageEventSize`

1419

1420 The size of the requested image.

1421

1422 - `const ImageGenPartialImageEventSize1024x1024 ImageGenPartialImageEventSize = "1024x1024"`

1423

1424 - `const ImageGenPartialImageEventSize1024x1536 ImageGenPartialImageEventSize = "1024x1536"`

1425

1426 - `const ImageGenPartialImageEventSize1536x1024 ImageGenPartialImageEventSize = "1536x1024"`

1427

1428 - `const ImageGenPartialImageEventSizeAuto ImageGenPartialImageEventSize = "auto"`

1429

1430 - `Type ImageGenerationPartialImage`

1431

1432 The type of the event. Always `image_generation.partial_image`.

1433

1434 - `const ImageGenerationPartialImageImageGenerationPartialImage ImageGenerationPartialImage = "image_generation.partial_image"`

1435

1436 - `type ImageGenCompletedEvent struct{…}`

1437

1438 Emitted when image generation has completed and the final image is available.

1439

1440 - `B64JSON string`

1441

1442 Base64-encoded image data, suitable for rendering as an image.

1443

1444 - `Background ImageGenCompletedEventBackground`

1445

1446 The background setting for the generated image.

1447

1448 - `const ImageGenCompletedEventBackgroundTransparent ImageGenCompletedEventBackground = "transparent"`

1449

1450 - `const ImageGenCompletedEventBackgroundOpaque ImageGenCompletedEventBackground = "opaque"`

1451

1452 - `const ImageGenCompletedEventBackgroundAuto ImageGenCompletedEventBackground = "auto"`

1453

1454 - `CreatedAt int64`

1455

1456 The Unix timestamp when the event was created.

1457

1458 - `OutputFormat ImageGenCompletedEventOutputFormat`

1459

1460 The output format for the generated image.

1461

1462 - `const ImageGenCompletedEventOutputFormatPNG ImageGenCompletedEventOutputFormat = "png"`

1463

1464 - `const ImageGenCompletedEventOutputFormatWebP ImageGenCompletedEventOutputFormat = "webp"`

1465

1466 - `const ImageGenCompletedEventOutputFormatJPEG ImageGenCompletedEventOutputFormat = "jpeg"`

1467

1468 - `Quality ImageGenCompletedEventQuality`

1469

1470 The quality setting for the generated image.

1471

1472 - `const ImageGenCompletedEventQualityLow ImageGenCompletedEventQuality = "low"`

1473

1474 - `const ImageGenCompletedEventQualityMedium ImageGenCompletedEventQuality = "medium"`

1475

1476 - `const ImageGenCompletedEventQualityHigh ImageGenCompletedEventQuality = "high"`

1477

1478 - `const ImageGenCompletedEventQualityAuto ImageGenCompletedEventQuality = "auto"`

1479

1480 - `Size ImageGenCompletedEventSize`

1481

1482 The size of the generated image.

1483

1484 - `const ImageGenCompletedEventSize1024x1024 ImageGenCompletedEventSize = "1024x1024"`

1485

1486 - `const ImageGenCompletedEventSize1024x1536 ImageGenCompletedEventSize = "1024x1536"`

1487

1488 - `const ImageGenCompletedEventSize1536x1024 ImageGenCompletedEventSize = "1536x1024"`

1489

1490 - `const ImageGenCompletedEventSizeAuto ImageGenCompletedEventSize = "auto"`

1491

1492 - `Type ImageGenerationCompleted`

1493

1494 The type of the event. Always `image_generation.completed`.

1495

1496 - `const ImageGenerationCompletedImageGenerationCompleted ImageGenerationCompleted = "image_generation.completed"`

1497

1498 - `Usage ImageGenCompletedEventUsage`

1499

1500 For the GPT image models only, the token usage information for the image generation.

1501

1502 - `InputTokens int64`

1503

1504 The number of tokens (images and text) in the input prompt.

1505

1506 - `InputTokensDetails ImageGenCompletedEventUsageInputTokensDetails`

1507

1508 The input tokens detailed information for the image generation.

1509

1510 - `ImageTokens int64`

1511

1512 The number of image tokens in the input prompt.

1513

1514 - `TextTokens int64`

1515

1516 The number of text tokens in the input prompt.

1517

1518 - `OutputTokens int64`

1519

1520 The number of image tokens in the output image.

1521

1522 - `TotalTokens int64`

1523

1524 The total number of tokens (images and text) used for the image generation.

1525

1526### Image Model

1527

1528- `type ImageModel string`

1529

1530 - `const ImageModelGPTImage1 ImageModel = "gpt-image-1"`

1531

1532 - `const ImageModelGPTImage1Mini ImageModel = "gpt-image-1-mini"`

1533

1534 - `const ImageModelGPTImage2 ImageModel = "gpt-image-2"`

1535

1536 - `const ImageModelGPTImage2_2026_04_21 ImageModel = "gpt-image-2-2026-04-21"`

1537

1538 - `const ImageModelGPTImage1_5 ImageModel = "gpt-image-1.5"`

1539

1540 - `const ImageModelChatgptImageLatest ImageModel = "chatgpt-image-latest"`

1541

1542 - `const ImageModelDallE2 ImageModel = "dall-e-2"`

1543

1544 - `const ImageModelDallE3 ImageModel = "dall-e-3"`

1545

1546### Images Response

1547

1548- `type ImagesResponse struct{…}`

1549

1550 The response from the image generation endpoint.

1551

1552 - `Created int64`

1553

1554 The Unix timestamp (in seconds) of when the image was created.

1555

1556 - `Background ImagesResponseBackground`

1557

1558 The background parameter used for the image generation. Either `transparent` or `opaque`.

1559

1560 - `const ImagesResponseBackgroundTransparent ImagesResponseBackground = "transparent"`

1561

1562 - `const ImagesResponseBackgroundOpaque ImagesResponseBackground = "opaque"`

1563

1564 - `Data []Image`

1565

1566 The list of generated images.

1567

1568 - `B64JSON string`

1569

1570 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`.

1571

1572 - `RevisedPrompt string`

1573

1574 For `dall-e-3` only, the revised prompt that was used to generate the image.

1575

1576 - `URL string`

1577

1578 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.

1579

1580 - `OutputFormat ImagesResponseOutputFormat`

1581

1582 The output format of the image generation. Either `png`, `webp`, or `jpeg`.

1583

1584 - `const ImagesResponseOutputFormatPNG ImagesResponseOutputFormat = "png"`

1585

1586 - `const ImagesResponseOutputFormatWebP ImagesResponseOutputFormat = "webp"`

1587

1588 - `const ImagesResponseOutputFormatJPEG ImagesResponseOutputFormat = "jpeg"`

1589

1590 - `Quality ImagesResponseQuality`

1591

1592 The quality of the image generated. Either `low`, `medium`, or `high`.

1593

1594 - `const ImagesResponseQualityLow ImagesResponseQuality = "low"`

1595

1596 - `const ImagesResponseQualityMedium ImagesResponseQuality = "medium"`

1597

1598 - `const ImagesResponseQualityHigh ImagesResponseQuality = "high"`

1599

1600 - `Size ImagesResponseSize`

1601

1602 The size of the image generated. Either `1024x1024`, `1024x1536`, or `1536x1024`.

1603

1604 - `const ImagesResponseSize1024x1024 ImagesResponseSize = "1024x1024"`

1605

1606 - `const ImagesResponseSize1024x1536 ImagesResponseSize = "1024x1536"`

1607

1608 - `const ImagesResponseSize1536x1024 ImagesResponseSize = "1536x1024"`

1609

1610 - `Usage ImagesResponseUsage`

1611

1612 For `gpt-image-1` only, the token usage information for the image generation.

1613

1614 - `InputTokens int64`

1615

1616 The number of tokens (images and text) in the input prompt.

1617

1618 - `InputTokensDetails ImagesResponseUsageInputTokensDetails`

1619

1620 The input tokens detailed information for the image generation.

1621

1622 - `ImageTokens int64`

1623

1624 The number of image tokens in the input prompt.

1625

1626 - `TextTokens int64`

1627

1628 The number of text tokens in the input prompt.

1629

1630 - `OutputTokens int64`

1631

1632 The number of output tokens generated by the model.

1633

1634 - `TotalTokens int64`

1635

1636 The total number of tokens (images and text) used for the image generation.

1637

1638 - `OutputTokensDetails ImagesResponseUsageOutputTokensDetails`

1639

1640 The output token details for the image generation.

1641

1642 - `ImageTokens int64`

1643

1644 The number of image output tokens generated by the model.

1645

1646 - `TextTokens int64`

1647

1648 The number of text output tokens generated by the model.

go/resources/images/index.md 2026-05-02 05:57 UTC to 2026-05-05 23:00 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