Interface ResponseImageGenCallPartialImageEvent

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

interface ResponseImageGenCallPartialImageEvent {
    item_id: string;
    output_index: number;
    partial_image_b64: string;
    partial_image_index: number;
    sequence_number: number;
    type: "response.image_generation_call.partial_image";
}

Properties

item_id: string

The unique identifier of the image generation item being processed.

output_index: number

The index of the output item in the response's output array.

partial_image_b64: string

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

partial_image_index: number

0-based index for the partial image (backend is 1-based, but this is 0-based for the user).

sequence_number: number

The sequence number of the image generation item being processed.

type: "response.image_generation_call.partial_image"

The type of the event. Always 'response.image_generation_call.partial_image'.