openai · OpenAI Platform Docs
WebSocket Mode | OpenAI API
Explains how to implement and use the WebSocket mode for real-time, low-latency multimodal interactions with the OpenAI API.
Derived skill
Files assembled from official documentation
Viewing SKILL.md
WebSocket Mode | OpenAI API
Explains how to implement and use the WebSocket mode for real-time, low-latency multimodal interactions with the OpenAI API.
When To Use
Use when implementing real-time, low-latency voice or multimodal applications that require bidirectional streaming via WebSockets instead of standard HTTP requests.
Reference Files
| File | Contains | Use For |
|---|---|---|
SKILL.md | Entry point: scope, routing table, and workflow. | Start here. |
docs/websocket-mode-openai-api-workflow-guide.md | A guide explaining how to use the WebSocket mode in the OpenAI Responses API for long-running, tool-call-heavy workflows. | Questions about a guide explaining how to use the WebSocket mode in the OpenAI Responses API for long-running, tool-call-heavy workfl... |
examples/websocket-mode-openai-api-openai-api-websocket-mode-python-response-crea.text | A Python script demonstrating how to establish a WebSocket connection to the OpenAI API and send a response.create event. | Exact payloads, commands, or snippets shown in A Python script demonstrating how to establish a WebSocket connection to the OpenAI API and send a response.create ev... |
examples/websocket-mode-openai-api-openai-api-websocket-response-create-json-payl.text | A JSON payload demonstrating the response.create event type for the OpenAI WebSocket API. | Exact payloads, commands, or snippets shown in A JSON payload demonstrating the response.create event type for the OpenAI WebSocket API. |
examples/websocket-mode-openai-api-openai-api-websocket-mode-response-create.text | A text example demonstrating how to compact an HTTP window and initiate a new response using the WebSocket response.create type. | Exact payloads, commands, or snippets shown in A text example demonstrating how to compact an HTTP window and initiate a new response using the WebSocket response.c... |
examples/websocket-mode-openai-api-openai-api-websocket-mode-error-response.text | A text representation of a 400 error response indicating a missing previous response ID within the OpenAI WebSocket API. | Exact payloads, commands, or snippets shown in A text representation of a 400 error response indicating a missing previous response ID within the OpenAI WebSocket API. |
examples/websocket-mode-openai-api-openai-api-websocket-mode-error-response-2.text | A text representation of a WebSocket error response indicating that the connection limit has been reached. | Exact payloads, commands, or snippets shown in A text representation of a WebSocket error response indicating that the connection limit has been reached. |
What This Skill Covers
- The Responses API supports a WebSocket mode for long-running, tool-call-heavy workflows. In this mode, you keep a persistent connection to /v1/responses and...
- Main sections:
Why use WebSocket mode,Connect and create responses,Continue with incremental inputs,How continuation works,Compaction and creating new responses.
Workflow
- Open the most relevant file under
docs/for the exact documented workflow and wording. - Open
schemas/files for exact structured contracts. - Open
examples/files for concrete requests, commands, snippets, and manifests. - Do not add behavior or configuration that is not present in the attached source files.
Canonical source: https://developers.openai.com/api/docs/guides/websocket-mode