Skip to content
API Reference

Images

Create image
ImagesResponse images().generate(ImageGenerateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/images/generations
Create image edit
ImagesResponse images().edit(ImageEditParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/images/edits
Create image variation
ImagesResponse images().createVariation(ImageCreateVariationParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/images/variations
ModelsExpand Collapse
class Image:

Represents the content or the URL of an image generated by the OpenAI API.

Optional<String> b64Json

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.

Optional<String> revisedPrompt

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

Optional<String> url

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.

class ImageEditCompletedEvent:

Emitted when image editing has completed and the final image is available.

String b64Json

Base64-encoded final edited image data, suitable for rendering as an image.

Background background

The background setting for the edited image.

Accepts one of the following:
TRANSPARENT("transparent")
OPAQUE("opaque")
AUTO("auto")
long createdAt

The Unix timestamp when the event was created.

OutputFormat outputFormat

The output format for the edited image.

Accepts one of the following:
PNG("png")
WEBP("webp")
JPEG("jpeg")
Quality quality

The quality setting for the edited image.

Accepts one of the following:
LOW("low")
MEDIUM("medium")
HIGH("high")
AUTO("auto")
Size size

The size of the edited image.

Accepts one of the following:
_1024X1024("1024x1024")
_1024X1536("1024x1536")
_1536X1024("1536x1024")
AUTO("auto")
JsonValue; type "image_edit.completed"constant"image_edit.completed"constant

The type of the event. Always image_edit.completed.

Usage usage

For the GPT image models only, the token usage information for the image generation.

long inputTokens

The number of tokens (images and text) in the input prompt.

InputTokensDetails inputTokensDetails

The input tokens detailed information for the image generation.

long imageTokens

The number of image tokens in the input prompt.

long textTokens

The number of text tokens in the input prompt.

long outputTokens

The number of image tokens in the output image.

long totalTokens

The total number of tokens (images and text) used for the image generation.

class ImageEditPartialImageEvent:

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

String b64Json

Base64-encoded partial image data, suitable for rendering as an image.

Background background

The background setting for the requested edited image.

Accepts one of the following:
TRANSPARENT("transparent")
OPAQUE("opaque")
AUTO("auto")
long createdAt

The Unix timestamp when the event was created.

OutputFormat outputFormat

The output format for the requested edited image.

Accepts one of the following:
PNG("png")
WEBP("webp")
JPEG("jpeg")
long partialImageIndex

0-based index for the partial image (streaming).

Quality quality

The quality setting for the requested edited image.

Accepts one of the following:
LOW("low")
MEDIUM("medium")
HIGH("high")
AUTO("auto")
Size size

The size of the requested edited image.

Accepts one of the following:
_1024X1024("1024x1024")
_1024X1536("1024x1536")
_1536X1024("1536x1024")
AUTO("auto")
JsonValue; type "image_edit.partial_image"constant"image_edit.partial_image"constant

The type of the event. Always image_edit.partial_image.

class ImageEditStreamEvent: A class that can be one of several variants.union

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

class ImageEditPartialImageEvent:

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

String b64Json

Base64-encoded partial image data, suitable for rendering as an image.

Background background

The background setting for the requested edited image.

Accepts one of the following:
TRANSPARENT("transparent")
OPAQUE("opaque")
AUTO("auto")
long createdAt

The Unix timestamp when the event was created.

OutputFormat outputFormat

The output format for the requested edited image.

Accepts one of the following:
PNG("png")
WEBP("webp")
JPEG("jpeg")
long partialImageIndex

0-based index for the partial image (streaming).

Quality quality

The quality setting for the requested edited image.

Accepts one of the following:
LOW("low")
MEDIUM("medium")
HIGH("high")
AUTO("auto")
Size size

The size of the requested edited image.

Accepts one of the following:
_1024X1024("1024x1024")
_1024X1536("1024x1536")
_1536X1024("1536x1024")
AUTO("auto")
JsonValue; type "image_edit.partial_image"constant"image_edit.partial_image"constant

The type of the event. Always image_edit.partial_image.

class ImageEditCompletedEvent:

Emitted when image editing has completed and the final image is available.

String b64Json

Base64-encoded final edited image data, suitable for rendering as an image.

Background background

The background setting for the edited image.

Accepts one of the following:
TRANSPARENT("transparent")
OPAQUE("opaque")
AUTO("auto")
long createdAt

The Unix timestamp when the event was created.

OutputFormat outputFormat

The output format for the edited image.

Accepts one of the following:
PNG("png")
WEBP("webp")
JPEG("jpeg")
Quality quality

The quality setting for the edited image.

Accepts one of the following:
LOW("low")
MEDIUM("medium")
HIGH("high")
AUTO("auto")
Size size

The size of the edited image.

Accepts one of the following:
_1024X1024("1024x1024")
_1024X1536("1024x1536")
_1536X1024("1536x1024")
AUTO("auto")
JsonValue; type "image_edit.completed"constant"image_edit.completed"constant

The type of the event. Always image_edit.completed.

Usage usage

For the GPT image models only, the token usage information for the image generation.

long inputTokens

The number of tokens (images and text) in the input prompt.

InputTokensDetails inputTokensDetails

The input tokens detailed information for the image generation.

long imageTokens

The number of image tokens in the input prompt.

long textTokens

The number of text tokens in the input prompt.

long outputTokens

The number of image tokens in the output image.

long totalTokens

The total number of tokens (images and text) used for the image generation.

class ImageGenCompletedEvent:

Emitted when image generation has completed and the final image is available.

String b64Json

Base64-encoded image data, suitable for rendering as an image.

Background background

The background setting for the generated image.

Accepts one of the following:
TRANSPARENT("transparent")
OPAQUE("opaque")
AUTO("auto")
long createdAt

The Unix timestamp when the event was created.

OutputFormat outputFormat

The output format for the generated image.

Accepts one of the following:
PNG("png")
WEBP("webp")
JPEG("jpeg")
Quality quality

The quality setting for the generated image.

Accepts one of the following:
LOW("low")
MEDIUM("medium")
HIGH("high")
AUTO("auto")
Size size

The size of the generated image.

Accepts one of the following:
_1024X1024("1024x1024")
_1024X1536("1024x1536")
_1536X1024("1536x1024")
AUTO("auto")
JsonValue; type "image_generation.completed"constant"image_generation.completed"constant

The type of the event. Always image_generation.completed.

Usage usage

For the GPT image models only, the token usage information for the image generation.

long inputTokens

The number of tokens (images and text) in the input prompt.

InputTokensDetails inputTokensDetails

The input tokens detailed information for the image generation.

long imageTokens

The number of image tokens in the input prompt.

long textTokens

The number of text tokens in the input prompt.

long outputTokens

The number of image tokens in the output image.

long totalTokens

The total number of tokens (images and text) used for the image generation.

class ImageGenPartialImageEvent:

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

String b64Json

Base64-encoded partial image data, suitable for rendering as an image.

Background background

The background setting for the requested image.

Accepts one of the following:
TRANSPARENT("transparent")
OPAQUE("opaque")
AUTO("auto")
long createdAt

The Unix timestamp when the event was created.

OutputFormat outputFormat

The output format for the requested image.

Accepts one of the following:
PNG("png")
WEBP("webp")
JPEG("jpeg")
long partialImageIndex

0-based index for the partial image (streaming).

Quality quality

The quality setting for the requested image.

Accepts one of the following:
LOW("low")
MEDIUM("medium")
HIGH("high")
AUTO("auto")
Size size

The size of the requested image.

Accepts one of the following:
_1024X1024("1024x1024")
_1024X1536("1024x1536")
_1536X1024("1536x1024")
AUTO("auto")
JsonValue; type "image_generation.partial_image"constant"image_generation.partial_image"constant

The type of the event. Always image_generation.partial_image.

class ImageGenStreamEvent: A class that can be one of several variants.union

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

class ImageGenPartialImageEvent:

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

String b64Json

Base64-encoded partial image data, suitable for rendering as an image.

Background background

The background setting for the requested image.

Accepts one of the following:
TRANSPARENT("transparent")
OPAQUE("opaque")
AUTO("auto")
long createdAt

The Unix timestamp when the event was created.

OutputFormat outputFormat

The output format for the requested image.

Accepts one of the following:
PNG("png")
WEBP("webp")
JPEG("jpeg")
long partialImageIndex

0-based index for the partial image (streaming).

Quality quality

The quality setting for the requested image.

Accepts one of the following:
LOW("low")
MEDIUM("medium")
HIGH("high")
AUTO("auto")
Size size

The size of the requested image.

Accepts one of the following:
_1024X1024("1024x1024")
_1024X1536("1024x1536")
_1536X1024("1536x1024")
AUTO("auto")
JsonValue; type "image_generation.partial_image"constant"image_generation.partial_image"constant

The type of the event. Always image_generation.partial_image.

class ImageGenCompletedEvent:

Emitted when image generation has completed and the final image is available.

String b64Json

Base64-encoded image data, suitable for rendering as an image.

Background background

The background setting for the generated image.

Accepts one of the following:
TRANSPARENT("transparent")
OPAQUE("opaque")
AUTO("auto")
long createdAt

The Unix timestamp when the event was created.

OutputFormat outputFormat

The output format for the generated image.

Accepts one of the following:
PNG("png")
WEBP("webp")
JPEG("jpeg")
Quality quality

The quality setting for the generated image.

Accepts one of the following:
LOW("low")
MEDIUM("medium")
HIGH("high")
AUTO("auto")
Size size

The size of the generated image.

Accepts one of the following:
_1024X1024("1024x1024")
_1024X1536("1024x1536")
_1536X1024("1536x1024")
AUTO("auto")
JsonValue; type "image_generation.completed"constant"image_generation.completed"constant

The type of the event. Always image_generation.completed.

Usage usage

For the GPT image models only, the token usage information for the image generation.

long inputTokens

The number of tokens (images and text) in the input prompt.

InputTokensDetails inputTokensDetails

The input tokens detailed information for the image generation.

long imageTokens

The number of image tokens in the input prompt.

long textTokens

The number of text tokens in the input prompt.

long outputTokens

The number of image tokens in the output image.

long totalTokens

The total number of tokens (images and text) used for the image generation.

enum ImageModel:
GPT_IMAGE_1_5("gpt-image-1.5")
DALL_E_2("dall-e-2")
DALL_E_3("dall-e-3")
GPT_IMAGE_1("gpt-image-1")
GPT_IMAGE_1_MINI("gpt-image-1-mini")
class ImagesResponse:

The response from the image generation endpoint.

long created

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

Optional<Background> background

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

Accepts one of the following:
TRANSPARENT("transparent")
OPAQUE("opaque")
Optional<List<Image>> data

The list of generated images.

Optional<String> b64Json

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.

Optional<String> revisedPrompt

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

Optional<String> url

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.

Optional<OutputFormat> outputFormat

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

Accepts one of the following:
PNG("png")
WEBP("webp")
JPEG("jpeg")
Optional<Quality> quality

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

Accepts one of the following:
LOW("low")
MEDIUM("medium")
HIGH("high")
Optional<Size> size

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

Accepts one of the following:
_1024X1024("1024x1024")
_1024X1536("1024x1536")
_1536X1024("1536x1024")
Optional<Usage> usage

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

long inputTokens

The number of tokens (images and text) in the input prompt.

InputTokensDetails inputTokensDetails

The input tokens detailed information for the image generation.

long imageTokens

The number of image tokens in the input prompt.

long textTokens

The number of text tokens in the input prompt.

long outputTokens

The number of output tokens generated by the model.

long totalTokens

The total number of tokens (images and text) used for the image generation.

Optional<OutputTokensDetails> outputTokensDetails

The output token details for the image generation.

long imageTokens

The number of image output tokens generated by the model.

long textTokens

The number of text output tokens generated by the model.