RealtimeAPIClient

Methods

addEventListener

Adds a handler for the specified Inworld.RealtimeAPIEvents or Inworld.Events event.

1
addEventListener(event: Inworld.Events | Inworld.RealtimeAPIEvents | T, callback: (event: Inworld._RealtimeAPIClientEvents[T]) => any): void

Parameters

clearMediaBuffer

Clears the Inworld WebSocket media buffer.

1
clearMediaBuffer(parameters?: ClearMediaBufferParameters): void

Parameters

close

Closes the Inworld connection (over WebSocket) or connection attempt.

1
close(): void

conversationItemCreate

Add a conversation item (message, function call result, etc.). https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

1
conversationItemCreate(parameters: Object): void

Parameters

conversationItemDelete

Delete a conversation item by ID. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

1
conversationItemDelete(parameters: Object): void

Parameters

conversationItemRetrieve

Retrieve a conversation item by ID. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

1
conversationItemRetrieve(parameters: Object): void

Parameters

conversationItemTruncate

Truncate an assistant message’s audio. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

1
conversationItemTruncate(parameters: Object): void

Parameters

id

Returns the RealtimeAPIClient id.

1
id(): string

inputAudioBufferAppend

Append audio bytes to the input buffer. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

1
inputAudioBufferAppend(parameters: Object): void

Parameters

inputAudioBufferClear

Discard all audio in the input buffer. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

1
inputAudioBufferClear(parameters: Object): void

Parameters

inputAudioBufferCommit

Commit the buffered audio as a user message. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

1
inputAudioBufferCommit(parameters: Object): void

Parameters

outputAudioBufferClear

Clear the server’s output audio buffer, stopping playback. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

1
outputAudioBufferClear(parameters: Object): void

Parameters

removeEventListener

Removes a handler for the specified Inworld.RealtimeAPIEvents or Inworld.Events event.

1
removeEventListener(event: Inworld.Events | Inworld.RealtimeAPIEvents | T, callback?: (event: Inworld._RealtimeAPIClientEvents[T]) => any): void

Parameters

responseCancel

Cancel an in-progress response. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

1
responseCancel(parameters: Object): void

Parameters

responseCreate

Trigger a model response. The server streams back response events. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

1
responseCreate(parameters: Object): void

Parameters

sendMediaTo

Starts sending media from the Inworld (via WebSocket) to the media unit.

1
sendMediaTo(mediaUnit: VoxMediaUnit, parameters?: SendMediaParameters): void

Parameters

sessionUpdate

Update the session configuration. The server responds with a session.updated event. https://docs.inworld.ai/api-reference/realtimeAPI/realtime/realtime-websocket

1
sessionUpdate(parameters: Object): void

Parameters

stopMediaTo

Stops sending media from the Inworld (via WebSocket) to the media unit.

1
stopMediaTo(mediaUnit: VoxMediaUnit): void

Parameters

webSocketId

Returns the Inworld WebSocket id.

1
webSocketId(): string