SpyBara
Go Premium

go/resources/images/index.md 2026-07-07 08:02 UTC to 2026-07-09 20:58 UTC

1684 added, 0 removed.

2026
Fri 31 21:03 Thu 30 23:58 Wed 29 15:02 Sat 25 05:59 Thu 23 18:00 Wed 22 20:02 Mon 20 20:00 Fri 17 17:00 Thu 16 20:57 Wed 15 02:58 Tue 14 06:58 Mon 13 15:59 Sun 12 06:58 Fri 10 23:02 Thu 9 20:58 Tue 7 08:02

Images

Create image

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

post /images/generations

Create image

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[ImageGenerateParamsSize]

      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.

      • string

      • ImageGenerateParamsSize

        • const ImageGenerateParamsSizeAuto ImageGenerateParamsSize = "auto"

        • const ImageGenerateParamsSize1024x1024 ImageGenerateParamsSize = "1024x1024"

        • const ImageGenerateParamsSize1536x1024 ImageGenerateParamsSize = "1536x1024"

        • const ImageGenerateParamsSize1024x1536 ImageGenerateParamsSize = "1024x1536"

        • const ImageGenerateParamsSize256x256 ImageGenerateParamsSize = "256x256"

        • const ImageGenerateParamsSize512x512 ImageGenerateParamsSize = "512x512"

        • const ImageGenerateParamsSize1792x1024 ImageGenerateParamsSize = "1792x1024"

        • const ImageGenerateParamsSize1024x1792 ImageGenerateParamsSize = "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

Create image edit

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[ImageEditParamsSize]

      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.

      • string

      • ImageEditParamsSize

        • const ImageEditParamsSize256x256 ImageEditParamsSize = "256x256"

        • const ImageEditParamsSize512x512 ImageEditParamsSize = "512x512"

        • const ImageEditParamsSize1024x1024 ImageEditParamsSize = "1024x1024"

        • const ImageEditParamsSize1536x1024 ImageEditParamsSize = "1536x1024"

        • const ImageEditParamsSize1024x1536 ImageEditParamsSize = "1024x1536"

        • const ImageEditParamsSizeAuto ImageEditParamsSize = "auto"

    • ``

    • 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

Create image variation

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.