platform-guideline 2 linked patterns checked
OpenAI Streaming API responses guide
Documents streaming model output with server-sent events so clients can display the beginning of a response while generation continues.
Read with a purpose
What this source can teach
Use this source to understand a platform convention and the setting it was designed for.
- Start with the original. Open the source and find the guidance or example relevant to your task.
- Trace the connection. Use the claim notes below to see how this site applies the source to specific patterns.
- Check the setting. Compare the source's platform, people, and constraints with your own decision.
Pattern Decisions This Source Supports
| Pattern | Supported decision | Required contract | Claim note |
|---|---|---|---|
| Agent progress trace | Choose agent progress trace when an agent or automation run has started and users need live status across multiple steps or tools. | The trace belongs to one run ID, reviewed plan version, objective, actor, start time, current state, and final state. | Supports streaming server-sent updates while agent or model work continues. |
| Streaming response | Choose streaming response when partial generated output is useful before the full answer is ready and the product can explain partial versus final state. | The UI never presents an active stream as a complete answer until the terminal event or final validation state arrives. | Supports rendering generated output while model generation continues. |
Comparisons supported by this source
- Agent progress trace vs agent plan preview vs streaming response vs activity log vs progress bar vs human approval gate
Supports server-sent updates while generated or agent work continues.
- Streaming response vs chat interface vs progress bar vs loading spinner vs feed
Supports rendering model output as it is generated through streaming responses.
Evidence Role
This source is treated as platform-guideline evidence. Its value comes from the specific claims and setting described above.
Publisher: OpenAI. Last checked: .