Interface ImageEditPartialImageEvent

Emitted when a partial image is available during image editing streaming.

interface ImageEditPartialImageEvent {
    b64_json: string;
    background: "auto" | "transparent" | "opaque";
    created_at: number;
    output_format: "jpeg" | "png" | "webp";
    partial_image_index: number;
    quality:
        | "low"
        | "medium"
        | "high"
        | "auto";
    size:
        | "auto"
        | "1024x1024"
        | "1536x1024"
        | "1024x1536";
    type: "image_edit.partial_image";
}

Properties

b64_json background created_at output_format partial_image_index quality size type

Properties

b64_json

b64_json: string

Base64-encoded partial image data, suitable for rendering as an image.

background

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

The background setting for the requested edited image.

created_at

created_at: number

The Unix timestamp when the event was created.

output_format

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

The output format for the requested edited image.

partial_image_index

partial_image_index: number

0-based index for the partial image (streaming).

quality

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

The quality setting for the requested edited image.

size

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

The size of the requested edited image.

type

type: "image_edit.partial_image"

The type of the event. Always image_edit.partial_image.

Settings

Member Visibility

On This Page

Properties