realtime library
Classes
- AudioFormat
- AudioFormatPcm
- AudioFormatPcma
- AudioFormatPcmu
- BaseRealtimeSession
- CachedTokenDetails
- Details about cached tokens used as input for a response.
- ClientSecret
- Conversation
- ConversationCreatedEvent
- ConversationItemAddedEvent
- ConversationItemCreatedEvent
- ConversationItemDeletedEvent
- ConversationItemDoneEvent
- ConversationItemInputAudioTranscriptionCompletedEvent
- ConversationItemInputAudioTranscriptionDeltaEvent
- ConversationItemInputAudioTranscriptionFailedEvent
- ConversationItemInputAudioTranscriptionSegmentEvent
- ConversationItemRetrievedEvent
- ConversationItemTruncatedEvent
- CreateRealtimeCallResponse
- Result of POST /v1/realtime/calls
- CreateRealtimeClientSecretResponse
- Result of POST /v1/realtime/client_secrets
- Eagerness
- InputAudioBufferAppendEvent
- Send base-64 audio bytes to the server-side buffer.
- InputAudioBufferClearedEvent
- InputAudioBufferClearEvent
- Clear (discard) any audio currently in the buffer.
- InputAudioBufferCommitEvent
- Commit the current input-audio buffer.
- InputAudioBufferCommittedEvent
- InputAudioBufferSpeechStartedEvent
- InputAudioBufferSpeechStoppedEvent
- InputAudioBufferTimeoutTriggeredEvent
- InputAudioTranscription
- InputTokenDetails
- Details about the input tokens used for transcription.
- Modality
- NoiseReduction
- NoiseReductionType
- OutputAudioBufferClearedEvent
- OutputAudioBufferClearEvent
- Stop (truncate) the currently-playing assistant audio.
- OutputAudioBufferStartedEvent
- OutputAudioBufferStoppedEvent
- RateLimit
- Helpful little DTO for each list element; keeps unknown keys intact.
- RateLimitsUpdatedEvent
- RealtimeConversationItem
- RealtimeConversationItemCreateEvent
- Client → server event that inserts a new item into the conversation.
- RealtimeConversationItemDeleteEvent
-
Delete an item from the conversation (→
conversation.item.deleted). - RealtimeConversationItemRetrieveEvent
-
Retrieve a single item (server → returns
conversation.item.retrieved). - RealtimeConversationItemTruncateEvent
-
Truncate already-sent assistant audio (→
conversation.item.truncated). - RealtimeErrorEvent
- RealtimeErrorInfo
- RealtimeEvent
- Base for every inbound / outbound realtime event. (You said this already exists – keeping a stub for context.)
- RealtimeFunctionCall
- RealtimeFunctionCallOutput
- RealtimeFunctionTool
- — function_tool
- RealtimeInputAudio
- RealtimeInputText
- RealtimeItemReferenceMessageContent
- RealtimeMcpApprovalRequest
- RealtimeMcpApprovalResponse
- RealtimeMcpCall
- RealtimeMcpListTools
- RealtimeMcpListToolsCompletedEvent
- Server → client: listing MCP tools completed for an item.
- RealtimeMcpListToolsFailedEvent
- Server → client: listing MCP tools failed for an item.
- RealtimeMcpListToolsInProgressEvent
- Server → client: listing MCP tools is in progress for an item.
- RealtimeMcpTool
- RealtimeMessageContent
- RealtimeMessageItem
- RealtimeModel
- Realtime-capable, low-latency models (WebSocket / /realtime/* APIs).
- RealtimeOutputAudio
- RealtimeOutputText
- RealtimeResponse
- RealtimeResponseAudioDeltaEvent
- RealtimeResponseAudioDoneEvent
- RealtimeResponseAudioTranscriptDeltaEvent
- RealtimeResponseAudioTranscriptDoneEvent
- RealtimeResponseCancelEvent
-
Client → server event to cancel an in-progress assistant Response.
The server will reply with
response.donewith a status ofcancelled. - RealtimeResponseContentPartAddedEvent
- RealtimeResponseContentPartDoneEvent
- RealtimeResponseCreatedEvent
- RealtimeResponseCreateEvent
- Client → server event that requests a new assistant Response. The server replies with: response.created → …items… → response.done
- RealtimeResponseDoneEvent
- RealtimeResponseFunctionCallArgumentsDeltaEvent
- RealtimeResponseFunctionCallArgumentsDoneEvent
- RealtimeResponseMcpCallArgumentsDeltaEvent
- Server → client: incremental JSON-string fragment of MCP tool-call args.
- RealtimeResponseMcpCallArgumentsDoneEvent
- Server → client: final JSON-encoded arguments for the MCP tool call.
- RealtimeResponseMcpCallCompletedEvent
- Server → client: MCP tool call completed successfully.
- RealtimeResponseMcpCallFailedEvent
- Server → client: MCP tool call failed.
- RealtimeResponseMcpCallInProgressEvent
- Server → client: MCP tool call has started and is in progress.
- RealtimeResponseOptions
- Per-request inference parameters (override session defaults only for this single response).
- RealtimeResponseOutputAudioDeltaEvent
- RealtimeResponseOutputAudioDoneEvent
- RealtimeResponseOutputAudioTranscriptDeltaEvent
- RealtimeResponseOutputAudioTranscriptDoneEvent
- RealtimeResponseOutputItemAddedEvent
- RealtimeResponseOutputItemDoneEvent
- RealtimeResponseOutputTextDeltaEvent
- RealtimeResponseOutputTextDoneEvent
- RealtimeResponseStatusDetails
- RealtimeResponseStatusDetailsError
- RealtimeResponseTextDeltaEvent
- RealtimeResponseTextDoneEvent
- RealtimeResponseUsage
-
Usage statistics for a
RealtimeResponse. - RealtimeSession
- Full assistant session (speech + text etc.)
- RealtimeSessionAudio
- RealtimeSessionAudioInput
- RealtimeSessionAudioOutput
- RealtimeSessionType
- RealtimeTool
- RealtimeTranscriptionSession
- Transcription-only realtime session.
- RealtimeTruncation
- RealtimeTruncationAuto
- RealtimeTruncationDisabled
- RealtimeTruncationRatio
- ResponseAudioOptions
- ResponseAudioOutputOptions
- ResponseInputTokenDetails
- Details about the input tokens used in a response.
- ResponseOutputTokenDetails
- Details about the output tokens used in a response.
- SessionCreatedEvent
- SessionUpdatedEvent
- SessionUpdateEvent
- Client → server event that requests the update.
- Tracing
- TracingAuto
-
Simple “use defaults” mode (
"auto"). - TracingDetailed
- Fully-specified config object.
- TracingDisabled
- Explicitly disabled.
- TranscriptionUsage
- Base class for polymorphic transcription usage statistics.
- TranscriptionUsageDuration
- Usage statistics for transcription models billed by audio duration.
- TranscriptionUsageTokens
- Usage statistics for transcription models billed by token count.
- TurnDetection
- TurnDetectionType