Server events

Server events are JSON messages emitted by the service on the Streaming Avatar WSS connection (control.url, which points to /v1/realtime-avatar/control). Each event includes an event_id and a type. Error events may also include the client event_id that caused the failure. Forward compatibility. Vivix may add new event types and fields over time. Clients must ignore any event type or field they do not recognize and must not disconnect on unknown data.

Which event should I listen to?

If you want to	Listen to
Know a response was accepted and has an id	`response.created`
Show live text or captions	`response.output_text.delta`
Show final text for a streamed text item	`response.output_text.done`
Receive the final output item, including completed function calls	`response.output_item.done`
Check final response status	`response.done`
Track when avatar media starts or stops rendering over RTC	`response.render.started` and `response.render.stopped`
Track user speech activity and transcription	`input_audio.speech_started`, `input_audio.speech_stopped`, and `conversation.item.input_audio_transcription.*`

Error Events

Event	What it does
`error`	Emitted when client or server processing fails.

Session Events

Event	What it does
`session.closed`	When a session closes, the service attempts to send this event before disconnecting the remaining control connections.
`session.updated`	Returns the session settings after an update is applied.
`session.update.done`	The terminal result for an accepted `session.update`.
`session.bootstrap.opening.done`	The bootstrap terminal event may replay to a new control connection.

Registry Events

Event	What it does
`asset.added`	Confirms registration of image references and reusable script assets.
`avatar.added`	Confirms that an `avatar.add` event was accepted and that the new avatars are available to select with `session.update`.

Conversation Events

Event	What it does
`conversation.item.created`	Reports a new conversation item created by the client or by response generation.
`conversation.item.retrieved`	Returns the item requested with `conversation.item.retrieve`.
`conversation.item.deleted`	Confirms that a conversation item was deleted.

Audio Events

Event	What it does
`input_audio.speech_started`	Emitted when the service detects user speech on the input audio stream.
`input_audio.speech_stopped`	Emitted when the service detects that user speech has stopped.

Transcription Events

Event	What it does
`conversation.item.input_audio_transcription.delta`	Streams partial transcription text for a user audio item when transcription is enabled.
`conversation.item.input_audio_transcription.completed`	Returns the final transcription for a user audio item.
`conversation.item.input_audio_transcription.failed`	Reports that transcription failed for a specific user audio item.

Response Events

Lifecycle distinction. response.created and response.done describe the response resource and logical output stream. response.render.started and response.render.stopped describe visible or audible avatar rendering over RTC. response.render.stopped is emitted before response.done for responses that enter avatar rendering. Responses that do not render, such as tool-call-only responses, proceed directly to response.done.

Event	What it does
`response.created`	Confirms a response was created and returns its ID.
`response.done`	Emitted when a response reaches its final state.
`response.render.started`	Returned when avatar output attributable to a response starts rendering over RTC.
`response.render.stopped`	Returned when avatar output attributable to a response is no longer rendering over RTC.
`response.output_item.done`	Returned when an item is done streaming.
`response.output_text.delta`	Streams incremental assistant text output, including text associated with spoken RTC media.
`response.output_text.done`	Returns final assistant text output, including text associated with spoken RTC media.

Continue reading

Persona · Speech recognition · Text model · Text to speech · Short vocal cues

Overview

A1: Streaming Avatar

W1: Streaming World

Blazing Fast Video Generation