API Reference

Images

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create image variation

$ openai images create-variation

POST/images/variations

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

ParametersExpand Collapse

--image: file path

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

--model: optional string or ImageModel

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

--n: optional number

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

--response-format: optional "url" or "b64_json"

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.

--size: optional "256x256" or "512x512" or "1024x1024"

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

--user: optional string

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

ReturnsExpand Collapse

images_response: object { created, background, data, 4 more }

The response from the image generation endpoint.

created: number

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

background: optional "transparent" or "opaque"

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

data: optional array of Image { b64_json, revised_prompt, url }

The list of generated images.

output_format: optional "png" or "webp" or "jpeg"

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

quality: optional "low" or "medium" or "high"

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

size: optional "1024x1024" or "1024x1536" or "1536x1024"

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

usage: optional object { input_tokens, input_tokens_details, output_tokens, 2 more }

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

Create image variation

CLI Tool

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

openai images create-variation \
  --api-key 'My API Key' \
  --image 'Example data'

{
  "created": 1589478378,
  "data": [
    {
      "url": "https://..."
    },
    {
      "url": "https://..."
    }
  ]
}

Returns Examples

{
  "created": 1589478378,
  "data": [
    {
      "url": "https://..."
    },
    {
      "url": "https://..."
    }
  ]
}