Skip to main content

Module realtime

Module realtime 

Source
Expand description

OpenAI Realtime API wire models (GA: WebSocket GET /v1/realtime and WebRTC POST /v1/realtime/calls).

These modules mirror Realtime JSON wire shapes only; transport (WebSocket framing, SDP exchange) and provider conversion live outside this layer.

Structs§

NoiseReduction
RealtimeAudioConfig
RealtimeAudioInputConfig
RealtimeAudioOutputConfig
RealtimeError
RealtimeInputTokenDetails
RealtimeOutputTokenDetails
RealtimeRateLimit
RealtimeResponse
RealtimeResponseOptions
Per-response overrides for response.create.
RealtimeSessionConfig
RealtimeStatusDetails
RealtimeTranscriptionConfig
RealtimeUsage
UnknownRealtimeItem
UnknownRealtimeServerEvent

Enums§

KnownRealtimeItem
KnownRealtimeServerEvent
NoiseReductionType
NoiseReductionTypeKnown
RealtimeAudioFormat
RealtimeClientEvent
Events the client sends over the realtime WebSocket.
RealtimeContentPart
RealtimeItem
Conversation item as it appears in realtime events. Unknown item types (e.g. future MCP items) round-trip through UnknownRealtimeItem.
RealtimeItemStatus
RealtimeItemStatusKnown
RealtimeMaxTokens
RealtimeOutputModality
RealtimeOutputModalityKnown
RealtimeResponseStatus
RealtimeResponseStatusKnown
RealtimeRole
RealtimeRoleKnown
RealtimeServerEvent
Events the server sends over the realtime WebSocket. Unknown event types round-trip through UnknownRealtimeServerEvent; a known type whose payload fails to parse also degrades to Unknown so a live session never hard-fails on wire evolution.
RealtimeSessionType
RealtimeSessionTypeKnown
RealtimeTurnDetection
RealtimeTurnDetectionSetting
SemanticVadEagerness
SemanticVadEagernessKnown

Type Aliases§

RealtimeWireModel