Interface ImageGeneration

A tool that generates images using a model like gpt-image-1.

interface ImageGeneration {
    background?: "auto" | "transparent" | "opaque";
    input_fidelity?: null | "low" | "high";
    input_image_mask?: InputImageMask;
    model?: "gpt-image-1";
    moderation?: "low" | "auto";
    output_compression?: number;
    output_format?: "jpeg" | "png" | "webp";
    partial_images?: number;
    quality?:
        | "low"
        | "medium"
        | "high"
        | "auto";
    size?:
        | "auto"
        | "1024x1024"
        | "1536x1024"
        | "1024x1536";
    type: "image_generation";
}

Properties

background? input_fidelity? input_image_mask? model? moderation? output_compression? output_format? partial_images? quality? size? type

Properties

Optionalbackground

background?: "auto" | "transparent" | "opaque"

Background type for the generated image. One of transparent, opaque, or auto. Default: auto.

Optionalinput_fidelity

input_fidelity?: null | "low" | "high"

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1. Supports high and low. Defaults to low.

Optionalinput_image_mask

input_image_mask?: InputImageMask

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

Optionalmodel

model?: "gpt-image-1"

The image generation model to use. Default: gpt-image-1.

Optionalmoderation

moderation?: "low" | "auto"

Moderation level for the generated image. Default: auto.

Optionaloutput_compression

output_compression?: number

Compression level for the output image. Default: 100.

Optionaloutput_format

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

The output format of the generated image. One of png, webp, or jpeg. Default: png.

Optionalpartial_images

partial_images?: number

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

Optionalquality

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

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

Optionalsize

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

The size of the generated image. One of 1024x1024, 1024x1536, 1536x1024, or auto. Default: auto.

type

type: "image_generation"

The type of the image generation tool. Always image_generation.

Settings

Member Visibility

On This Page

Properties