VoiceAgentAPIClient
Constructors
Methods
addEventListener(event: | , callback: Function
): void
Adds a handler for the specified XAI.VoiceAgentAPIEvents or XAI.Events event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.
Parameters
event:
Event class (i.e., XAI.VoiceAgentAPIEvents.ConversationCreated)
callback:
Function
Handler function. A single parameter is passed - object with event information
Returns
type:
void
clearMediaBuffer(parameters: ): void
Clears the XAI WebSocket media buffer.
Parameters
parameters:
OptionalOptional. Media buffer clearing parameters
Returns
type:
void
close(): void
Closes the XAI connection (over WebSocket) or connection attempt.
Returns
type:
void
conversationItemCreate(parameters: Object
): void
Create a new conversation item. https://docs.x.ai/developers/rest-api-reference/inference/voice#conversation.item.create
Parameters
parameters:
Object
Event parameters
Returns
type:
void
conversationItemDelete(parameters: Object
): void
Delete a conversation item by ID. https://docs.x.ai/developers/rest-api-reference/inference/voice#conversation.item.delete
Parameters
parameters:
Object
Event parameters
Returns
type:
void
conversationItemTruncate(parameters: Object
): void
Truncate a previous assistant audio message item. https://docs.x.ai/developers/rest-api-reference/inference/voice#conversation.item.truncate
Parameters
parameters:
Object
Event parameters
Returns
type:
void
id(): string
Returns the VoiceAgentAPIClient id.
Returns
type:
string
inputAudioBufferClear(parameters: Object
): void
Clear input audio buffer. https://docs.x.ai/developers/rest-api-reference/inference/voice#input_audio_buffer.clear
Parameters
parameters:
Object
Event parameters
Returns
type:
void
inputAudioBufferCommit(parameters: Object
): void
Commit the input audio buffer as a user message. Only available when turn_detection type is null. https://docs.x.ai/developers/rest-api-reference/inference/voice#input_audio_buffer.commit
Parameters
parameters:
Object
OptionalOptional. Event parameters
Returns
type:
void
removeEventListener(event: | , callback: Function
): void
Removes a handler for the specified XAI.VoiceAgentAPIEvents or XAI.Events event.
Parameters
event:
Event class (i.e., XAI.VoiceAgentAPIEvents.ConversationCreated)
callback:
Function
OptionalOptional. Handler function. If not specified, all handler functions are removed
Returns
type:
void
responseCancel(parameters: Object
): void
Send this event to cancel an in-progress response. https://docs.x.ai/developers/rest-api-reference/inference/voice#response.cancel
Parameters
parameters:
Object
Event parameters
Returns
type:
void
responseCreate(parameters: Object
): void
Request the server to create a new assistant response when using client side vad. (This is handled automatically when using server side vad.) Prefer nested { response: { ... } } body per xAI docs; flat fields are also accepted by the connector. https://docs.x.ai/developers/rest-api-reference/inference/voice#response.create
Parameters
parameters:
Object
Event parameters
Returns
type:
void
sendMediaTo(mediaUnit: , parameters: ): void
Starts sending media from the XAI (via WebSocket) to the media unit. XAI works in real time.
Parameters
mediaUnit:
Media unit that receives media
parameters:
OptionalOptional interaction parameters
Returns
type:
void
sessionUpdate(parameters: Object
): void
Send this event to update the session’s configuration. https://docs.x.ai/developers/rest-api-reference/inference/voice#session.update
Parameters
parameters:
Object
Event parameters
Returns
type:
void
stopMediaTo(mediaUnit: ): void
Stops sending media from the XAI (via WebSocket) to the media unit.
Parameters
mediaUnit:
Media unit that stops receiving media
Returns
type:
void
webSocketId(): string
Returns the XAI WebSocket id.
Returns
type:
string