Interface ImageEditParamsStreaming

interface ImageEditParamsStreaming {
    background?:
        | null
        | "auto"
        | "transparent"
        | "opaque";
    image: Uploadable | Uploadable[];
    input_fidelity?: null | "low" | "high";
    mask?: Uploadable;
    model?: null | string & {} | ImageModel;
    n?: null | number;
    output_compression?: null | number;
    output_format?:
        | null
        | "jpeg"
        | "png"
        | "webp";
    partial_images?: null | number;
    prompt: string;
    quality?:
        | null
        | "low"
        | "medium"
        | "high"
        | "auto"
        | "standard";
    response_format?: null | "url" | "b64_json";
    size?:
        | null
        | "auto"
        | "256x256"
        | "512x512"
        | "1024x1024"
        | "1536x1024"
        | "1024x1536";
    stream: true;
    user?: string;
}

Hierarchy

  • ImageEditParamsBase
    • ImageEditParamsStreaming

Properties

background? image input_fidelity? mask? model? n? output_compression? output_format? partial_images? prompt quality? response_format? size? stream user?

Properties

Optionalbackground

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

Allows to set transparency for the background of the generated image(s). This parameter is only supported for gpt-image-1. Must be one of transparent, opaque or auto (default value). When auto is used, the model will automatically determine the best background for the image.

If transparent, the output format needs to support transparency, so it should be set to either png (default value) or webp.

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 50MB. You can provide up to 16 images.

For dall-e-2, you can only provide one image, and it should be a square png file less than 4MB.

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.

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.

Optionaloutput_compression

output_compression?: null | number

The compression level (0-100%) for the generated images. This parameter is only supported for gpt-image-1 with the webp or jpeg output formats, and defaults to 100.

Optionaloutput_format

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

The format in which the generated images are returned. This parameter is only supported for gpt-image-1. Must be one of png, jpeg, or webp. The default value is png.

Optionalpartial_images

partial_images?: null | number

The number of partial images to generate. This parameter is used for streaming responses that return partial images. Value must be between 0 and 3. When set to 0, the response will be a single image sent in one streaming event.

Note that the final image may be sent before the full number of partial images are generated if the full image is generated more quickly.

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
    | "auto"
    | "256x256"
    | "512x512"
    | "1024x1024"
    | "1536x1024"
    | "1024x1536"

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.

stream

stream: true

Edit the image in streaming mode. Defaults to false. See the Image generation guide for more information.

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