RealtimeAPIEvents
Add the following line to your scenario code to use the events:
require(Modules.OpenAI);
Constants
Contains information about connector.
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Sent by the server when an Item is added to the default Conversation. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when an item in the conversation is deleted by the client with a conversation.item.delete event. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when a conversation item is finalized. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
This event is the output of audio transcription for user audio written to the user audio buffer. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when the text value of an input audio transcription content part is updated with incremental transcription results. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when input audio transcription is configured, and a transcription request for a user message failed. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when an input audio transcription segment is identified for an item. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when a conversation item is retrieved with conversation.item.retrieve. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when an earlier assistant audio message item is truncated by the client with a conversation.item.truncate event. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when an error occurs, which could be a client problem or a server problem. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The HTTP response event.
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when the input audio buffer is cleared by the client with an input_audio_buffer.clear event. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when an input audio buffer is committed. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Sent by the server when in server_vad mode to indicate that speech has been detected in the audio buffer. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned in server_vad mode when the server detects the end of speech in the audio buffer. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when the Server VAD timeout is triggered for the input audio buffer. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when listing MCP tools has completed for an item. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when listing MCP tools has failed for an item. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when listing MCP tools is in progress for an item. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Emitted at the beginning of a Response to indicate the updated rate limits. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when a new content part is added to an assistant message item during response generation. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when a content part is done streaming in an assistant message item. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when a new Response is created. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when a Response is done streaming. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when the model-generated function call arguments are updated. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when the model-generated function call arguments are done streaming. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when MCP tool call arguments are updated during response generation. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when MCP tool call arguments are finalized during response generation. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when an MCP tool call has completed successfully. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when an MCP tool call has failed. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when an MCP tool call has started and is in progress. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when the model-generated audio is done. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when the model-generated transcription of audio output is updated. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when the model-generated transcription of audio output is done streaming. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when a new Item is created during Response generation. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when an Item is done streaming. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when the text value of an "output_text" content part is updated. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when the text value of an "output_text" content part is done streaming. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when a realtime translation session is closed after OpenAI.RealtimeAPIClient.sessionClose. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when a Session is created. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when source-language transcript text is available in a realtime translation session. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when translated transcript text is available in a realtime translation session. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Returned when a session is updated with a session.update event, unless there is an error. https://developers.openai.com/api/reference/overview
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The unknown event.
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The WebSocket error response event.
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.