Modules§
Structs§
- Assistant
Message Content Output Audio - Assistant
Message Content Output Text - Audio
- Audio
Input - Audio
Output - Audio
Transcription - Audio
Transcription Response - Configuration of the transcription model returned by the server.
- Cached
Token Details - Client
Secret Expiration - Client secret expiration configuration.
- Error
- Error
Code Message - Error
Message - G711ULAW
Audio Format - Input
Token Details - LogProb
Properties audio-typesorrealtime-types - Log probability information for a transcribed token.
- Output
Token Details - RealtimeAPI
Error - Realtime
Call Accept Request - Request to accept a Realtime call.
- Realtime
Call Create Request - Request to create a Realtime call.
- Realtime
Call Create Response - Response from creating a Realtime call.
- Realtime
Call Refer Request - Request to refer a Realtime call.
- Realtime
Call Reject Request - Request to reject a Realtime call.
- Realtime
Client Event Conversation Item Create - Realtime
Client Event Conversation Item Delete - Realtime
Client Event Conversation Item Retrieve - Realtime
Client Event Conversation Item Truncate - Realtime
Client Event Input Audio Buffer Append - Realtime
Client Event Input Audio Buffer Clear - Realtime
Client Event Input Audio Buffer Commit - Realtime
Client Event Input Text Append - Append UTF-8 text to the current incremental input.
- Realtime
Client Event Input Text Clear - Discard the current incremental text without creating an item.
- Realtime
Client Event Input Text Commit - Finalize the current incremental text as a user conversation item.
- Realtime
Client Event Output Audio Buffer Clear - Realtime
Client Event Response Cancel - Realtime
Client Event Response Create - Realtime
Client Event Session Update - Realtime
Conversation Item Function Call - Realtime
Conversation Item Function Call Output - Realtime
Conversation Item Message Assistant - Realtime
Conversation Item Message System - Realtime
Conversation Item Message User - Realtime
Create Client Secret Request - Request to create a Realtime client secret.
- Realtime
Create Client Secret Response - Response from creating a Realtime client secret.
- Realtime
Function Tool - RealtimeMCP
Approval Request - RealtimeMCP
Approval Response - RealtimeMCP
List Tools - RealtimeMCP
Protocol Error - RealtimeMCP
Tool Call - Realtime
Rate Limit - Realtime
Reasoning - Configuration for reasoning-capable Realtime models such as
gpt-realtime-2. - Realtime
Response - Realtime
Response Create Params - The response resource.
- Realtime
Response Status Detail - Realtime
Response Usage - Realtime
Server Event Conversation Item Added - Realtime
Server Event Conversation Item Deleted - Realtime
Server Event Conversation Item Done - Realtime
Server Event Conversation Item Input Audio Transcription Completed - Realtime
Server Event Conversation Item Input Audio Transcription Delta - Realtime
Server Event Conversation Item Input Audio Transcription Failed - Realtime
Server Event Conversation Item Input Audio Transcription Segment - Realtime
Server Event Conversation Item Retrieved - Realtime
Server Event Conversation Item Truncated - Realtime
Server Event Error - Realtime
Server Event Input Audio Buffer Cleared - Realtime
Server Event Input Audio Buffer Committed - Realtime
Server Event Input Audio Buffer Dtmf Event Received - SIP Only: Returned when a DTMF event is received. A DTMF event is a message that
represents a telephone keypad press (0–9, *, #, A–D). The
eventproperty is the keypad that the user pressed. Thereceived_atis the UTC Unix Timestamp that the server received the event. - Realtime
Server Event Input Audio Buffer Speech Started - Realtime
Server Event Input Audio Buffer Speech Stopped - Realtime
Server Event Input Audio Buffer Timeout Triggered - Realtime
Server EventMCP List Tools Completed - Realtime
Server EventMCP List Tools Failed - Realtime
Server EventMCP List Tools InProgress - Realtime
Server Event Output Audio Buffer Cleared - Realtime
Server Event Output Audio Buffer Started - Realtime
Server Event Output Audio Buffer Stopped - Realtime
Server Event Rate Limits Updated - Realtime
Server Event Response Audio Delta - Realtime
Server Event Response Audio Done - Realtime
Server Event Response Audio Transcript Delta - Realtime
Server Event Response Audio Transcript Done - Realtime
Server Event Response Content Part Added - Realtime
Server Event Response Content Part Done - Realtime
Server Event Response Created - Realtime
Server Event Response Done - Realtime
Server Event Response Function Call Arguments Delta - Realtime
Server Event Response Function Call Arguments Done - Realtime
Server Event ResponseMCP Call Arguments Delta - Realtime
Server Event ResponseMCP Call Arguments Done - Realtime
Server Event ResponseMCP Call Completed - Realtime
Server Event ResponseMCP Call Failed - Realtime
Server Event ResponseMCP Call InProgress - Realtime
Server Event Response Output Item Added - Realtime
Server Event Response Output Item Done - Realtime
Server Event Response Text Delta - Realtime
Server Event Response Text Done - Realtime
Server Event Session Created - Realtime
Server Event Session Updated - Realtime
Session - Realtime session object configuration. openapi spec type: RealtimeSessionCreateRequestGA
- Realtime
Transcription Session - Realtime transcription session object configuration. openapi spec type: RealtimeTranscriptionSessionCreateRequestGA
- Response
Audio - Response
Audio Output - Retention
Ratio Truncation - System
Message Content - Token
Limits - Token
Usage Input Token Details audio-typesorrealtime-types - Tracing
Configuration - Transcript
Text Usage Duration audio-typesorrealtime-types - Transcript
Text Usage Tokens audio-typesorrealtime-types - Transcription
Audio - User
Message Content Input Audio - User
Message Content Input Image - User
Message Content Input Text
Enums§
- Assistant
Message Content - Audio
Transcription Delay - Controls how long the model waits before emitting transcription text.
- Content
Part - Conversation
- Dynamo
Realtime Client Event - OpenAI Realtime client events plus inference-serving extensions from Dynamo.
- Function
Type - Image
Detail - MaxOutput
Tokens - Noise
Reduction Type - Type of noise reduction.
near_fieldis for close-talking microphones such as headphones,far_fieldis for far-field microphones such as laptop or conference room microphones. - Realtime
Audio Formats - Realtime
Client Event - These are events that the OpenAI Realtime WebSocket server will accept from the client.
- Realtime
Client Event Extension - Experimental Dynamo extensions to the OpenAI Realtime client event set.
- Realtime
Conversation Item - Realtime
Conversation Item Message - RealtimeMCP
Tool Call Error - Realtime
Rate Limit Name - Realtime
Reasoning Effort - Constrains effort on reasoning for reasoning-capable Realtime models such as
gpt-realtime-2. - Realtime
Response Status - Realtime
Response Status Detail Reason - Realtime
Response Status Detail Type - Realtime
Server Event - These are events emitted from the OpenAI Realtime WebSocket server to the client.
- Realtime
Session Configuration - Realtime
Tool - Realtime
Truncation - The truncation strategy to use for the session.
- Realtime
Turn Detection - Realtime
Voice - Session
- Tool
Choice - Tracing
- Transcription
Usage audio-typesorrealtime-types - User
Message Content
Traits§
- Event
Type - Returns the
typewire-tag string for a realtime event variant — useful for logging, error messages, and metric labels that need a stable name without reserializing the value.