`ImageGenerationCall` input param type incorrectly requires `result` and `status`

[DouweM]

Confirm this is an issue with the Python library and not an underlying OpenAI API

• This is an issue with the Python library

Describe the bug

This "Using image ID" example shows they are not required:

https://platform.openai.com/docs/guides/image-generation?multi-turn=imageid&image-generation-model=gpt-image-1#multi-turn-image-generation

The code incorrectly claims they are:

openai-python/src/openai/types/responses/response_input_item_param.py

Lines 124 to 135 in 71dedfa

	class ImageGenerationCall(TypedDict, total=False):
	id: Required[str]
	"""The unique ID of the image generation call."""
	result: Required[Optional[str]]
	"""The generated image encoded in base64."""
	status: Required[Literal["in_progress", "completed", "generating", "failed"]]
	"""The status of the image generation call."""
	type: Required[Literal["image_generation_call"]]
	"""The type of the image generation call. Always `image_generation_call`."""

To Reproduce

Run the referenced example, see that it works, despite a typing error.

Code snippets

OS

macOS

Python version

3.12.9

Library version

1.107.2

[JiwaniZakir]

Looking at response_input_item_param.py around line 124, the ImageGenerationCall TypedDict has result and status as required keys, but the API docs show they're optional when passing an image ID for multi-turn generation. The fix should be marking those fields as NotRequired in the TypedDict (or moving them to non-total keys). I can put up a PR for this.

[JiwaniZakir]

Dropping my claim on this one — my fix for the ImageGenerationCall input type didn't pass the project's quality checks. Free for anyone else to pick up.

[theamodhshetty]

Put up a fix in #2973.

The change makes ImageGenerationCall input params stop requiring result and status, which matches the image-id multi-turn example, and adds a small regression test so pyright catches it if the generated types drift again.