{ "event_id": "evt_avatar_added_001", "type": "avatar.added", "avatars": [ { "avatar_id": "host_c", "persona": "You are Host C, a practical product specialist. Give clear, concise answers and use small gestures while explaining. Listen with relaxed eye contact.", "visual": { "source_images": [ { "source_image_id": "front", "url": "https://api.vivix.ai/host-c-front.png", "description": "A man facing the camera in a brightly lit studio, front view.", "media_type": "image/png" } ], "default_source_image_id": "front" } } ]}
Server events
avatar.added
{ "event_id": "evt_avatar_added_001", "type": "avatar.added", "avatars": [ { "avatar_id": "host_c", "persona": "You are Host C, a practical product specialist. Give clear, concise answers and use small gestures while explaining. Listen with relaxed eye contact.", "visual": { "source_images": [ { "source_image_id": "front", "url": "https://api.vivix.ai/host-c-front.png", "description": "A man facing the camera in a brightly lit studio, front view.", "media_type": "image/png" } ], "default_source_image_id": "front" } } ]}
Confirms that an avatar.add event was accepted and that the new avatars are available to select with session.update.
Event fields
string
required
Unique id for this server event.
string
required
Event type. Must be avatar.added.
array
required
Avatars registered by the accepted event.
string
required
Registered avatar id.
avatars[].persona, voice, visual: optional fieldsEffective avatar definition accepted by the service.
{ "event_id": "evt_avatar_added_001", "type": "avatar.added", "avatars": [ { "avatar_id": "host_c", "persona": "You are Host C, a practical product specialist. Give clear, concise answers and use small gestures while explaining. Listen with relaxed eye contact.", "visual": { "source_images": [ { "source_image_id": "front", "url": "https://api.vivix.ai/host-c-front.png", "description": "A man facing the camera in a brightly lit studio, front view.", "media_type": "image/png" } ], "default_source_image_id": "front" } } ]}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Vivix API Platform","description":"Build real-time interactive avatars, worlds, and blazing fast video generation with the Vivix API.","colors":{"primary":"#202124","light":"#E8EAED","dark":"#202124"},"logo":{"light":"https://mintcdn.com/vivix-20d305ce/_pH0P9NPGXmrYjpb/logo/light.svg?fit=max\u0026auto=format\u0026n=_pH0P9NPGXmrYjpb\u0026q=85\u0026s=baf0ff5242cbe15c7109578472ce97da","dark":"https://mintcdn.com/vivix-20d305ce/_pH0P9NPGXmrYjpb/logo/dark.svg?fit=max\u0026auto=format\u0026n=_pH0P9NPGXmrYjpb\u0026q=85\u0026s=589e9a9cf678ffb3e4d02b257709d2b2","href":"https://platform.vivix.ai"},"favicon":"https://mintcdn.com/vivix-20d305ce/_pH0P9NPGXmrYjpb/favicon.png?fit=max\u0026auto=format\u0026n=_pH0P9NPGXmrYjpb\u0026q=85\u0026s=5c253eff0d790be37c1e534f29b580b0","appearance":{"default":"light","strict":true},"background":{"color":{"light":"#F9F6F4","dark":"#141413"}},"navbar":{"primary":{"type":"button","label":"Developer Platform","href":"https://platform.vivix.ai"}},"seo":{"indexing":"navigable"},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vivix-20d305ce","hasAudioNarration":false,"actualSubdomain":"vivix-20d305ce","customDomains":["docs.vivix.ai"],"gitSource":{"type":"gitlab","owner":"vivix-labs","repo":"vivix-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"projectId":689,"hostUrl":"https://gitlab.vivix.work","mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6af736e036896a78e7f6275c","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API","count":73},{"language":"default","tag":"A1: Streaming Avatar","count":64},{"language":"default","tag":"API reference","count":45},{"language":"default","tag":"Server events","count":22},{"language":"default","tag":"Client events","count":8},{"language":"default","tag":"Integrate your app","count":7},{"language":"default","tag":"Agent","count":5},{"language":"default","tag":"Characters","count":5},{"language":"default","tag":"Sessions","count":5},{"language":"default","tag":"Voices","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--vivix-bg: #f9f6f4;--vivix-active: #e9e5e0;--vivix-line: #ddd8d3;--vivix-ink: #313131;--vivix-muted: #70757d;--vivix-note-bg: #f6f6f6}#sidebar-content li[data-active]>a{background-color:var(--vivix-active)!important;color:#202124!important}.callout[data-callout-type=\"note\"]{background-color:var(--vivix-note-bg)!important;border:0!important;border-left:3px solid var(--vivix-muted)!important;border-radius:6px!important}.callout[data-callout-type=\"note\"] [data-component-part=\"callout-content\"],.callout[data-callout-type=\"note\"] [data-component-part=\"callout-icon\"] svg{color:var(--vivix-ink)!important}#navbar{background-color:var(--vivix-bg);border-color:var(--vivix-line)}.columns>div>figure[data-name=\"frame\"]{height:100%}#w1-reference-pricing-note{background-color:#f0ece8;border-left:3px solid #b6aba0;border-radius:6px;padding:10px 14px;color:#5f6368;font-size:14px;line-height:1.5}#w1-reference-pricing-note strong{color:var(--vivix-ink);font-weight:600}.persona-map{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:16px;margin:28px 0 36px;color:#313131;font-size:13px;line-height:1.5}.persona-group-label{grid-column:1 / -1;color:#61716a;font-size:12px;font-weight:600}.persona-group-label:not(:first-child){margin-top:8px}.persona-speech{grid-column:1 / -1}.persona-outcome{display:flex;flex-direction:column;padding:20px;border:1px solid #ddd8d3;border-radius:16px;background:#f5f1ed}.persona-inputs{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:20px}.persona-inputs a,.persona-single-input{display:flex;flex-direction:column;gap:6px;text-decoration:none!important;border-bottom:0!important;color:#313131!important;font-weight:400}.persona-inputs a:hover .persona-module-title,.persona-single-input:hover .persona-module-title{text-decoration:underline}.persona-inputs a:focus-visible,.persona-single-input:focus-visible{outline:2px solid #617d79;outline-offset:4px;border-radius:3px}.persona-module-title{font-size:15px;line-height:1.4;font-weight:700}.persona-connector{margin:16px 0;text-align:center;color:#7b9788;font-size:23px;line-height:1}.persona-dialogue-scene{display:grid;grid-template-columns:1fr 1fr;gap:20px;align-items:center}.persona-speech-example{display:flex;flex-direction:column;gap:12px}.persona-viewer{color:#61716a;font-size:13px}.persona-reply{padding:14px 16px;border-radius:14px 14px 14px 3px;background:#fffaf5;border:1px solid #ddd8d3;font-size:15px;line-height:1.5}.persona-scene-caption{margin-top:12px;color:#576962;font-size:13px;line-height:1.6}.persona-map .persona-behavior-scene{width:100%;height:auto;margin:0}.persona-scene-labels{display:grid;grid-template-columns:1fr 1fr;gap:12px;margin-top:12px;color:#576962;font-size:13px;text-align:center}@media (max-width: 540px){.persona-map,.persona-inputs,.persona-dialogue-scene{grid-template-columns:minmax(0, 1fr)}.persona-speech,.persona-group-label{grid-column:1}.persona-dialogue-scene{gap:12px}}"}],"page":{"pagePath":"streaming-avatar/api-references/server-events/avatar-added","slug":"/streaming-avatar/api-references/server-events/avatar-added","pageMetadata":{"title":"avatar.added","description":null,"href":"/streaming-avatar/api-references/server-events/avatar-added"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Heading,ResponseField}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Confirms that an `,_jsx(_components.code,{children:`avatar.add`}),` event was accepted and that the new avatars are available to select with `,_jsx(_components.code,{children:`session.update`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`event-fields`,children:`Event fields`}),`\n`,_jsx(ResponseField,{name:`event_id`,type:`string`,required:true,id:`param-event-id`,children:_jsx(_components.p,{children:`Unique id for this server event.`})}),`\n`,_jsx(ResponseField,{name:`type`,type:`string`,required:true,id:`param-type`,children:_jsxs(_components.p,{children:[`Event type. Must be `,_jsx(_components.code,{children:`avatar.added`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`avatars`,type:`array`,required:true,id:`param-avatars`,children:_jsx(_components.p,{children:`Avatars registered by the accepted event.`})}),`\n`,_jsx(ResponseField,{name:`avatars[].avatar_id`,type:`string`,required:true,id:`param-avatars-avatar-id`,children:_jsx(_components.p,{children:`Registered avatar id.`})}),`\n`,_jsx(_components.p,{children:_jsxs(_components.strong,{children:[_jsx(_components.code,{children:`avatars[].persona`}),`, voice, visual: optional fields`]})}),`\n`,_jsx(_components.p,{children:`Effective avatar definition accepted by the service.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"avatar.added","description":null,"href":"/streaming-avatar/api-references/server-events/avatar-added"}}},"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Heading,ResponseExample,ResponseField}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Confirms that an `,_jsx(_components.code,{children:`avatar.add`}),` event was accepted and that the new avatars are available to select with `,_jsx(_components.code,{children:`session.update`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`event-fields`,children:`Event fields`}),`\n`,_jsx(ResponseField,{name:`event_id`,type:`string`,required:true,id:`param-event-id`,children:_jsx(_components.p,{children:`Unique id for this server event.`})}),`\n`,_jsx(ResponseField,{name:`type`,type:`string`,required:true,id:`param-type`,children:_jsxs(_components.p,{children:[`Event type. Must be `,_jsx(_components.code,{children:`avatar.added`}),`.`]})}),`\n`,_jsx(ResponseField,{name:`avatars`,type:`array`,required:true,id:`param-avatars`,children:_jsx(_components.p,{children:`Avatars registered by the accepted event.`})}),`\n`,_jsx(ResponseField,{name:`avatars[].avatar_id`,type:`string`,required:true,id:`param-avatars-avatar-id`,children:_jsx(_components.p,{children:`Registered avatar id.`})}),`\n`,_jsx(_components.p,{children:_jsxs(_components.strong,{children:[_jsx(_components.code,{children:`avatars[].persona`}),`, voice, visual: optional fields`]})}),`\n`,_jsx(_components.p,{children:`Effective avatar definition accepted by the service.`}),`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:`avatar.added`,numberOfLines:`21`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`21`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"event_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"evt_avatar_added_001\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"avatar.added\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"avatars\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"avatar_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"host_c\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"persona\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"You are Host C, a practical product specialist. Give clear, concise answers and use small gestures while explaining. Listen with relaxed eye contact.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"visual\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"source_images\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"source_image_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"front\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://api.vivix.ai/host-c-front.png\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"description\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"A man facing the camera in a brightly lit studio, front view.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"media_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"image/png\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"default_source_image_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"front\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"avatar.added","description":null,"href":"/streaming-avatar/api-references/server-events/avatar-added"}}}},"mdxExtracts":{"tableOfContents":[{"title":"Event fields","slug":"event-fields","depth":2,"children":[]}],"codeExamples":{"response":{"type":"ResponseExample","children":[{"filename":"avatar.added","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"json\">\u003ccode language=\"json\" numberOfLines=\"21\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"event_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"evt_avatar_added_001\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"avatar.added\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"avatars\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"avatar_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"host_c\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"persona\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"You are Host C, a practical product specialist. Give clear, concise answers and use small gestures while explaining. Listen with relaxed eye contact.\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"visual\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"source_images\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"source_image_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"front\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"url\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"https://api.vivix.ai/host-c-front.png\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"description\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"A man facing the camera in a brightly lit studio, front view.\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"media_type\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"image/png\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#116329;--shiki-dark:#9CDCFE\"> \"default_source_image_id\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: \u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\">\"front\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ]\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}}},"jsLinks":[],"subdomain":"vivix-20d305ce","siteName":"Vivix API Platform","title":"avatar.added - Vivix API Platform","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T16:37:25.224Z","originalFileLocation":"streaming-avatar/api-references/server-events/avatar-added.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Vivix API Platform\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vivix-20d305ce/4XVG5hka1siEhate/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/vivix-20d305ce/4XVG5hka1siEhate/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vivix-20d305ce/4XVG5hka1siEhate/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vivix-20d305ce/4XVG5hka1siEhate/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vivix-20d305ce/4XVG5hka1siEhate/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vivix-20d305ce/4XVG5hka1siEhate/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vivix-20d305ce/4XVG5hka1siEhate/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vivix-20d305ce/4XVG5hka1siEhate/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vivix-20d305ce/4XVG5hka1siEhate/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"avatar.added - Vivix API Platform\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vivix API Platform\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.vivix.ai/streaming-avatar/api-references/server-events/avatar-added\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vivix-20d305ce.mintlify.site/_mintlify/api/og/v2?division=Server+events\u0026amp;title=avatar.added\u0026amp;theme=c0ba66fadb8405a2f081edcf\u0026amp;signature=5070049cf31d84eac4f84f60e1a6c680ecc9502048cd7fad355b7758e687e93b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"avatar.added - Vivix API Platform\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vivix-20d305ce.mintlify.site/_mintlify/api/og/v2?division=Server+events\u0026amp;title=avatar.added\u0026amp;theme=c0ba66fadb8405a2f081edcf\u0026amp;signature=5070049cf31d84eac4f84f60e1a6c680ecc9502048cd7fad355b7758e687e93b\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/vivix-20d305ce/4XVG5hka1siEhate/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Vivix API Platform\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#202124\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.vivix.ai/streaming-avatar/api-references/server-events/avatar-added\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/streaming-avatar/api-references/server-events/avatar-added.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.vivix.ai/#organization\",\"name\":\"Vivix API Platform\",\"url\":\"https://docs.vivix.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vivix-20d305ce/_pH0P9NPGXmrYjpb/logo/light.svg?fit=max\u0026auto=format\u0026n=_pH0P9NPGXmrYjpb\u0026q=85\u0026s=baf0ff5242cbe15c7109578472ce97da\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.vivix.ai#website\",\"name\":\"Vivix API Platform\",\"url\":\"https://docs.vivix.ai\",\"publisher\":{\"@id\":\"https://docs.vivix.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.vivix.ai/streaming-avatar/api-references/server-events/avatar-added#webpage\",\"url\":\"https://docs.vivix.ai/streaming-avatar/api-references/server-events/avatar-added\",\"name\":\"avatar.added\",\"dateModified\":\"2026-11-06T16:37:25.224Z\",\"isPartOf\":{\"@id\":\"https://docs.vivix.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.vivix.ai/streaming-avatar/api-references/server-events/avatar-added#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.vivix.ai/streaming-avatar/api-references/server-events/avatar-added#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"A1: Streaming Avatar\",\"item\":\"https://docs.vivix.ai/streaming-avatar/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API reference\",\"item\":\"https://docs.vivix.ai/streaming-avatar/api-references/sessions/create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Server events\",\"item\":\"https://docs.vivix.ai/streaming-avatar/api-references/server-events\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"avatar.added\",\"item\":\"https://docs.vivix.ai/streaming-avatar/api-references/server-events/avatar-added\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.vivix.ai/streaming-avatar/api-references/server-events/avatar-added#article\",\"headline\":\"avatar.added\",\"name\":\"avatar.added\",\"url\":\"https://docs.vivix.ai/streaming-avatar/api-references/server-events/avatar-added\",\"mainEntityOfPage\":{\"@id\":\"https://docs.vivix.ai/streaming-avatar/api-references/server-events/avatar-added#webpage\"},\"dateModified\":\"2026-11-06T16:37:25.224Z\",\"publisher\":{\"@id\":\"https://docs.vivix.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.vivix.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Vivix API Platform\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Vivix API Platform\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/streaming-avatar/api-references/server-events/avatar-added.md","siteName":"Vivix API Platform","nav":{"global":null,"tabs":[{"tab":"API","icon":"code","groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/overview/introduction"},{"title":"Models","href":"/overview/models"}]},{"group":"A1: Streaming Avatar","pages":[{"title":"Streaming Avatar overview","sidebarTitle":"Overview","href":"/streaming-avatar/overview"},{"group":"Get started","pages":[{"title":"Avatar Playground","href":"/streaming-avatar/get-started/avatar-playground"},{"title":"Quickstart","href":"/streaming-avatar/get-started/quickstart"}]},{"group":"Define the character","pages":[{"title":"Prepare the first image","href":"/streaming-avatar/character/first-image"},{"title":"Choose a voice","href":"/streaming-avatar/character/voice"},{"title":"Write a Persona","sidebarTitle":"Persona","href":"/streaming-avatar/character/persona"},{"title":"Add tools to the character","href":"/streaming-avatar/character/tools"}]},{"group":"Interaction and performance","pages":[{"title":"Conversation and interruptions","href":"/streaming-avatar/interaction/conversation"},{"title":"Script speech and performances","href":"/streaming-avatar/interaction/scripted-performances"},{"title":"Change outfits and scenes","href":"/streaming-avatar/interaction/outfits-and-scenes"},{"title":"Object interaction","href":"/streaming-avatar/interaction/object-interaction"},{"title":"Respond quickly with short vocal cues","sidebarTitle":"Short vocal cues","href":"/streaming-avatar/interaction/acknowledgement"}]},{"group":"Integrate your app","pages":[{"title":"Create, manage, and close sessions","href":"/streaming-avatar/integrate/sessions"},{"title":"Connect with TRTC","href":"/streaming-avatar/integrate/trtc"},{"title":"Connect with Agora","href":"/streaming-avatar/integrate/agora"},{"title":"Configure speech recognition","href":"/streaming-avatar/integrate/speech-recognition"},{"title":"Configure the dialogue model","href":"/streaming-avatar/integrate/dialogue-model"},{"title":"Configure speech synthesis","href":"/streaming-avatar/integrate/speech-synthesis"},{"title":"Pure rendering mode","href":"/streaming-avatar/integrate/pure-rendering"}]},{"group":"API reference","pages":[{"group":"Sessions","root":{"title":"Sessions","href":"/streaming-avatar/api-references/sessions"},"pages":[{"title":"Create Session","openapi":"streaming-avatar/api-references/openapi.json POST /v1/realtime-avatar/sessions","href":"/streaming-avatar/api-references/sessions/create"},{"title":"Create Session from Character","openapi":"streaming-avatar/api-references/openapi.json POST /v1/realtime-avatar/character-sessions","href":"/streaming-avatar/api-references/sessions/create-from-character"},{"title":"Get Session","openapi":"streaming-avatar/api-references/openapi.json GET /v1/realtime-avatar/sessions/{session_id}","href":"/streaming-avatar/api-references/sessions/get"},{"title":"List Sessions","openapi":"streaming-avatar/api-references/openapi.json GET /v1/realtime-avatar/sessions","href":"/streaming-avatar/api-references/sessions/list"},{"title":"Close Session","openapi":"streaming-avatar/api-references/openapi.json POST /v1/realtime-avatar/sessions/{session_id}/close","href":"/streaming-avatar/api-references/sessions/close"}]},{"group":"Voices","root":{"title":"Voices","href":"/streaming-avatar/api-references/voices"},"pages":[{"title":"Upload Audio","openapi":"streaming-avatar/api-references/openapi.json POST /v1/files/audios","href":"/streaming-avatar/api-references/voices/upload-audio"},{"title":"Clone Voice","openapi":"streaming-avatar/api-references/openapi.json POST /v1/voices","href":"/streaming-avatar/api-references/voices/clone"},{"title":"Design Voice","openapi":"streaming-avatar/api-references/openapi.json POST /v1/voices/design","href":"/streaming-avatar/api-references/voices/design"},{"title":"List Voices","openapi":"streaming-avatar/api-references/openapi.json GET /v1/voices","href":"/streaming-avatar/api-references/voices/list"},{"title":"Get Voice","openapi":"streaming-avatar/api-references/openapi.json GET /v1/voices/{voice_id}","href":"/streaming-avatar/api-references/voices/get"}]},{"group":"Client events","root":{"title":"Client events","href":"/streaming-avatar/api-references/client-events"},"pages":[{"title":"session.update","href":"/streaming-avatar/api-references/client-events/session-update"},{"title":"asset.add","href":"/streaming-avatar/api-references/client-events/asset-add"},{"title":"avatar.add","href":"/streaming-avatar/api-references/client-events/avatar-add"},{"title":"conversation.item.create","href":"/streaming-avatar/api-references/client-events/conversation-item-create"},{"title":"conversation.item.retrieve","href":"/streaming-avatar/api-references/client-events/conversation-item-retrieve"},{"title":"conversation.item.delete","href":"/streaming-avatar/api-references/client-events/conversation-item-delete"},{"title":"response.create","href":"/streaming-avatar/api-references/client-events/response-create"},{"title":"response.cancel","href":"/streaming-avatar/api-references/client-events/response-cancel"}]},{"group":"Server events","root":{"title":"Server events","href":"/streaming-avatar/api-references/server-events"},"pages":[{"title":"error","href":"/streaming-avatar/api-references/server-events/error"},{"title":"session.closed","href":"/streaming-avatar/api-references/server-events/session-closed"},{"title":"session.updated","href":"/streaming-avatar/api-references/server-events/session-updated"},{"title":"session.update.done","href":"/streaming-avatar/api-references/server-events/session-update-done"},{"title":"session.bootstrap.opening.done","href":"/streaming-avatar/api-references/server-events/session-bootstrap-opening-done"},{"title":"asset.added","description":null,"href":"/streaming-avatar/api-references/server-events/asset-added"},{"title":"avatar.added","href":"/streaming-avatar/api-references/server-events/avatar-added"},{"title":"conversation.item.created","description":null,"href":"/streaming-avatar/api-references/server-events/conversation-item-created"},{"title":"conversation.item.retrieved","href":"/streaming-avatar/api-references/server-events/conversation-item-retrieved"},{"title":"conversation.item.deleted","href":"/streaming-avatar/api-references/server-events/conversation-item-deleted"},{"title":"input_audio.speech_started","href":"/streaming-avatar/api-references/server-events/input-audio-speech-started"},{"title":"input_audio.speech_stopped","href":"/streaming-avatar/api-references/server-events/input-audio-speech-stopped"},{"title":"conversation.item.input_audio_transcription.delta","href":"/streaming-avatar/api-references/server-events/conversation-item-input-audio-transcription-delta"},{"title":"conversation.item.input_audio_transcription.completed","href":"/streaming-avatar/api-references/server-events/conversation-item-input-audio-transcription-completed"},{"title":"conversation.item.input_audio_transcription.failed","href":"/streaming-avatar/api-references/server-events/conversation-item-input-audio-transcription-failed"},{"title":"response.created","href":"/streaming-avatar/api-references/server-events/response-created"},{"title":"response.done","href":"/streaming-avatar/api-references/server-events/response-done"},{"title":"response.render.started","href":"/streaming-avatar/api-references/server-events/response-render-started"},{"title":"response.render.stopped","href":"/streaming-avatar/api-references/server-events/response-render-stopped"},{"title":"response.output_item.done","href":"/streaming-avatar/api-references/server-events/response-output-item-done"},{"title":"response.output_text.delta","href":"/streaming-avatar/api-references/server-events/response-output-text-delta"},{"title":"response.output_text.done","href":"/streaming-avatar/api-references/server-events/response-output-text-done"}]},{"group":"Characters","root":{"title":"Characters","href":"/streaming-avatar/api-references/characters"},"pages":[{"title":"Create Character","openapi":"streaming-avatar/api-references/openapi.json POST /v1/characters","href":"/streaming-avatar/api-references/characters/create"},{"title":"List Characters","openapi":"streaming-avatar/api-references/openapi.json GET /v1/characters","href":"/streaming-avatar/api-references/characters/list"},{"title":"Get Character","openapi":"streaming-avatar/api-references/openapi.json GET /v1/characters/{character_id}","href":"/streaming-avatar/api-references/characters/get"},{"title":"Update Character","openapi":"streaming-avatar/api-references/openapi.json PUT /v1/characters/{character_id}","href":"/streaming-avatar/api-references/characters/update"},{"title":"Delete Character","openapi":"streaming-avatar/api-references/openapi.json DELETE /v1/characters/{character_id}","href":"/streaming-avatar/api-references/characters/delete"}]}]}]},{"group":"W1: Streaming World","pages":[{"title":"W1: Streaming World","href":"/streaming-world/configuration"},{"title":"Streaming Control","href":"/streaming-world/control"},{"group":"API References","pages":[{"title":"Sessions","href":"/streaming-world/api-references/sessions"},{"title":"Client Messages","sidebarTitle":"Client messages","href":"/streaming-world/api-references/client-events"},{"title":"Server Events","sidebarTitle":"Server events","href":"/streaming-world/api-references/server-events"}]}]},{"group":"Blazing Fast Video Generation","pages":[{"title":"Avatar Video Generation","sidebarTitle":"A1: Avatar Video Generation","href":"/video-generation/avatar-video-generation"},{"title":"World Video Generation","sidebarTitle":"W1: World Video Generation","href":"/video-generation/world-video-generation"}]}]},{"tab":"Agent","icon":"robot","pages":[{"title":"Agent","href":"/agent/overview"}]}]},"basePath":"","title":"avatar.added - Vivix API Platform","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["2b790eda92"],"chunks":["ApiExamples-DTsgtCEj.js","utils-BMo572L7.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","cloneDeep-izs3Hzxb.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js"]}