RealtimeAPIEvents

The unknown event.

The HTTP response event.

Indicates an error occurred. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Sent by the server immediately when the WebSocket connection is established, carrying the session’s default configuration. Send a session.update to configure the session. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Confirms a session.update was applied. The server responds with a session.updated event. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

A new item was added to the conversation. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

An item finished being populated. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

An item was deleted from the conversation. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Response to conversation.item.retrieve. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

An assistant audio item was truncated. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Streaming partial transcription for user audio. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Final transcription for a user audio item. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

A new response was created. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

The response finished. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

An output item was added to the response. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

An output item finished. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

A content part was added to an output item. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

A content part finished. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Streaming text chunk from the model. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Text output finished. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Audio output for a content part finished. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Streaming transcript for generated audio. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Final transcript for generated audio. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Streaming function call arguments. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Function call arguments finished. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Voice activity detected: user started speaking. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Voice activity ended: user stopped speaking. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Buffered audio was committed as a conversation item. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Input audio buffer was cleared. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

An idle timeout was triggered on the input buffer. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Server started sending output audio. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Server stopped sending output audio. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

Output audio buffer was cleared.

Reports current rate limit state.

The WebSocket error response event.

Contains information about connector.