openai / openai/openai-openapi
RealtimeResponseCreateParams does not support item_reference despite being documented in response.create example
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 2.5k
- Forks
- 527
- Avg merge
- 1h 46m
- Merged PRs (30d)
- 2
Description
The OpenAPI spec for RealtimeClientEventResponseCreate documents support for providing arbitrary input via the input field, including references to existing Items. However, the referenced schema (RealtimeResponseCreateParams) and its dependencies do not currently allow item_reference, making the documented example invalid per the schema
Expected behavior
RealtimeResponseCreateParams.input supports an item_reference object (e.g. via a discriminated union)
Why this matters
Referencing existing items is essential for:
- Out-of-band responses
- Reusing prior conversation items without duplicating content
- Efficient summarization / transformation workflows
The current mismatch between documentation and schema makes it difficult to build correct clients.
Hopefully, having this soon will help fixing https://github.com/openai/openai-python/issues/2794
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the OpenAPI definitions for RealtimeClientEventResponseCreate and RealtimeResponseCreateParams, then trace the schemas used by RealtimeResponseCreateParams.input. Compare them with the documented response.create example and add support for the item_reference variant; done means the example is valid against the resulting schema.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100