Skip to main content
Updates the mode, active avatar, or registered source image. Omitted fields stay unchanged. Only the session state listed below is mutable; this does not update voice, tools, or prompts. session.updated acknowledges acceptance. For visual changes, also listen for session.update.done.

​
Event fields

​
string
Client-generated id for this event.
​
string
required
Event type. Must be session.update.
​
object
required
Partial session state to update.
​
string
New session mode. Supported values are text_chat and video_avatar. Switching to text_chat clears the effective source_image_id to null. Switching to video_avatar requires a renderable active avatar; if source_image_id is omitted, Vivix uses the current source image or derives one from the active avatar’s visual.default_source_image_id.
​
string
Avatar whose instructions should apply by default for later responses. In video_avatar mode, this is also the avatar rendered in the video stream.
​
string | null
Source image to use for avatar video. Used only in video_avatar mode. Use null to clear the selected source image; the effective value is also null in text_chat mode. Requests fail in video_avatar mode if no usable source image can be resolved.