Create image

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

POST/images/generations

Creates an image given a prompt. Learn more.

ParametersExpand Collapse

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

Allows to set transparency for the background of the generated image(s). This parameter is only supported for the GPT image models. 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.

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

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). Defaults to dall-e-2 unless a parameter specific to the GPT image models is used.

string

type ImageModel string

Accepts one of the following:

const ImageModelGPTImage1_5 ImageModel = "gpt-image-1.5"

const ImageModelDallE2 ImageModel = "dall-e-2"

const ImageModelDallE3 ImageModel = "dall-e-3"

const ImageModelGPTImage1 ImageModel = "gpt-image-1"

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

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

const ImageGenerateParamsModerationLow ImageGenerateParamsModeration = "low"

const ImageGenerateParamsModerationAuto ImageGenerateParamsModeration = "auto"

N param.Field[int64]optional

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

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. Must be one of png, jpeg, or webp.

const ImageGenerateParamsOutputFormatPNG ImageGenerateParamsOutputFormat = "png"

const ImageGenerateParamsOutputFormatJPEG ImageGenerateParamsOutputFormat = "jpeg"

const ImageGenerateParamsOutputFormatWebP ImageGenerateParamsOutputFormat = "webp"

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.

maximum3

minimum0

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.
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]optional

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

The size of the generated images. Must be one of 1024x1024, 1536x1024 (landscape), 1024x1536 (portrait), or auto (default value) for the GPT image models, one of 256x256, 512x512, or 1024x1024 for dall-e-2, and one of 1024x1024, 1792x1024, or 1024x1792 for dall-e-3.

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

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

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

ReturnsExpand Collapse

type ImagesResponse struct{…}

The response from the image generation endpoint.

Created int64

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

Background ImagesResponseBackgroundoptional

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

Accepts one of the following:

const ImagesResponseBackgroundTransparent ImagesResponseBackground = "transparent"

const ImagesResponseBackgroundOpaque ImagesResponseBackground = "opaque"

Data []Imageoptional

The list of generated images.

B64JSON stringoptional

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 stringoptional

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

URL stringoptional

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 ImagesResponseOutputFormatoptional

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

Accepts one of the following:

const ImagesResponseOutputFormatPNG ImagesResponseOutputFormat = "png"

const ImagesResponseOutputFormatWebP ImagesResponseOutputFormat = "webp"

const ImagesResponseOutputFormatJPEG ImagesResponseOutputFormat = "jpeg"

Quality ImagesResponseQualityoptional

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

Accepts one of the following:

const ImagesResponseQualityLow ImagesResponseQuality = "low"

const ImagesResponseQualityMedium ImagesResponseQuality = "medium"

const ImagesResponseQualityHigh ImagesResponseQuality = "high"

Size ImagesResponseSizeoptional

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

Accepts one of the following:

const ImagesResponseSize1024x1024 ImagesResponseSize = "1024x1024"

const ImagesResponseSize1024x1536 ImagesResponseSize = "1024x1536"

const ImagesResponseSize1536x1024 ImagesResponseSize = "1536x1024"

Usage ImagesResponseUsageoptional

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 ImagesResponseUsageOutputTokensDetailsoptional

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.

type ImageGenStreamEventUnion interface{…}

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

Accepts one of the following:

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.

Accepts one of the following:

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.

Accepts one of the following:

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.

Accepts one of the following:

const ImageGenPartialImageEventQualityLow ImageGenPartialImageEventQuality = "low"

const ImageGenPartialImageEventQualityMedium ImageGenPartialImageEventQuality = "medium"

const ImageGenPartialImageEventQualityHigh ImageGenPartialImageEventQuality = "high"

const ImageGenPartialImageEventQualityAuto ImageGenPartialImageEventQuality = "auto"

Size ImageGenPartialImageEventSize

The size of the requested image.

Accepts one of the following:

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.

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.

Accepts one of the following:

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.

Accepts one of the following:

const ImageGenCompletedEventOutputFormatPNG ImageGenCompletedEventOutputFormat = "png"

const ImageGenCompletedEventOutputFormatWebP ImageGenCompletedEventOutputFormat = "webp"

const ImageGenCompletedEventOutputFormatJPEG ImageGenCompletedEventOutputFormat = "jpeg"

Quality ImageGenCompletedEventQuality

The quality setting for the generated image.

Accepts one of the following:

const ImageGenCompletedEventQualityLow ImageGenCompletedEventQuality = "low"

const ImageGenCompletedEventQualityMedium ImageGenCompletedEventQuality = "medium"

const ImageGenCompletedEventQualityHigh ImageGenCompletedEventQuality = "high"

const ImageGenCompletedEventQualityAuto ImageGenCompletedEventQuality = "auto"

Size ImageGenCompletedEventSize

The size of the generated image.

Accepts one of the following:

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.

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.

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

{
  "created": 0,
  "background": "transparent",
  "data": [
    {
      "b64_json": "b64_json",
      "revised_prompt": "revised_prompt",
      "url": "url"
    }
  ],
  "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
    }
  }
}

Returns Examples

{
  "created": 0,
  "background": "transparent",
  "data": [
    {
      "b64_json": "b64_json",
      "revised_prompt": "revised_prompt",
      "url": "url"
    }
  ],
  "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
    }
  }
}

Search the API docs

Getting Started

Using Codex

Configuration

Administration

Automation

Learn

Releases

Categories

Topics

Create image

ParametersExpand Collapse

ReturnsExpand Collapse

Create image

Returns Examples