API Reference

Images

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create image variation

ImagesResponse images().createVariation(ImageCreateVariationParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/images/variations

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

ParametersExpand Collapse

ImageCreateVariationParams params

InputStream image

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

Optional<ImageModel> model

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

Optional<Long> n

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

minimum1

maximum10

Optional<ResponseFormat> responseFormat

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.

Optional<Size> size

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

Optional<String> user

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

ReturnsExpand Collapse

class ImagesResponse:

The response from the image generation endpoint.

long created

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

formatunixtime

Optional<Background> background

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

Optional<List<Image>> data

The list of generated images.

Optional<OutputFormat> outputFormat

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

Optional<Quality> quality

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

Optional<Size> size

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

Optional<Usage> usage

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

Create image variation

Java

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.images.ImageCreateVariationParams;
import com.openai.models.images.ImagesResponse;
import java.io.ByteArrayInputStream;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        ImageCreateVariationParams params = ImageCreateVariationParams.builder()
            .image(new ByteArrayInputStream("Example data".getBytes()))
            .build();
        ImagesResponse imagesResponse = client.images().createVariation(params);
    }
}

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

Returns Examples

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