Interface ImagesResponse

The response from the image generation endpoint.

interface ImagesResponse {
    background?: "transparent" | "opaque";
    created: number;
    data?: OpenAIClient.Images.Image[];
    output_format?: "jpeg" | "png" | "webp";
    quality?: "low" | "medium" | "high";
    size?: "1024x1024" | "1536x1024" | "1024x1536";
    usage?: OpenAIClient.Images.ImagesResponse.Usage;
}

Properties

background? created data? output_format? quality? size? usage?

Properties

Optionalbackground

background?: "transparent" | "opaque"

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

created

created: number

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

Optionaldata

data?: OpenAIClient.Images.Image[]

The list of generated images.

Optionaloutput_format

output_format?: "jpeg" | "png" | "webp"

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

Optionalquality

quality?: "low" | "medium" | "high"

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

Optionalsize

size?: "1024x1024" | "1536x1024" | "1024x1536"

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

Optionalusage

usage?: OpenAIClient.Images.ImagesResponse.Usage

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

Settings

Member Visibility

On This Page

Properties