Interface ImageEditParams

interface ImageEditParams {
    image: Uploadable | Uploadable[];
    mask?: Uploadable;
    model?: null | string & {} | ImageModel;
    n?: null | number;
    prompt: string;
    quality?:
        | null
        | "low"
        | "medium"
        | "high"
        | "auto"
        | "standard";
    response_format?: null | "url" | "b64_json";
    size?:
        | null
        | "256x256"
        | "512x512"
        | "1024x1024";
    user?: string;
}

Properties

image mask? model? n? prompt quality? response_format? size? user?

Properties

image

image: Uploadable | Uploadable[]

The image(s) to edit. Must be a supported image file or an array of images. For gpt-image-1, each image should be a png, webp, or jpg file less than 25MB. For dall-e-2, you can only provide one image, and it should be a square png file less than 4MB.

Optionalmask

mask?: Uploadable

An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. If there are multiple images provided, the mask will be applied on the first image. Must be a valid PNG file, less than 4MB, and have the same dimensions as image.

Optionalmodel

model?: null | string & {} | ImageModel

The model to use for image generation. Only dall-e-2 and gpt-image-1 are supported. Defaults to dall-e-2 unless a parameter specific to gpt-image-1 is used.

Optionaln

n?: null | number

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

prompt

prompt: string

A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2, and 32000 characters for gpt-image-1.

Optionalquality

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

The quality of the image that will be generated. high, medium and low are only supported for gpt-image-1. dall-e-2 only supports standard quality. Defaults to auto.

Optionalresponse_format

response_format?: null | "url" | "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. This parameter is only supported for dall-e-2, as gpt-image-1 will always return base64-encoded images.

Optionalsize

size?:
    | null
    | "256x256"
    | "512x512"
    | "1024x1024"

The size of the generated images. Must be one of 1024x1024, 1536x1024 (landscape), 1024x1536 (portrait), or auto (default value) for gpt-image-1, and one of 256x256, 512x512, or 1024x1024 for dall-e-2.

Optionaluser

user?: string

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

Settings

Member Visibility

On This Page

Properties