openai · OpenAI Platform Docs
Realtime API with WebSocket | OpenAI API
Implementation guide for establishing and managing low-latency, bidirectional audio and text communication using the OpenAI Realtime API via WebSockets.
Derived skill
Files assembled from official documentation
Viewing SKILL.md
Realtime API with WebSocket | OpenAI API
Implementation guide for establishing and managing low-latency, bidirectional audio and text communication using the OpenAI Realtime API via WebSockets.
When To Use
Use when implementing real-time, low-latency voice or text interactions that require a persistent bidirectional connection between a client and the OpenAI Realtime API.
Reference Files
| File | Contains | Use For |
|---|---|---|
SKILL.md | Entry point: scope, routing table, and workflow. | Start here. |
docs/realtime-api-with-websocket-openai-workflow-guide.md | A guide explaining how to connect to the OpenAI Realtime API using WebSockets for server-to-server applications. | Questions about a guide explaining how to connect to the OpenAI Realtime API using WebSockets for server-to-server applications. |
examples/realtime-api-with-websocket-openai-openai-realtime-api-websocket-javascr.text | A JavaScript code snippet demonstrating how to establish a WebSocket connection to the OpenAI Realtime API using a specific model and authorization headers. | Exact payloads, commands, or snippets shown in A JavaScript code snippet demonstrating how to establish a WebSocket connection to the OpenAI Realtime API using a sp... |
examples/realtime-api-with-websocket-openai-openai-realtime-api-websocket-python-.text | A Python script using the websocket-client library to establish a connection to the OpenAI Realtime API via WebSocket. | Exact payloads, commands, or snippets shown in A Python script using the websocket-client library to establish a connection to the OpenAI Realtime API via WebSocket. |
examples/realtime-api-with-websocket-openai-openai-realtime-api-websocket-deno-cl.text | A JavaScript code example demonstrating how to establish a WebSocket connection to the OpenAI Realtime API in browser-like environments such as Deno or Cloudflare Workers. | Exact payloads, commands, or snippets shown in A JavaScript code example demonstrating how to establish a WebSocket connection to the OpenAI Realtime API in browser... |
examples/realtime-api-with-websocket-openai-openai-realtime-api-websocket-javascr-2.text | A JavaScript code snippet demonstrating how to establish a WebSocket connection to the OpenAI Realtime API using a specific model and authorization headers. | Exact payloads, commands, or snippets shown in A JavaScript code snippet demonstrating how to establish a WebSocket connection to the OpenAI Realtime API using a sp... |
What This Skill Covers
- WebSockets are a broadly supported API for realtime data transfer, and a great choice for connecting to the OpenAI Realtime API in server-to-server applicati...
- Main sections:
Connect via WebSocket,Sending and receiving events.
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/realtime-websockets