Implementation:Openai Openai python Response Image Gen Call Completed
| Knowledge Sources | |
|---|---|
| Domains | API_Types, Responses_API |
| Last Updated | 2026-02-15 00:00 GMT |
Overview
Concrete streaming event type for signaling that an image generation call has completed provided by the openai-python SDK.
Description
ResponseImageGenCallCompletedEvent is a Pydantic model emitted when an image generation tool call has completed and the final image is available. It carries the item_id identifying the image generation item, the output_index locating it within the response output array, and a sequence_number for event ordering. The type field is always "response.image_generation_call.completed".
Usage
Import this type when building streaming event handlers that need to detect when image generation has finished, so you can retrieve the final base64-encoded image from the corresponding output item.
Code Reference
Source Location
- Repository: openai-python
- File: src/openai/types/responses/response_image_gen_call_completed_event.py
Signature
class ResponseImageGenCallCompletedEvent(BaseModel):
"""Emitted when an image generation tool call has completed and the final image is available."""
item_id: str
output_index: int
sequence_number: int
type: Literal["response.image_generation_call.completed"]
Import
from openai.types.responses import ResponseImageGenCallCompletedEvent
I/O Contract
Fields
| Name | Type | Required | Description |
|---|---|---|---|
| item_id | str | Yes | The unique identifier of the image generation item being processed. |
| output_index | int | Yes | The index of the output item in the response's output array. |
| sequence_number | int | Yes | The sequence number of this event. |
| type | Literal["response.image_generation_call.completed"] | Yes | The type of the event. Always response.image_generation_call.completed.
|
Usage Examples
import openai
client = openai.OpenAI()
stream = client.responses.create(
model="gpt-4o",
input="Generate an image of a sunset over mountains.",
stream=True,
)
for event in stream:
if event.type == "response.image_generation_call.completed":
print(f"Image generation completed for item {event.item_id}")