RealtimeAPIEvents
Add the following line to your scenario code to use the events:
require(Modules.Inworld);
Constants
Contains information about connector.
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
A new item was added to the conversation. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
An item was deleted from the conversation. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
An item finished being populated. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Final transcription for a user audio item. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Streaming partial transcription for user audio. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Response to conversation.item.retrieve. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
An assistant audio item was truncated. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Indicates an error occurred. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
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.
Input audio buffer was cleared. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Buffered audio was committed as a conversation item. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Voice activity detected: user started speaking. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Voice activity ended: user stopped speaking. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
An idle timeout was triggered on the input buffer. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Output audio buffer was cleared.
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Server started sending output audio. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Server stopped sending output audio. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Reports current rate limit state.
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
A content part was added to an output item. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
A content part finished. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
A new response was created. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
The response finished. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Streaming function call arguments. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Function call arguments finished. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Audio output for a content part finished. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Streaming transcript for generated audio. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Final transcript for generated audio. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
An output item was added to the response. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
An output item finished. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Streaming text chunk from the model. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Text output finished. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
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
Parameters
client:
The Inworld.RealtimeAPIClient instance.
data:
{customEvent: string, payload: Object}
OptionalThe 'payload' parameter contains the event's data.
Confirms a session.update was applied. The server responds with a session.updated event. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket
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.