Rate this page:

RealtimeAPIEvents

Constants

ConnectorInformation

Copy URL

Contains information about connector.

Parameters

ConversationItemCreated

Copy URL

Returned when a new Item is created in the Conversation.

Parameters

ConversationItemDeleted

Copy URL

Returned when an item in the conversation is deleted by the client with a conversation.item.delete event.

Parameters

ConversationItemInputAudioTranscriptionCompleted

Copy URL

This event is the output of audio transcription for user audio written to the user audio buffer.

Parameters

ConversationItemInputAudioTranscriptionDelta

Copy URL

Returned when the text value of an input audio transcription content part is updated with incremental transcription results.

Parameters

ConversationItemInputAudioTranscriptionFailed

Copy URL

Returned when input audio transcription is configured, and a transcription request for a user message failed.

Parameters

ConversationItemInputAudioTranscriptionSegment

Copy URL

Returned when an input audio transcription segment is identified for an item.

Parameters

ConversationItemRetrieved

Copy URL

Returned when a conversation item is retrieved with conversation.item.retrieve.

Parameters

ConversationItemTruncated

Copy URL

Returned when an earlier assistant audio message item is truncated by the client with a conversation.item.truncate event.

Parameters

Error

Copy URL

Returned when an error occurs, which could be a client problem or a server problem.

Parameters

HTTPResponse

Copy URL

The HTTP response event.

Parameters

InputAudioBufferCleared

Copy URL

Returned when the input audio buffer is cleared by the client with an input_audio_buffer.clear event.

Parameters

InputAudioBufferCommitted

Copy URL

Returned when an input audio buffer is committed.

Parameters

InputAudioBufferSpeechStarted

Copy URL

Sent by the server when in server_vad mode to indicate that speech has been detected in the audio buffer.

Parameters

InputAudioBufferSpeechStopped

Copy URL

Returned in server_vad mode when the server detects the end of speech in the audio buffer.

Parameters

InputAudioBufferTimeoutTriggered

Copy URL

Returned when the Server VAD timeout is triggered for the input audio buffer.

Parameters

MCPListToolsCompleted

Copy URL

Returned when listing MCP tools has completed for an item.

Parameters

MCPListToolsFailed

Copy URL

Returned when listing MCP tools has failed for an item.

Parameters

MCPListToolsInProgress

Copy URL

Returned when listing MCP tools is in progress for an item.

Parameters

RateLimitsUpdated

Copy URL

Emitted at the beginning of a Response to indicate the updated rate limits.

Parameters

ResponseContentPartAdded

Copy URL

Returned when a new content part is added to an assistant message item during response generation.

Parameters

ResponseContentPartDone

Copy URL

Returned when a content part is done streaming in an assistant message item.

Parameters

ResponseCreated

Copy URL

Returned when a new Response is created.

Parameters

ResponseDone

Copy URL

Returned when a Response is done streaming.

Parameters

ResponseFunctionCallArgumentsDelta

Copy URL

Returned when the model-generated function call arguments are updated.

Parameters

ResponseFunctionCallArgumentsDone

Copy URL

Returned when the model-generated function call arguments are done streaming.

Parameters

ResponseMCPCallArgumentsDelta

Copy URL

Returned when MCP tool call arguments are updated during response generation.

Parameters

ResponseMCPCallArgumentsDone

Copy URL

Returned when MCP tool call arguments are finalized during response generation.

Parameters

ResponseMCPCallCompleted

Copy URL

Returned when an MCP tool call has completed successfully.

Parameters

ResponseMCPCallFailed

Copy URL

Returned when an MCP tool call has failed.

Parameters

ResponseMCPCallInProgress

Copy URL

Returned when an MCP tool call has started and is in progress.

Parameters

ResponseOutputAudioDone

Copy URL

Returned when the model-generated audio is done.

Parameters

ResponseOutputAudioTranscriptDelta

Copy URL

Returned when the model-generated transcription of audio output is updated.

Parameters

ResponseOutputAudioTranscriptDone

Copy URL

Returned when the model-generated transcription of audio output is done streaming.

Parameters

ResponseOutputItemAdded

Copy URL

Returned when a new Item is created during Response generation.

Parameters

ResponseOutputItemDone

Copy URL

Returned when an Item is done streaming.

Parameters

ResponseOutputTextDelta

Copy URL

Returned when the text value of an "output_text" content part is updated.

Parameters

ResponseOutputTextDone

Copy URL

Returned when the text value of an "output_text" content part is done streaming.

Parameters

SessionCreated

Copy URL

Returned when a Session is created.

Parameters

SessionUpdated

Copy URL

Returned when a session is updated with a session.update event, unless there is an error.

Parameters

Unknown

Copy URL

The unknown event.

Parameters

WebSocketError

Copy URL

The WebSocket error response event.

Parameters