API Reference

Images

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

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.

ParametersExpand Collapse

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

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

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"

N param.Field[int64]optional

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

minimum1

maximum10

ResponseFormat param.Field[ImageNewVariationParamsResponseFormat]optional

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

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

Create image variation

Go

HTTP

TypeScript

Python

Java

Go

Ruby

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("some file contents"))),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", imagesResponse.Created)
}

200 example

{
  "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

200 example

{
  "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
    }
  }
}