Prompt Buddy logoPrompt Buddy

openai · OpenAI Platform Docs

Webhooks and server-side controls

Teaches how to implement a sideband control channel using WebSockets to manage Realtime API sessions for both WebRTC and SIP connections. It explains how to extract a call ID from SDP responses or webhooks to establis...

Import to Prompt Buddy

Derived skill

Files assembled from official documentation

Viewing SKILL.md

Webhooks and server-side controls

Teaches how to implement a sideband control channel using WebSockets to manage Realtime API sessions for both WebRTC and SIP connections. It explains how to extract a call ID from SDP responses or webhooks to establis...

When To Use

Use when you need to implement server-side tool calling, session monitoring, or dynamic instruction updates for Realtime API sessions initiated via WebRTC or SIP.

Reference Files

FileContainsUse For
SKILL.mdEntry point: scope, routing table, and workflow.Start here.
docs/webhooks-and-server-side-controls-workflow-guide.mdA guide explaining how to implement tool use and business logic on an application server using WebRTC or SIP with the OpenAI Realtime API.Questions about a guide explaining how to implement tool use and business logic on an application server using WebRTC or SIP with the...
examples/webhooks-and-server-side-controls-openai-realtime-server-controls-javasc.javascriptA JavaScript implementation demonstrating how to send an SDP offer to the OpenAI Realtime API endpoint using the fetch API.Exact payloads, commands, or snippets shown in A JavaScript implementation demonstrating how to send an SDP offer to the OpenAI Realtime API endpoint using the fetc...
examples/webhooks-and-server-side-controls-openai-realtime-server-controls-javasc-2.javascriptA JavaScript code snippet demonstrating how to extract a call ID from the Location header in a realtime server control response.Exact payloads, commands, or snippets shown in A JavaScript code snippet demonstrating how to extract a call ID from the Location header in a realtime server contro...
examples/webhooks-and-server-side-controls-openai-realtime-server-controls-websoc.javascriptA JavaScript example demonstrating how to connect to an OpenAI Realtime API WebSocket using a call ID to implement server-side controls.Exact payloads, commands, or snippets shown in A JavaScript example demonstrating how to connect to an OpenAI Realtime API WebSocket using a call ID to implement se...
examples/webhooks-and-server-side-controls-openai-webhooks-server-side-controls-j.jsonA JSON payload representing an incoming webhook request for OpenAI server-side controls including headers and signature data.Exact payloads, commands, or snippets shown in A JSON payload representing an incoming webhook request for OpenAI server-side controls including headers and signatu...

What This Skill Covers

  • The Realtime API allows clients to connect directly to the API server via WebRTC or SIP. However, you'll most likely want tool use and other business logic t...
  • Main sections: With WebRTC, With SIP.

Workflow

  1. Open the most relevant file under docs/ for the exact documented workflow and wording.
  2. Open schemas/ files for exact structured contracts.
  3. Open examples/ files for concrete requests, commands, snippets, and manifests.
  4. 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-server-controls.md