Skip to main content
Updates the 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
Session mode. The supported value is video_avatar; omit this field when changing the image.
string
Avatar to render and use for subsequent responses.
string | null
Registered source image to use for avatar video. If omitted, Vivix keeps the current image or selects the active avatar’s default image. The update must resolve to a usable source image.