Interface ImageEditParams

interface ImageEditParams {
    image: Uploadable;
    mask?: Uploadable;
    model?: null | string & {} | ImageModel;
    n?: null | number;
    prompt: string;
    response_format?: null | "url" | "b64_json";
    size?:
        | null
        | "256x256"
        | "512x512"
        | "1024x1024";
    user?: string;
}

Properties

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

Properties

image

image: Uploadable

The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.

Optionalmask

mask?: Uploadable

An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where image should be edited. 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 is supported at this time.

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.

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.

Optionalsize

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

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

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