Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation
Theme

Create image

client.Images.Generate(ctx, body) (*ImagesResponse, error)
POST
/images/generations

Creates an image given a prompt using a GPT Image model. Learn more.

Create image

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)
}
200 — Example
{
  "created": 0,
  "background": "transparent",
  "data": [
    {
      "b64_json": "b64_json",
      "revised_prompt": "revised_prompt",
      "url": "https://example.com"
    }
  ],
  "output_format": "png",
  "quality": "low",
  "safety_identifier": "safety_identifier",
  "size": "1024x1024",
  "svg_usage": {
    "input_tokens": 0,
    "model": "model",
    "output_tokens": 0,
    "reasoning_tokens": 0,
    "total_tokens": 0
  },
  "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
    }
  }
}
Parameters
body ImageGenerateParams
Prompt param.Field[string]

A text description of the desired image(s). The maximum length is 32000 characters.

Background param.Field[ImageGenerateParamsBackground]
Optional

Allows to set transparency for the background of the generated image(s). 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.5-sunburst and gpt-image-2.5-flare, including their 2026-09-08 snapshots, support opaque and transparent backgrounds. Transparent backgrounds are available for supported GPT Image models. For gpt-image-2 and gpt-image-2-2026-04-21, this support is in preview. When using transparent, set the output format to png or webp.

Complexity param.Field[ImageGenerateParamsComplexity]
Optional

Computation spent planning the image, independently of rendering quality. Uses the image model’s configured default when omitted. For SVG output, controls the reference image, independently of the SVG author’s reasoning.

FrameCount param.Field[int64]
Optional

Number of frames for GIF output. Accepts integers from 2 through 16. Defaults to 9 when omitted. Only supported with output_format=gif. The requested size must satisfy the selected model’s GIF size limits. GIF output does not support streaming, partial images, masks, or custom output compression. Requires access to the GIF preview for the selected model.

minimum2
maximum16
FrameDurationMs param.Field[int64]
Optional

Requested delay per GIF frame, in milliseconds. Defaults to 200 when omitted. GIF output rounds to the nearest 10 ms and caps the encoded delay at 655,350 ms per frame. Only supported with output_format=gif.

minimum20
Model param.Field[ImageModel]
Optional

The GPT image model to use for image generation. Specify a model explicitly. Supported models include gpt-image-1-mini, gpt-image-1.5, gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, gpt-image-2.5-flare-2026-09-08, gpt-image-2.6-sunburst, gpt-image-2.6-flare, and chatgpt-image-latest.

gpt-image-1 was shut down on October 23, 2026. Use gpt-image-2.5-sunburst or gpt-image-2.5-flare instead.

Moderation param.Field[ImageGenerateParamsModeration]
Optional

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

N param.Field[int64]
Optional

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

minimum1
maximum10
OutputCompression param.Field[int64]
Optional

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]
Optional

The format in which the generated images are returned. This parameter is only supported for the GPT image models.

PartialImages param.Field[int64]
Optional

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.

minimum0
maximum3
Quality param.Field[ImageGenerateParamsQuality]
Optional

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.
  • gpt-image-2.5-sunburst and gpt-image-2.5-flare, including their 2026-09-08 snapshots, also support xhigh and max.
ResponseFormat param.Field[ImageGenerateParamsResponseFormat]
Optional

Deprecated.

Legacy response format parameter for retired image models. Unsupported for GPT image models, which always return base64-encoded images.

SafetyIdentifier param.Field[string]
Optional

A stable identifier for an end user in your organization, used for safety monitoring and abuse detection. Hash a username or email address to avoid sending identifying information. A non-empty value takes precedence over the deprecated user parameter. If omitted, null, or empty, the API uses user when available. Learn more.

maxLength128
Size param.Field[ImageGenerateParamsSize]
Optional

The size of the generated images. For gpt-image-2, gpt-image-2-2026-04-21, gpt-image-2.5-sunburst, gpt-image-2.5-sunburst-2026-09-08, gpt-image-2.5-flare, and gpt-image-2.5-flare-2026-09-08, 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.

Style param.Field[ImageGenerateParamsStyle]
Optional

Deprecated.

Legacy style parameter for retired image models. Unsupported for GPT image models; describe the desired style in the prompt instead.

Svg param.Field[ImageGenerateParamsSvg]
Optional

Selects the model and reasoning effort used to author SVG output. Requires output_format=svg and access to SVG model selection. When model selection is enabled, supply svg.model. When model selection is disabled, omit this object. The top-level model selects the image model that creates the reference image. SVG generation requires n=1 and does not support streaming, partial images, prompt_rewriter, or output_compression.

User param.Field[string]
Optional

Deprecated.

Deprecated: use safety_identifier instead. This parameter remains accepted for backward compatibility and is used when safety_identifier is omitted, null, or empty. 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.

formatunixtime
Background ImagesResponseBackground
Optional

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

Data []Image
Optional

The list of generated images.

OutputFormat ImagesResponseOutputFormat
Optional

The output format of the generated or edited image.

Quality ImagesResponseQuality
Optional

The quality of the image generated. One of low, medium, high, xhigh, or max.

SafetyIdentifier string
Optional

The effective safety identifier used for safety monitoring and abuse detection. This is the non-empty safety_identifier from the request, or the deprecated user value when safety_identifier is omitted, null, or empty.

Size ImagesResponseSize
Optional

The image dimensions as a WIDTHxHEIGHT string, for example 1536x864.

SvgUsage ImagesResponseSvgUsage
Optional

Token usage for SVG authoring, separate from image rendering usage.

Usage ImagesResponseUsage
Optional

Token usage information for image generation with GPT Image models.

Returns Examples
200 — Example
{
  "created": 0,
  "background": "transparent",
  "data": [
    {
      "b64_json": "b64_json",
      "revised_prompt": "revised_prompt",
      "url": "https://example.com"
    }
  ],
  "output_format": "png",
  "quality": "low",
  "safety_identifier": "safety_identifier",
  "size": "1024x1024",
  "svg_usage": {
    "input_tokens": 0,
    "model": "model",
    "output_tokens": 0,
    "reasoning_tokens": 0,
    "total_tokens": 0
  },
  "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
    }
  }
}