Hello,
I am reporting what appears to be a discrepancy in the OpenAI documentation for the v1/responses endpoint, specifically related to streaming events for the Code Interpreter and certain other tools.
Issue Description
- Example in the Streaming Guide
In the “Streaming Responses” guide (https://platform.openai.com/docs/guides/streaming-responses?api-mode=responses), the example response for the Code Interpreter includes event names such as:
ResponseCodeInterpreterInProgress
ResponseCodeInterpreterCallCodeDelta
ResponseCodeInterpreterCallCodeDone
ResponseCodeInterpreterCallIntepreting
ResponseCodeInterpreterCallCompleted
This suggests that these events should be emitted when streaming with the Code Interpreter tool.
-
Omission from the API Reference
However, in the Streaming Responses section of the API reference (https://platform.openai.com/docs/api-reference/responses-streaming), there is no mention of any events related to “Code Interpreter.” The documented event types appear to cover only the core response payload (e.g.,ResponseStarted
,ResponseChunk
,ResponseDone
) and some generic tool-related events, but not the specific Code Interpreter stages listed above. -
Other Tools Missing from the Reference
Similarly, the guide example references additional tools—namely:
- Computer Vision (Computer use)
- Remote MCP
but none of these tool-specific events (e.g.,ResponseComputerUse*
,ResponseRemoteMCP*
) are listed in the API reference.
Expected Behavior
I had assumed that the API reference would enumerate all possible streaming event names and their payload schemas. In particular, I expected to find descriptions of:
ResponseCodeInterpreterInProgress
ResponseCodeInterpreterCallCodeDelta
ResponseCodeInterpreterCallCodeDone
ResponseCodeInterpreterCallIntepreting
ResponseCodeInterpreterCallCompleted
- Any analogous events for Computer Vision or Remote MCP
If these events do exist in the live service, they should be documented under the “Streaming” section of the API reference. If they have been deprecated or renamed, the guide should be updated to reflect the current event names.
Request for Clarification
- Am I misunderstanding how streaming events are documented for v1/responses?
- If Code Interpreter streaming events still exist, could you please update the API reference to include their names and payload structures?
- If those event names have changed (or if streaming for Code Interpreter is no longer supported), could you clarify the correct event names or deprecation status?
- Likewise, are there new or missing event names for “Computer use” and “Remote MCP” tools that should be added to the reference?
Thank you for your attention to this matter. Clarifying the documentation will help developers correctly implement streaming for advanced tools like Code Interpreter. Please let me know if you need any additional information.