RealtimeAPIEvents

Contains information about connector.

Sent by the server when an Item is added to the default Conversation. https://platform.openai.com/docs/api-reference/realtime-server-events/conversation/item/added

Returned when an item in the conversation is deleted by the client with a conversation.item.delete event. https://platform.openai.com/docs/api-reference/realtime-server-events/conversation/item/deleted

Returned when a conversation item is finalized. https://platform.openai.com/docs/api-reference/realtime-server-events/conversation/item/done

This event is the output of audio transcription for user audio written to the user audio buffer. https://platform.openai.com/docs/api-reference/realtime-server-events/conversation/item/input_audio_transcription/completed

Returned when the text value of an input audio transcription content part is updated with incremental transcription results. https://platform.openai.com/docs/api-reference/realtime-server-events/conversation/item/input_audio_transcription/delta

Returned when input audio transcription is configured, and a transcription request for a user message failed. https://platform.openai.com/docs/api-reference/realtime-server-events/conversation/item/input_audio_transcription/failed

Returned when an input audio transcription segment is identified for an item. https://platform.openai.com/docs/api-reference/realtime-server-events/conversation/item/input_audio_transcription/segment

Returned when a conversation item is retrieved with conversation.item.retrieve. https://platform.openai.com/docs/api-reference/realtime-server-events/conversation/item/retrieved

Returned when an earlier assistant audio message item is truncated by the client with a conversation.item.truncate event. https://platform.openai.com/docs/api-reference/realtime-server-events/conversation/item/truncated

Returned when an error occurs, which could be a client problem or a server problem. https://platform.openai.com/docs/api-reference/realtime-server-events/error

The HTTP response event.

Returned when the input audio buffer is cleared by the client with an input_audio_buffer.clear event. https://platform.openai.com/docs/api-reference/realtime-server-events/input_audio_buffer/cleared

Returned when an input audio buffer is committed. https://platform.openai.com/docs/api-reference/realtime-server-events/input_audio_buffer/committed

Sent by the server when in server_vad mode to indicate that speech has been detected in the audio buffer. https://platform.openai.com/docs/api-reference/realtime-server-events/input_audio_buffer/speech_started

Returned in server_vad mode when the server detects the end of speech in the audio buffer. https://platform.openai.com/docs/api-reference/realtime-server-events/input_audio_buffer/speech_stopped

Returned when the Server VAD timeout is triggered for the input audio buffer. https://platform.openai.com/docs/api-reference/realtime-server-events/input_audio_buffer/timeout_triggered

Returned when listing MCP tools has completed for an item. https://platform.openai.com/docs/api-reference/realtime-server-events/mcp_list_tools/completed

Returned when listing MCP tools has failed for an item. https://platform.openai.com/docs/api-reference/realtime-server-events/mcp_list_tools/failed

Returned when listing MCP tools is in progress for an item. https://platform.openai.com/docs/api-reference/realtime-server-events/mcp_list_tools/in_progress

Emitted at the beginning of a Response to indicate the updated rate limits. https://platform.openai.com/docs/api-reference/realtime-server-events/rate_limits/updated

Returned when a new content part is added to an assistant message item during response generation. https://platform.openai.com/docs/api-reference/realtime-server-events/response/content_part/added

Returned when a content part is done streaming in an assistant message item. https://platform.openai.com/docs/api-reference/realtime-server-events/response/content_part/done

Returned when a new Response is created. https://platform.openai.com/docs/api-reference/realtime-server-events/response/created

Returned when a Response is done streaming. https://platform.openai.com/docs/api-reference/realtime-server-events/response/done

Returned when the model-generated function call arguments are updated. https://platform.openai.com/docs/api-reference/realtime-server-events/response/function_call_arguments/delta

Returned when the model-generated function call arguments are done streaming. https://platform.openai.com/docs/api-reference/realtime-server-events/response/function_call_arguments/done

Returned when MCP tool call arguments are updated during response generation. https://platform.openai.com/docs/api-reference/realtime-server-events/response/mcp_call_arguments/delta

Returned when MCP tool call arguments are finalized during response generation. https://platform.openai.com/docs/api-reference/realtime-server-events/response/mcp_call_arguments/done

Returned when an MCP tool call has completed successfully. https://platform.openai.com/docs/api-reference/realtime-server-events/response/mcp_call/completed

Returned when an MCP tool call has failed. https://platform.openai.com/docs/api-reference/realtime-server-events/response/mcp_call/failed

Returned when an MCP tool call has started and is in progress. https://platform.openai.com/docs/api-reference/realtime-server-events/response/mcp_call/in_progress

Returned when the model-generated audio is done. https://platform.openai.com/docs/api-reference/realtime-server-events/response/output_audio/done

Returned when the model-generated transcription of audio output is updated. https://platform.openai.com/docs/api-reference/realtime-server-events/response/output_audio_transcript/delta

Returned when the model-generated transcription of audio output is done streaming. https://platform.openai.com/docs/api-reference/realtime-server-events/response/output_audio_transcript/done

Returned when a new Item is created during Response generation. https://platform.openai.com/docs/api-reference/realtime-server-events/response/output_item/added

Returned when an Item is done streaming. https://platform.openai.com/docs/api-reference/realtime-server-events/response/output_item/done

Returned when the text value of an "output_text" content part is updated. https://platform.openai.com/docs/api-reference/realtime-server-events/response/output_text/delta

Returned when the text value of an "output_text" content part is done streaming. https://platform.openai.com/docs/api-reference/realtime-server-events/response/output_text/done

Returned when a Session is created. https://platform.openai.com/docs/api-reference/realtime-server-events/session/created

Returned when a session is updated with a session.update event, unless there is an error. https://platform.openai.com/docs/api-reference/realtime-server-events/session/updated

The unknown event.

The WebSocket error response event.