{"version":1,"pages":[{"id":"pFMIlVh3aGhHqpINgQIU","title":"Welcome","pathname":"/api-docs","siteSpaceId":"sitesp_wqN6M","description":"Start here to create, customize, test, and share interactive AI characters with Convai, covering Playground, no-code experiences, plugins and integrations, and API reference."},{"id":"41Q0qvQwmIZYFETUyYIc","title":"Get Started","pathname":"/api-docs/convai-playground/get-started","siteSpaceId":"sitesp_wqN6M","description":"A guided overview of the first steps in Convai Playground, including navigation, character creation, testing, and essential global controls.","breadcrumbs":[{"label":"Convai Playground"}]},{"id":"pyJBFrVIlYqmEzXGRG74","title":"Dashboard Overview","pathname":"/api-docs/convai-playground/get-started/dashboard-overview","siteSpaceId":"sitesp_wqN6M","description":"Learn how to navigate and use the Convai Playground Dashboard to manage characters, experiences, and simulations efficiently.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"1agb1T1gwGFVdO5CH1P5","title":"Creating a New Character","pathname":"/api-docs/convai-playground/get-started/creating-a-new-character","siteSpaceId":"sitesp_wqN6M","description":"Learn how to create and customize a new AI character in Convai Playground, including description, avatar, voice, and language settings.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"DVUL91wEFtZZ6jBkbHTt","title":"Testing a Character","pathname":"/api-docs/convai-playground/get-started/testing-a-character","siteSpaceId":"sitesp_wqN6M","description":"Learn the different ways to test your AI character in Convai Playground, including text chat, voice input, and video call with an avatar.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"QC1r2g57kZyPjFX2SZzP","title":"Global Character Controls","pathname":"/api-docs/convai-playground/get-started/global-character-controls","siteSpaceId":"sitesp_wqN6M","description":"A single reference for the shared toolbar controls available across all character pages in Convai Playground, including Versioning, Update, and Character Settings.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"x0BSOwHlqiBM9Qw49zui","title":"Character Versioning","pathname":"/api-docs/convai-playground/get-started/character-versioning","siteSpaceId":"sitesp_wqN6M","description":"Manage multiple versions of character and switch between them as required.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"A7G2tHGNEZICB8Hu5zNr","title":"Interact in Voice Mode","pathname":"/api-docs/convai-playground/get-started/interact-in-voice-mode","siteSpaceId":"sitesp_wqN6M","description":"Enable real-time, low-latency voice conversations with your Convai character using Voice Mode for natural, hands-free interactions.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"j4sTdssjBd3tQtEEshBg","title":"Character Customization","pathname":"/api-docs/convai-playground/character-customization","siteSpaceId":"sitesp_wqN6M","description":"Learn how to refine your AI character’s personality, appearance, knowledge, and behavior to create consistent and engaging interactions.","breadcrumbs":[{"label":"Convai Playground"}]},{"id":"izmhrnoQkFUEhckJYF5w","title":"Character Description","pathname":"/api-docs/convai-playground/character-customization/character-description","siteSpaceId":"sitesp_wqN6M","description":"Learn how to use the Character Description page in Convai Playground to define your character’s identity, speaking style, and unique traits.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"xYNqL3nGQ6Yzl0agxI8q","title":"Avatar Studio","pathname":"/api-docs/convai-playground/character-customization/avatar-section","siteSpaceId":"sitesp_wqN6M","description":"Learn how to access and customize your character’s avatar in Convai Playground using Avatar Studio.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"WEKrAcz1SyYUo9EnGJtq","title":"Language And Speech","pathname":"/api-docs/convai-playground/character-customization/language-and-speech","siteSpaceId":"sitesp_wqN6M","description":"Learn how to configure languages, voices, custom pronunciations, and word recognition for your AI character in Convai Playground.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"hoKnTfp2FxSbDLPI6C4k","title":"Knowledge Bank","pathname":"/api-docs/convai-playground/character-customization/knowledge-bank","siteSpaceId":"sitesp_wqN6M","description":"Learn how to upload, manage, and connect knowledge files to your AI character using Knowledge Bank.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"7NqGRdXVakURpzyxcX0S","title":"Personality Traits","pathname":"/api-docs/convai-playground/character-customization/personality-traits","siteSpaceId":"sitesp_wqN6M","description":"Learn how to customize your AI character’s personality using presets or manual trait adjustments.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"zaMRHpXnaDARX9ZGZgO6","title":"Core AI Settings","pathname":"/api-docs/convai-playground/character-customization/core-ai-settings","siteSpaceId":"sitesp_wqN6M","description":"Learn how to configure moderation, foundation model selection, and temperature for your AI character","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"mdYVNsUXIZrtJGq4CcEt","title":"Guardrails","pathname":"/api-docs/convai-playground/character-customization/guardrails","siteSpaceId":"sitesp_wqN6M","description":"The Guardrails tab is a safety and control interface designed to restrict and guide a character's AI behavior. It allows creators to define the ethical and topical boundaries of the conversation.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"euTj9gaXMcDOcoEvKr26","title":"State Of Mind","pathname":"/api-docs/convai-playground/character-customization/state-of-mind","siteSpaceId":"sitesp_wqN6M","description":"Learn how the State of Mind feature visualizes your AI character’s emotional state in real time during conversations.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"aAGm9eZJV0AVSVTsPaov","title":"Memory","pathname":"/api-docs/convai-playground/character-customization/memory","siteSpaceId":"sitesp_wqN6M","description":"Learn how to use the Memory feature to review past sessions, manage conversation history, and enable long-term memory for your character.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"eKYhbAZMbPHYOBWvFWhT","title":"Mindview","pathname":"/api-docs/convai-playground/character-customization/mindview","siteSpaceId":"sitesp_wqN6M","description":"Learn how to use the Mindview feature to review the actual prompts to the LLM for your current or previous sessions and interactions.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"bHvht3CwA8bDmCDcwdcd","title":"Narrative Design | Playground","pathname":"/api-docs/convai-playground/character-customization/narrative-design","siteSpaceId":"sitesp_wqN6M","description":"Build goal‑oriented conversation flows using sections, decisions, and triggers that move the story forward without rigid dialogue trees.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"qf4NbtXNuBVaWaCGbchz","title":"External API","pathname":"/api-docs/convai-playground/character-customization/external-api","siteSpaceId":"sitesp_wqN6M","description":"Learn how to integrate and configure the External API feature to enable your characters to access real-time information, create tasks, and interact with third-party platforms.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"bp1e8yWNdIT26u2PSgBU","title":"Publish","pathname":"/api-docs/convai-playground/character-customization/publish","siteSpaceId":"sitesp_wqN6M","description":"Learn how to publish and share your Convai Experience with the public, selected users, or embed it on your own website.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"TieBWynAKx8Ei5oExSzd","title":"Avatar Studio Experiences","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences","siteSpaceId":"sitesp_wqN6M","description":"Create intelligent 3D AI avatars directly in your browser — no downloads, no code, fully customizable.","breadcrumbs":[{"label":"No Code Experiences"}]},{"id":"r9B8q8s3zXPBKq65TeZ9","title":"Customizing Your Avatar","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar","siteSpaceId":"sitesp_wqN6M","description":"Learn how to visually and behaviorally personalize your Convai avatar using the Avatar Studio configurator.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"}]},{"id":"rnoxZ2yBz6tBkvMluZUT","title":"Configure Avatar","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/configure-avatar","siteSpaceId":"sitesp_wqN6M","description":"Learn how to choose, customize, or upload avatars in Avatar Studio.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"3gF4TWlNAR7gdcrwFIfb","title":"Uploading Avatars","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/configure-avatar/uploading-avatars","siteSpaceId":"sitesp_wqN6M","description":"","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"},{"label":"Configure Avatar"}]},{"id":"7RiOQDqXiSshcIxvesJU","title":"Metahuman Avatars","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/configure-avatar/uploading-avatars/metahuman-avatars","siteSpaceId":"sitesp_wqN6M","description":"Upload custom Metahuman characters from Unreal Engine to Avatar Studio using the Convai Asset Uploader.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"},{"label":"Configure Avatar"},{"label":"Uploading Avatars"}]},{"id":"KaEFOuvtwU0O5irCjn9v","title":"Reallusion Avatars","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/configure-avatar/uploading-avatars/reallusion-avatars","siteSpaceId":"sitesp_wqN6M","description":"Upload custom Reallusion characters from Unreal Engine to Avatar Studio using the Convai Asset Uploader.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"},{"label":"Configure Avatar"},{"label":"Uploading Avatars"}]},{"id":"6wQK6C3Tz1gDZ2X7t7gb","title":"Face Filter","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/face-filter","siteSpaceId":"sitesp_wqN6M","description":"Use the Face Filter feature to make your avatar resemble a specific person based on a photo.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"Fu7cIEYNH9oHgjdi8qkw","title":"Environment","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/environment","siteSpaceId":"sitesp_wqN6M","description":"Choose from immersive 3D and Solid environments to place your avatar in the right setting.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"ja8N9ZC28t5Vc0qixai9","title":"Lighting Adjustments","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/lighting-adjustments","siteSpaceId":"sitesp_wqN6M","description":"","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"zN3Zw1qIulaXUdhKi0en","title":"Animation & Expression Settings","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/animation-and-expression-settings","siteSpaceId":"sitesp_wqN6M","description":"Customize your avatar’s expressiveness with facial and body animations, emotions, and intelligent actions.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"Ib0U6R37C7GVmnADnE6t","title":"Interface Configuration","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/interface-configuration","siteSpaceId":"sitesp_wqN6M","description":"Tailor the visual and functional interface of your avatar experience to match your device, context, and brand needs.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"Bbyq4c05QHG0Lk9HZwGg","title":"Experience Settings","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/experience-settings","siteSpaceId":"sitesp_wqN6M","description":"Control idle session handling, welcome interactions, microphone behavior, and input processing timing to fine-tune your avatar experience.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"nqOkXUfzdX6wS0YC2mDI","title":"Publishing an Avatar Studio Experience","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/publishing-an-experience","siteSpaceId":"sitesp_wqN6M","description":"Learn how to publish and share your customized avatar experience for use across web, kiosks, apps, and more.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"roLZWRjRZyiRdKUtZIYo","title":"Convai Sim Experiences","pathname":"/api-docs/no-code-experiences/convai-sim-experiences","siteSpaceId":"sitesp_wqN6M","description":"Create AI-powered avatars and deploy them in interactive 3D environments—directly from your browser.","breadcrumbs":[{"label":"No Code Experiences"}]},{"id":"wKIgxvLa1ZFp5chDyXOA","title":"Creating Your AI Simulation with Convai Sim","pathname":"/api-docs/no-code-experiences/convai-sim-experiences/creating-your-ai-simulation-with-convai-sim","siteSpaceId":"sitesp_wqN6M","description":"Bring your Convai characters to life by placing them into 3D interactive environments using Convai Sim","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai Sim Experiences"}]},{"id":"lJ3ep46Kfwn6q0IGsBdC","title":"Avatar Customization","pathname":"/api-docs/no-code-experiences/convai-sim-experiences/avatar-customization","siteSpaceId":"sitesp_wqN6M","description":"Fine-tune your deployed avatar’s appearance, size, and position within your 3D simulation scene","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai Sim Experiences"}]},{"id":"HYwgAOEKclTWyqt7Arh5","title":"Tour Guide","pathname":"/api-docs/no-code-experiences/convai-sim-experiences/tour-guide","siteSpaceId":"sitesp_wqN6M","description":"Turn your AI avatar into an interactive tour guide using Convai Sim’s built-in tour planning tools","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai Sim Experiences"}]},{"id":"Fn1T9S7vnt8W0i6QMnLu","title":"Publishing a Convai Sim Experience","pathname":"/api-docs/no-code-experiences/convai-sim-experiences/publishing-an-experience","siteSpaceId":"sitesp_wqN6M","description":"Learn how to finalize and publish your AI simulation or tour guide experience created with Convai Sim","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai Sim Experiences"}]},{"id":"xT1TtWs3Nou8Xf4lE1wL","title":"Convai XR Animation Capture App","pathname":"/api-docs/no-code-experiences/convai-xr-animation-capture-app","siteSpaceId":"sitesp_wqN6M","description":"Capture animations in VR using your Meta Quest and animate AI avatars—no mocap suit required.","breadcrumbs":[{"label":"No Code Experiences"}]},{"id":"QVolyrxHNbjPVss42fT3","title":"Convai XR Animation Capture App Setup","pathname":"/api-docs/no-code-experiences/convai-xr-animation-capture-app/convai-xr-animation-capture-app-setup","siteSpaceId":"sitesp_wqN6M","description":"Learn how to install and connect the Convai XR Animation Capture App on your Meta Quest headset to start recording avatar animations in VR.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai XR Animation Capture App"}]},{"id":"AMu3Ygl07F5ShmmygPKG","title":"Creating Animations for AI Avatars","pathname":"/api-docs/no-code-experiences/convai-xr-animation-capture-app/creating-animations-for-ai-avatars","siteSpaceId":"sitesp_wqN6M","description":"Capture lifelike animations using your Meta Quest headset to bring your AI avatars to life—no mocap suit required.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai XR Animation Capture App"}]},{"id":"vZgEAxvS8fiQVnhs8mbC","title":"Adding Your Recorded Animations to AI Avatars Inside Unity","pathname":"/api-docs/no-code-experiences/convai-xr-animation-capture-app/adding-your-recorded-animations-to-ai-avatars-inside-unity","siteSpaceId":"sitesp_wqN6M","description":"Learn how to import animations recorded in VR and apply them to your AI avatars in Unity.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai XR Animation Capture App"}]},{"id":"22b9b4b526c2c8c38e0131559b94d8ae7778017a","title":"Convai Unity SDK","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk","siteSpaceId":"sitesp_wqN6M","description":"Add real-time AI characters to Unity training simulations, interactive experiences, and games — with speech, emotion, actions, and persistent memory.","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"a3d7afb80b74f02afa29c790d79751f4f29227c8","title":"Convai Unity SDK overview","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/overview","siteSpaceId":"sitesp_wqN6M","description":"Find explanations of what the Convai Unity SDK is, how its four-tier architecture is organized, and what feature modules ship with the package.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"3d552fbc704f9580bbec1cc230e2eae41818f025","title":"What is the Convai Unity SDK","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/overview/what-is-the-convai-unity-sdk","siteSpaceId":"sitesp_wqN6M","description":"Real-time conversational AI characters for Unity — voice pipeline, opt-in feature modules, supported platforms, and minimum requirements.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Convai Unity SDK overview"}]},{"id":"E0sHZRYpXvCTPJiLrAH4","title":"Convai Unity SDK architecture","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/overview/convai-unity-sdk-architecture","siteSpaceId":"sitesp_wqN6M","description":"Understand the Convai Unity SDK four-tier architecture — Runtime, Room, Agent, and Module — and the responsibilities of each tier.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Convai Unity SDK overview"}]},{"id":"052c621eeaba9b20d93167f3c9981bf9dc20372f","title":"Feature map","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/overview/feature-map","siteSpaceId":"sitesp_wqN6M","description":"Find the right Convai Unity SDK feature, module, guide, or reference page for any development goal, indexed by use case.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Convai Unity SDK overview"}]},{"id":"ae8k7JCmNIvZyl8ctZ6K","title":"Release notes","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/overview/release-notes","siteSpaceId":"sitesp_wqN6M","description":"Release notes for the Convai Unity SDK — current version highlights, previous release notes, bug fixes, and migration guidance for each release.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Convai Unity SDK overview"}]},{"id":"ijdGXp5AdxHr05KBoBHM","title":"Compatibility and requirements","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/compatibility-and-requirements","siteSpaceId":"sitesp_wqN6M","description":"Find the Unity version, render pipeline, platform, and network requirements you need before installing the Convai Unity SDK.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"d270f20a06743da76d0e46e64e17440ad758dad6","title":"Unity versions and render pipelines","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/compatibility-and-requirements/unity-versions-and-render-pipelines","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai Unity SDK environment requirements, including the minimum Unity version, required package dependencies, and render pipeline support.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Compatibility and requirements"}]},{"id":"e8f8a0a8257efa9a6ff3e80c02b6bdc1224d50fc","title":"Platform support matrix","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/compatibility-and-requirements/platform-support-matrix","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai Unity SDK platform support, including feature availability across Windows, macOS, Android, iOS, Meta Quest, and WebGL.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Compatibility and requirements"}]},{"id":"451345facd5cd16f0b40e81f6f7a06784935c82b","title":"Network and API requirements","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/compatibility-and-requirements/network-and-api-requirements","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai Unity SDK network access, including Convai and LiveKit hosts, firewall rules, authentication, and log-based connection checks.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Compatibility and requirements"}]},{"id":"1d9fa274483952ca377014dd2a4fb49c2f3e80a1","title":"Getting started","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started","siteSpaceId":"sitesp_wqN6M","description":"Step-by-step path from installing the Convai Unity SDK to a validated, working conversational AI character in your scene.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"9c9a13d2a745ff9a78da0c1790759ba17484a304","title":"Prerequisites","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/prerequisites","siteSpaceId":"sitesp_wqN6M","description":"System requirements, Unity version, required packages, and account prerequisites for the Convai Unity SDK.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"f1aef51364acf8a4bf5802a99774c033d9ee6e68","title":"Install the Convai Unity SDK","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/installation","siteSpaceId":"sitesp_wqN6M","description":"Add the Convai Unity SDK to your Unity 2023.1+ project via the Package Manager or Asset Store. Both methods install the identical package.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"nLYDmLXfx19u9jY8DiYD","title":"Configure the API key","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/configure-api-key","siteSpaceId":"sitesp_wqN6M","description":"Enter your Convai API key in the SDK settings to authenticate your project and enable character communication.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"41c4fa4e32b4314bedf2eeac4548c536e758ce3f","title":"Import and run sample scenes","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/import-and-run-sample-scenes","siteSpaceId":"sitesp_wqN6M","description":"Import the bundled sample scenes and verify the SDK is installed and connected correctly before building your own scene.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"0ovsiZNbY51a9fHPtneG","title":"Scene components reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/scene-components","siteSpaceId":"sitesp_wqN6M","description":"Learn the role of ConvaiManager, ConvaiRoomManager, ConvaiCharacter, and ConvaiPlayer, and how they depend on each other.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"KM3jUMFCMu4M0nS1MSJH","title":"Build a custom scene","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/build-a-custom-scene","siteSpaceId":"sitesp_wqN6M","description":"Add required Convai components to a new Unity scene using the Setup Required Components command and configure your first character.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"35a808a76b0d30cee351c5b850b110058a2eb840","title":"Validate your setup","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/validate-your-setup","siteSpaceId":"sitesp_wqN6M","description":"Run the scene validation tool to confirm all required components are present, connected, and configured correctly.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"2532db82ab7e792207320a0655ef32ccfd5f99e4","title":"Configure conversation input mode","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/configure-conversation-input-mode","siteSpaceId":"sitesp_wqN6M","description":"Choose between hands-free voice activation and push-to-talk, and configure the trigger key or button for your project.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"MGgUuRj5tRGxy8aDaXHd","title":"Configure character audio","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/configure-character-audio","siteSpaceId":"sitesp_wqN6M","description":"Set character voice volume, enable spatial audio, and control NPC playback through the ConvaiAudio facade for scripted mute and unmute.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"vzAH1RAH4ciuh2ypEwaO","title":"Configure microphone","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/configure-microphone","siteSpaceId":"sitesp_wqN6M","description":"Select the active microphone device and configure platform-specific permissions for Android, iOS, and WebGL builds.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"3b61dcb812f9a6f38643f1fce0883e718828e8d1","title":"Add chat UI","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/add-chat-ui","siteSpaceId":"sitesp_wqN6M","description":"Add a transcript UI component to display conversation text on screen during character interactions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"96d3c58b6fd5623574443837c77ebcb98c1071e6","title":"Add lip sync","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/add-lip-sync","siteSpaceId":"sitesp_wqN6M","description":"Connect Convai audio output to your character's facial blendshapes to synchronize mouth movement with speech.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"}]},{"id":"bWXMsjnl9w0v1XGbrvox","title":"Profiles and mappings","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/add-lip-sync/profiles-and-mappings","siteSpaceId":"sitesp_wqN6M","description":"Reference for the two ScriptableObject types — profiles and maps — that control how Convai blendshape data reaches your character's SkinnedMeshRenderer.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"},{"label":"Add lip sync"}]},{"id":"W7KKkYg5RjVc2F3b63Vz","title":"Create a lip sync profile","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/add-lip-sync/create-a-lip-sync-profile","siteSpaceId":"sitesp_wqN6M","description":"Create a ConvaiLipSyncProfile asset to define a custom transport format identifier for blendshape formats beyond the three bundled profiles.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"},{"label":"Add lip sync"}]},{"id":"dZnu5jciNDbTRscNenck","title":"Create a custom lip sync map","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/add-lip-sync/create-a-custom-blendshape-map","siteSpaceId":"sitesp_wqN6M","description":"Create a ConvaiLipSyncMapAsset to route stream blendshape channels to your character's actual SkinnedMeshRenderer blendshape names, with per-channel multiplier and clamp tuning.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Getting started"},{"label":"Add lip sync"}]},{"id":"e324eb9293dfc478fb2c227def03dca5d44cc512","title":"Core concepts","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts","siteSpaceId":"sitesp_wqN6M","description":"Find explanations for how the Convai Unity SDK works at runtime — connection management, session state, turn-taking, and event-driven scene responses.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"LV9IsLoeHhBA2EovBKod","title":"Runtime architecture","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/runtime-architecture","siteSpaceId":"sitesp_wqN6M","description":"Understand the four-layer Convai Unity SDK runtime — what each layer owns, which components are replaceable, and how RuntimeState transitions are managed.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Core concepts"}]},{"id":"TvL9WjMsqfa9XQdTFSUo","title":"Session lifecycle","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/session-lifecycle","siteSpaceId":"sitesp_wqN6M","description":"Understand how ConvaiCharacter sessions transition through states, where session IDs are stored, and how to configure reconnection and conversation-resume behavior.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Core concepts"}]},{"id":"b9e67d1d27aaccf9e9bc9b260045411047aa37c3","title":"Turn-taking modes","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/turn-taking-modes","siteSpaceId":"sitesp_wqN6M","description":"Reference for TurnTakingOptions, SmartTurnSettings, and PushToTalkPolicy — field reference for hands-free voice detection and push-to-talk modes.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Core concepts"}]},{"id":"bcd284a409f00820e1693ab998dc7a99a4fbd780","title":"Event system","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/event-system","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai event relay components — available events, payload fields, subscription patterns, and the ConvaiNotificationEventBridge service.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Core concepts"}]},{"id":"d5302389270319f4ca9bf82b6b3081d22b81bd8f","title":"Features","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features","siteSpaceId":"sitesp_wqN6M","description":"","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"8e2d39906eb40512aa9c4c6b05ffc3352eb87e51","title":"Character actions","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions","siteSpaceId":"sitesp_wqN6M","description":"Find quick-start guides, executor references, dispatcher configuration, scripting API, and usage examples for the Convai character actions system.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"}]},{"id":"mqkxc4D6OCQA9OVVDCLv","title":"How character actions work","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/how-character-actions-work","siteSpaceId":"sitesp_wqN6M","description":"Understand the Convai character actions pipeline — how the backend selects actions, how Unity resolves targets, and which components are required.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"M9Lh8OZ24Oqv9SmxMjzb","title":"Character actions quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/quick-start","siteSpaceId":"sitesp_wqN6M","description":"Add a working Move To action to your NPC using ConvaiActionConfigSource, ConvaiActionDispatcher, and TransformMoveToActionExecutor without writing any scripts.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"u3JAohXiqBNMG6zZ5m60","title":"Configure character actions","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/configuring-actions","siteSpaceId":"sitesp_wqN6M","description":"Reference for ConvaiActionConfigSource — action definitions, target objects, actionable characters, and scripted connect-time overrides.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"6RYF3LHemCYzxRfZpueZ","title":"Action executors","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/action-executors","siteSpaceId":"sitesp_wqN6M","description":"Reference for all six action executor components — look-at, event, NavMesh movement, animation trigger, and compound pickup executors.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"yKmOPjUYIRCR4eqPYD0A","title":"Write a custom action executor","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/writing-custom-executors","siteSpaceId":"sitesp_wqN6M","description":"Implement IConvaiActionExecutor on a MonoBehaviour to connect custom movement, inventory, UI, or physics behaviors to the Convai action pipeline.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"L2RNE4SlLqEb39SpjbDU","title":"Dispatcher and batch policies","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/dispatcher-and-batch-policies","siteSpaceId":"sitesp_wqN6M","description":"Configure ConvaiActionDispatcher's batch policy, failure policy, and lifecycle events, and inject action batches programmatically for testing or scripted sequences.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"RKSqmXPbQonS4iJeIfiO","title":"Attention and reference grounding","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/attention-and-reference-grounding","siteSpaceId":"sitesp_wqN6M","description":"Update NPC focus at runtime so Convai resolves vague player references such as \"pick that up\" or \"go to it\" to the correct registered scene object.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"73HufYIPX0JRnnAsGDbk","title":"Character actions scripting reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/actions-scripting-reference","siteSpaceId":"sitesp_wqN6M","description":"API reference for the Convai character actions system — dispatcher types, executor interface, config classes, invocation objects, result types, and enums.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"f7muso7lrEOfJU9hnYeK","title":"Character actions examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Progressive examples for the Convai character actions system — Inspector setup, event subscriptions, scripted batch injection, and navigation error recovery.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"LZcDaILUbaCK85OVcPJ6","title":"Troubleshoot character actions","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/debugging-and-troubleshooting","siteSpaceId":"sitesp_wqN6M","description":"Diagnose action pipeline issues using ConvaiActionDebugProbe's Inspector counters and test batch injection — with a complete symptom/cause/fix reference for common failures.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Character actions"}]},{"id":"HLRHVibG6Nqvot1DGfvc","title":"Dynamic context","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context","siteSpaceId":"sitesp_wqN6M","description":"Find all Dynamic Context guides — feed live state and events to characters from Inspector or C# and verify context-aware dialogue.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"}]},{"id":"Oyh83QIsfM02w8hOnerK","title":"How dynamic context works","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/how-dynamic-context-works","siteSpaceId":"sitesp_wqN6M","description":"Understand the states and events model, canonical context format, and how updates queue and flush before and during conversations.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"c83fd507c05d6353540d730017d6b1681c7bb60d","title":"Dynamic context quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/dynamic-context-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Add ConvaiDynamicContextCommand to an NPC, configure a SetState command, and confirm the character acknowledges live scene conditions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"o4soWlixkVqAjbqKQCzH","title":"Command component reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/command-component-reference","siteSpaceId":"sitesp_wqN6M","description":"Complete field-by-field reference for ConvaiDynamicContextCommand — all six command types, reaction modes, validation warnings, and multi-command child GameObject patterns.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"wuITWZtDYpGKPOC2GUTI","title":"Static context at connection time","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/static-context-at-connection-time","siteSpaceId":"sitesp_wqN6M","description":"Configure InitialDynamicInfoText and InitialDynamicInfoKeepInContext on ConvaiCharacter to send fixed scenario facts once at the start of each conversation.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"jLDVtNvrQQtepjrSEeAv","title":"Sync behavior and timing","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/sync-behavior-and-timing","siteSpaceId":"sitesp_wqN6M","description":"Understand how the SDK transmits Replace, Append, and Reset messages for each Dynamic Context operation, including queueing and Apply() behavior.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"Pwb170m39yjzkfAghzLG","title":"Dynamic context scripting API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/dynamic-context-scripting-api","siteSpaceId":"sitesp_wqN6M","description":"API reference for IConvaiDynamicContext — all seven method signatures, default parameters, pre-conversation queueing behavior, and Apply() caveats.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"3UWNhGolZFLe1BduX0bt","title":"Dynamic context usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/dynamic-context-usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Four Dynamic Context examples covering a safety drill, an onboarding walkthrough, a guided tour with timeline events, and a multi-state emergency transition.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"7ij66qcsYVpiLPUZFGvh","title":"Troubleshoot dynamic context","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/troubleshoot-dynamic-context","siteSpaceId":"sitesp_wqN6M","description":"Diagnose Dynamic Context issues with a five-step checklist, a symptom table, a character-not-responding decision tree, and the full Console log reference.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"pzyAnwgRmeSToQBXFJYu","title":"Emotion","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion","siteSpaceId":"sitesp_wqN6M","description":"Find guides for adding emotionally responsive facial animation to Convai characters — from quick setup to scripting API and troubleshooting.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"}]},{"id":"VKDUIdxDSqYZKjcrf1FW","title":"How the emotion system works","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/how-the-emotion-system-works","siteSpaceId":"sitesp_wqN6M","description":"Understand the emotion pipeline — how Convai sends emotion signals, how the SDK resolves and smooths them, and which components to place and where.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Emotion"}]},{"id":"PyOgkztYoFXIQ0l3uTfN","title":"Emotion quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/quick-start","siteSpaceId":"sitesp_wqN6M","description":"Build a working emotion pipeline on a Convai NPC — attach the Emotion Controller, assign the bundled sample profile, and verify expressions in Play Mode.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Emotion"}]},{"id":"4kPK7vkbjtuDa9qfc75O","title":"Emotion profile","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/emotion-profile","siteSpaceId":"sitesp_wqN6M","description":"Reference for ConvaiEmotionProfile, including smoothing speed, micro-burst settings, neutral alternation, and output binding configuration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Emotion"}]},{"id":"mqwNGzveKocvvR9sOhts","title":"Emotion output bindings","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/output-bindings","siteSpaceId":"sitesp_wqN6M","description":"Reference for EmotionSlotBinding and the two binding types — field ranges, weight calculation, isMouthShape routing, and the pre-built slot factory.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Emotion"}]},{"id":"FOiJ57aQtQ6qN404z3rE","title":"Emotion taxonomy","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/emotion-taxonomy","siteSpaceId":"sitesp_wqN6M","description":"Reference for EmotionTaxonomyAsset, including the built-in Plutchik set, server alias resolution, and custom taxonomy authoring.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Emotion"}]},{"id":"OM0Nzbb46ldsnhmYvu6a","title":"Emotion scripting API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/scripting-api","siteSpaceId":"sitesp_wqN6M","description":"Reference for the emotion scripting surface — ConvaiEmotionController, EmotionReading, override and lock methods, C# events, and IEmotionStateSource.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Emotion"}]},{"id":"5Bo6oC1qF0jfrzgrtD56","title":"Emotion examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Six complete scenarios covering hazard overrides, locked expressions, distress branching, analytics logging, no-code UI wiring, and Editor authoring.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Emotion"}]},{"id":"N6zov1sJHXMKI44gRL56","title":"Troubleshoot emotion","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/troubleshooting-and-diagnostics","siteSpaceId":"sitesp_wqN6M","description":"Fix common emotion pipeline failures in the Convai Unity SDK — from missing output and silent neutral fallback to LipSync conflicts and locked expressions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Emotion"}]},{"id":"Yg6rMK5Mnh9zStBOwoca","title":"Long-term memory","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory","siteSpaceId":"sitesp_wqN6M","description":"Find all long-term memory guides — enable memory on characters, manage user identity, use the memory API, and access the scripting reference.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"}]},{"id":"vmFTDbOMYC0TTWNIC7Nw","title":"How long-term memory works","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/how-long-term-memory-works","siteSpaceId":"sitesp_wqN6M","description":"Understand the long-term memory session lifecycle, how memory is scoped by user and character, and how facts are extracted, deduplicated, and injected.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"jhH0HpubiAmSHgHB5acq","title":"Long-term memory quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/quick-start","siteSpaceId":"sitesp_wqN6M","description":"Enable Long-Term Memory for a Convai character and verify cross-session recall in the Unity Editor in three steps.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"lG0GNEfMD5jvoHOjCCax","title":"Configure memory for a character","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/configure-memory-for-a-character","siteSpaceId":"sitesp_wqN6M","description":"Toggle Long-Term Memory on or off per character via the Convai dashboard or the CharacterService scripting API, and understand the global scope implications.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"GQgbZSFMOcRCBLwo1vqX","title":"End-user identity","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/end-user-identity","siteSpaceId":"sitesp_wqN6M","description":"Understand how the SDK identifies users for long-term memory scoping and how to implement a custom authentication-backed identity provider.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"09sxltM2pYC5cl7evTls","title":"Manage end-user records","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/end-user-management","siteSpaceId":"sitesp_wqN6M","description":"Browse and manage end-user records from the Convai Configuration Window or via the EndUsersService scripting API — covers the editor tool, all four methods, and pagination.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"3GS4gHtc1oXVknBcIakW","title":"Memory management API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/memory-management-api","siteSpaceId":"sitesp_wqN6M","description":"Use ConvaiRestClient.Memory to list, add, retrieve, and delete memory records for a user–character pair — includes setup, all five methods, response types, and error handling.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"rNXGHpGQBdg9YBcHJ3hR","title":"Long-term memory scripting reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/long-term-memory-scripting-reference","siteSpaceId":"sitesp_wqN6M","description":"Complete API reference for ConvaiRestClient.Memory and ConvaiRestClient.EndUsers — all method signatures, parameters, return types, identity interfaces, and data models.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"k71sbCPyoe2SjjSKXPAv","title":"Long-term memory usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Four complete long-term memory patterns for Unity — zero-config persistence, authenticated identity, memory seeding, and memory reset.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"ljp5Ye0OhKTKJVYgfM50","title":"Troubleshoot long-term memory","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/troubleshooting-and-diagnostics","siteSpaceId":"sitesp_wqN6M","description":"Diagnose why long-term memory isn't persisting, verify end-user identity stability across sessions, and resolve Memory Management API HTTP errors.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"vN4t84KHA949ufTTNaVd","title":"Narrative design","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design","siteSpaceId":"sitesp_wqN6M","description":"Find guides for setting up, configuring, scripting, and troubleshooting the Narrative Design system in the Convai Unity SDK.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"}]},{"id":"xq1fYsxzZSvmTVHhAuzP","title":"How narrative design works","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/how-narrative-design-works","siteSpaceId":"sitesp_wqN6M","description":"Understand the Narrative Design pipeline — how sections, triggers, and template keys connect at runtime to advance a story graph.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"bKLk8evl0rKJoAJVLBDc","title":"Narrative design quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/quick-start","siteSpaceId":"sitesp_wqN6M","description":"Add a Narrative Design Manager and a collision trigger to a Convai character and confirm a section change in Play Mode — no code required.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"kZqgIdGNMRTi9mAsEy9T","title":"Configure the narrative design manager","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/setting-up-the-narrative-design-manager","siteSpaceId":"sitesp_wqN6M","description":"Add and configure ConvaiNarrativeDesignManager on a character, sync sections from Convai, and wire per-section Unity Events in the Inspector.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"TN48vuadtxlKi07jDDXf","title":"Configure narrative design triggers","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/setting-up-narrative-design-triggers","siteSpaceId":"sitesp_wqN6M","description":"Configure ConvaiNarrativeDesignTrigger to advance the narrative graph using collision, proximity, time-based, or manual activation modes.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"GGAj3nmRIj3JmjXWgn9u","title":"Configure narrative template keys","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/template-keys-dynamic-narrative-variables","siteSpaceId":"sitesp_wqN6M","description":"Set narrative template keys so a Convai character can reference runtime values — player name, scenario parameters, or session state — in its objectives.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"ShMEkDz5iXv32f3SAnZ6","title":"Narrative design scripting reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/scripting-narrative-design","siteSpaceId":"sitesp_wqN6M","description":"Reference for IConvaiNarrativeDesign, including section events, trigger invocation, speech injection, template keys, and async fetch methods.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"P5OgJto88LWqfhKMP4eD","title":"Narrative design usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Four worked Narrative Design examples from a single-trigger welcome sequence to an adaptive multi-section scenario with dynamic feedback.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"aqms53VNdK2b217bHljp","title":"Troubleshoot narrative design","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/troubleshooting-and-diagnostics","siteSpaceId":"sitesp_wqN6M","description":"Resolve trigger status failures, Inspector misconfigurations, fetch errors, and queue timeouts using built-in validation and diagnostic tools.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"a62866eb2b9826eb452e50eb8875192eb2464f3c","title":"Scene metadata","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata","siteSpaceId":"sitesp_wqN6M","description":"Find guides, component reference, and examples for Scene Metadata — the feature that gives Convai characters awareness of objects in your Unity scene.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"}]},{"id":"KwecfeB1C1fimjgaLENp","title":"How scene metadata works","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/how-scene-metadata-works","siteSpaceId":"sitesp_wqN6M","description":"Understand the registration and delivery flow for scene object metadata, and learn when to use Scene Metadata versus Dynamic Context.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"b21526ee9b2c1ed58e407fc454da6b3bd057905a","title":"Scene metadata quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/quick-start","siteSpaceId":"sitesp_wqN6M","description":"Add ConvaiObjectMetadata to scene objects and configure ConvaiSceneMetadataCollector so a Convai character receives object awareness at session start.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"cb67fd355a439e2cf54faaa44dd018f205299a93","title":"Scene metadata component reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/component-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for ConvaiObjectMetadata and ConvaiSceneMetadataCollector, including Inspector fields, lifecycle events, validation rules, and dependency injection behavior.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"aa4f25375b3961f18138e4a75710532316656e63","title":"Scene metadata scripting API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/scripting-api-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for ConvaiMetadataRegistry and ConvaiSceneMetadataCollector, including static events, manual trigger patterns, and debug utilities.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"c47675608acf86e70caf6c8b756d2be389006162","title":"Scene metadata usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Complete Scene Metadata setups for medical training, phase-based industrial drills, museum guides, and runtime object inclusion and exclusion.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"66fddc4b0f911e97d589403a45f3ae569eb83b5d","title":"Troubleshoot scene metadata","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/troubleshooting-and-diagnostics","siteSpaceId":"sitesp_wqN6M","description":"Fix scene metadata problems including empty payloads, missing collection logs, dependency injection failures, and AI characters ignoring scene objects.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"c776d88f01e63c32eee310e37d0ed10bc12eb355","title":"Vision","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision","siteSpaceId":"sitesp_wqN6M","description":"Find guides for adding real-time scene vision to Convai characters in Unity, including frame sources, publish policies, scripting, and troubleshooting.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"}]},{"id":"l8e8VHFqAfizSNNTRxLW","title":"How vision works","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/how-vision-works","siteSpaceId":"sitesp_wqN6M","description":"Understand the Vision pipeline architecture, including frame sources, the publish coordinator, the WebRTC track to Convai, and the startup sequence.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"XSaPw0kFVyXD2NbMU5k2","title":"Vision quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/quick-start","siteSpaceId":"sitesp_wqN6M","description":"Add Vision to an existing Convai scene so a character can see and respond to live camera input, using the SDK's automatic component setup.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"ae0edd0be3d5b82330547283ee17259071673848","title":"Vision frame sources","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/frame-sources","siteSpaceId":"sitesp_wqN6M","description":"Reference for CameraVisionFrameSource, WebcamVisionFrameSource, and QuestVisionFrameSource, including Inspector fields, capture presets, and platform support.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"8e81321c92ed2b28e658ae5686d3cac89efa9213","title":"Publish policies","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/publishing-and-policies","siteSpaceId":"sitesp_wqN6M","description":"Reference for Vision publish policies, including FPS and bitrate budgets, runtime control methods, auto-publish behavior, and WebGL-specific behavior.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"eP36iBni1AamThCZdCLM","title":"Vision debug preview","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/debug-preview","siteSpaceId":"sitesp_wqN6M","description":"Reference for VisionDebugPreview, including Inspector fields, statistics overlay output, and script access for verifying the live feed in the Editor.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"a605ab5aa55eec202ad6748667a5629e34141045","title":"Custom frame sources","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/custom-frame-sources","siteSpaceId":"sitesp_wqN6M","description":"Implement IVisionFrameSource to publish a custom video pipeline to Convai, including the Y-flip requirement, lifecycle state pattern, and auto-discovery rules.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"35fce4a7255d7ee06c08b0cc4b37b598f89f6068","title":"Vision scripting API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/scripting-api","siteSpaceId":"sitesp_wqN6M","description":"Reference for ConvaiVisionPublisher and the frame source interfaces, including properties, methods, domain events, and state monitoring patterns.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"A2LuvcFg2YlW1OiZkeEV","title":"Vision usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Find code patterns for common Vision setups, including safety training, webcam selection, overhead cameras, look-at activation, and WebGL deployment.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"nydFtT4kGp2HzURUi5L5","title":"Troubleshoot vision","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/troubleshooting-and-diagnostics","siteSpaceId":"sitesp_wqN6M","description":"Fix Vision publishing failures, blank feeds, permission errors, and platform-specific issues in Unity using a structured checklist and decision tree.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Features"},{"label":"Vision"}]},{"id":"1d9a66db894bd027727ec456c7ba69d7696ce43c","title":"Utilities","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities","siteSpaceId":"sitesp_wqN6M","description":"Opt-in presentation modules that enhance character animation, eye tracking, and head movement — running entirely in Unity with no data sent to Convai.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"e7963b2cdbdecc024efd724f61855cea3fab1ea9","title":"Dialogue Animation","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation","siteSpaceId":"sitesp_wqN6M","description":"Drive body and head gesture animation from dialogue state and emotion using a pooled clip library and an AnimatorOverrideController — no per-clip animator states required.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"}]},{"id":"PUogHoj0NzoSUeYvrPHG","title":"How Dialogue Animation works","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/how-dialogue-animation-works","siteSpaceId":"sitesp_wqN6M","description":"Understand how Dialogue Animation selects clips, drives the four-layer animator stack, and uses emotion and dialogue state to animate AI characters.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Dialogue Animation"}]},{"id":"d426f4256a6e1f6125be8f4b95380e63040b0ad8","title":"Dialogue Animation quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/quick-start","siteSpaceId":"sitesp_wqN6M","description":"Add ConvaiDialogueAnimationController to a character, assign a library and runtime config, and verify gesture animation in Play Mode.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Dialogue Animation"}]},{"id":"qPHprAmwjoclwLCbma19","title":"Animation libraries and profiles","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/animation-libraries-and-profiles","siteSpaceId":"sitesp_wqN6M","description":"Complete field reference for all Dialogue Animation ScriptableObject assets — library, clip entries, runtime config, and bundled profiles.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Dialogue Animation"}]},{"id":"rexsr9WEf5LaEqGfromC","title":"Animator Controller requirements","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/animator-controller-requirements","siteSpaceId":"sitesp_wqN6M","description":"Dialogue Animation Animator Controller contract — required layer structure, state names, placeholder clip names, and DialogueAnimatorContract fields.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Dialogue Animation"}]},{"id":"b8VTVWXZAZp2TSqTLyKK","title":"Build a compatible Animator Controller","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/animator-controller-setup","siteSpaceId":"sitesp_wqN6M","description":"Build a compatible four-layer Animator Controller from scratch so the Dialogue Animation module can inject and swap gesture clips at runtime.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Dialogue Animation"}]},{"id":"e7ea454fb7376765b1f7a8b97e873070ac4737e1","title":"Dialogue Animation usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Four progressive examples — from Inspector-only setup to runtime library swapping — covering training, medical, corporate, and adaptive assessment scenarios.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Dialogue Animation"}]},{"id":"9a94177eabc282ee3f3c5ea48a63fc768dca0453","title":"Dialogue Animation scripting API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/scripting-api","siteSpaceId":"sitesp_wqN6M","description":"Runtime scripting reference for ConvaiDialogueAnimationController — swap libraries and configs at runtime, and read current layer weights and clip selection state.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Dialogue Animation"}]},{"id":"53c2015ebf2f2d7e04074279408d7cbacde002e8","title":"Dialogue Animation troubleshooting","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/troubleshooting","siteSpaceId":"sitesp_wqN6M","description":"Symptom-driven fixes for silent talk layers, missing animations, clip snapping, layer index errors, and speech energy issues in the Dialogue Animation module.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Dialogue Animation"}]},{"id":"64f87fbb4fb6aa685a57fa969e6b5253c7ee2246","title":"Gaze and Attention","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention","siteSpaceId":"sitesp_wqN6M","description":"Two-system pipeline for natural eye and head behavior — Attention selects focus targets, Gaze drives procedural eye tracking, head rotation, saccades, and blinks.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"}]},{"id":"zUCenpeFJGFhW3yhHOQV","title":"How Gaze and Attention works","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/how-gaze-and-attention-works","siteSpaceId":"sitesp_wqN6M","description":"Understand the two-layer pipeline where Attention selects focus targets and Gaze drives procedural eye tracking, head rotation, and saccades.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Gaze and Attention"}]},{"id":"8db0a7c73598ac534a4c40ffac06ec94256588a3","title":"Gaze and Attention quick start","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/quick-start","siteSpaceId":"sitesp_wqN6M","description":"Add ConvaiAttentionController, ConvaiEyeGazeActuator, and ConvaiHeadLookActuator to a character, assign profiles, and verify eye and head tracking in Play Mode.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Gaze and Attention"}]},{"id":"bdf689d789a4f88bf1d26ce6d354d98074cfd771","title":"Attention and gaze profiles","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/profiles-and-tuning","siteSpaceId":"sitesp_wqN6M","description":"Complete field reference for all four gaze profile ScriptableObjects — attention timing, gaze coordination, eye behavior, and head rotation.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Gaze and Attention"}]},{"id":"4485b09fb5be00f7295b696c5de8687d4a80c779","title":"Gaze and Attention usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Four progressive examples of Gaze & Attention configuration — from basic Inspector setup to custom IFocusTargetProvider implementations and attention profile tuning.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Gaze and Attention"}]},{"id":"0f74068e38a6f78390e41d0506de247f8d68516e","title":"Gaze and Attention scripting API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/scripting-api","siteSpaceId":"sitesp_wqN6M","description":"Runtime scripting reference for ConvaiAttentionController, AttentionReading, IFocusTargetProvider, ConvaiGazeCoordinator, and GazeIntent.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Gaze and Attention"}]},{"id":"b50c3bd12a4412920ecbcc86ebf1d36dec758689","title":"Gaze and Attention troubleshooting","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/troubleshooting","siteSpaceId":"sitesp_wqN6M","description":"Fixes for the 13 most common Gaze & Attention issues — static eyes, frozen head, eyelid clipping, attention not targeting, and focus provider conflicts.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Utilities"},{"label":"Gaze and Attention"}]},{"id":"26837dafaf3d20063e1664f52a690823bbbb0eb7","title":"UI and Presentation","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation","siteSpaceId":"sitesp_wqN6M","description":"Optional, scene-level UI for displaying transcripts, surfacing notifications, and giving users a runtime settings panel — add only what your project needs.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"efc9aca742d268965e004a82e3c4e738db24a1a7","title":"Transcript UI","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/transcript-ui","siteSpaceId":"sitesp_wqN6M","description":"Display character and player transcripts using the built-in chat prefab, ITranscriptListener callbacks, or a custom ITranscriptUI implementation.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"UI and Presentation"}]},{"id":"351d64ae28927aa533926b237ec3ddf6860763c6","title":"Transcript history and queries","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/transcript-ui/transcript-history-and-queries","siteSpaceId":"sitesp_wqN6M","description":"Query the conversation turn timeline from code — read committed turns, detect interruptions, and build post-session exports or live analytics.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"UI and Presentation"},{"label":"Transcript UI"}]},{"id":"04dba1e30bd200179a770ba5dffcaab5b5eadf16","title":"Chat and subtitle modes","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/transcript-ui/chat-and-subtitle-modes","siteSpaceId":"sitesp_wqN6M","description":"Configure Chat mode's scrollable message bubbles or Subtitle mode's auto-hiding overlay, switch between them at runtime, and add per-response feedback buttons to chat.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"UI and Presentation"},{"label":"Transcript UI"}]},{"id":"fa6f53862719c13f17357086ad27f2c08beeefa3","title":"Notification system","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/notification-system","siteSpaceId":"sitesp_wqN6M","description":"Add toast-style alerts that automatically display session error notifications and let you trigger custom in-scene alerts from code using ScriptableObject notification assets.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"UI and Presentation"}]},{"id":"rRfhodnKJWoOgCXobKwX","title":"Notification system reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/notification-system/notification-system-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for SONotification, SONotificationGroup, UINotificationController, and SONotificationErrorMap — fields, methods, and configuration options.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"UI and Presentation"},{"label":"Notification system"}]},{"id":"1e28d73ef0dad9569b5d54c8f9f0b70586425f5a","title":"Settings panel","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/settings-panel","siteSpaceId":"sitesp_wqN6M","description":"Add a runtime settings panel so users can adjust microphone, transcript mode, and notification preferences, or access the same settings programmatically.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"UI and Presentation"}]},{"id":"iiqODFfGzsLeWIN6mmNq","title":"Runtime settings API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/settings-panel/runtime-settings-api","siteSpaceId":"sitesp_wqN6M","description":"Reference for IConvaiRuntimeSettingsService — read current settings, apply patches, react to changes, and reset to defaults from code.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"UI and Presentation"},{"label":"Settings panel"}]},{"id":"271853384cbbd26c8a6dd213f1d25c8a1dcae34a","title":"Customizing UI components","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/customizing-ui-components","siteSpaceId":"sitesp_wqN6M","description":"Restyle or replace the built-in transcript, notification, and settings UI using character visibility filters or prefab swapping.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"UI and Presentation"}]},{"id":"cd1efd3a5ca8009cafe359f0b008bc9d6038de38","title":"Scripting reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for the Convai Unity SDK C# scripting APIs — events, transcripts, audio control, and async operation patterns.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"13ed97201ea2961909236d907e7a691b7b7def81","title":"Session events","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/session-events","siteSpaceId":"sitesp_wqN6M","description":"Reference for session events — connection state, errors, idle warnings, and participant changes — via relay component or the `ConvaiEvents` C# hub.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Scripting reference"}]},{"id":"3fa7a83ca1955b2d681906cc6ffdc44f9683ef41","title":"Character events","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/character-events","siteSpaceId":"sitesp_wqN6M","description":"Reference for character events — speech, emotion, transcripts, turn lifecycle, and actions — via relay component or the `ConvaiEvents` C# hub.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Scripting reference"}]},{"id":"e501926159d08f9eb11113c38bcb4aee32ea2253","title":"Transcript API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/transcript-api","siteSpaceId":"sitesp_wqN6M","description":"Pull-based API reference for ConvaiTranscripts — query, filter, and subscribe to the live in-memory transcript timeline from C# scripts.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Scripting reference"}]},{"id":"zSQGrBgxcfPV6Be5qFA6","title":"Character and Player API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/character-and-player-api","siteSpaceId":"sitesp_wqN6M","description":"Reference for ConvaiCharacter and ConvaiPlayer, including properties, methods, and events for session control, speech, audio, and attention.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Scripting reference"}]},{"id":"bc1b761d6432e6496add7c93a083259799218063","title":"ConvaiManager API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/convaimanager-api","siteSpaceId":"sitesp_wqN6M","description":"Scripting reference for ConvaiManager — the SDK entry point for connection control, facade access, conversation ownership, and service discovery.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Scripting reference"}]},{"id":"1873379028012da716187c46997839e09a10b6ad","title":"Audio API","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/audio-api","siteSpaceId":"sitesp_wqN6M","description":"Scripting reference for ConvaiAudio — microphone muting, per-character audio control, audio playback unlock, and listening state management.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Scripting reference"}]},{"id":"88530803851e054def9b3a199945d96762d4ac8c","title":"Operation and stream types","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/operation-and-stream-types","siteSpaceId":"sitesp_wqN6M","description":"Type reference for IConvaiOperation<T>, IConvaiStream<T>, ConvaiError, and Unit — the async primitives used across all Convai SDK scripting APIs.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Scripting reference"}]},{"id":"1c63f5b931ba9aeb0d22176097b938c510fb5891","title":"Async patterns","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/async-patterns","siteSpaceId":"sitesp_wqN6M","description":"Consume IConvaiOperation<T> and IConvaiStream<T> using async/await, coroutines, chaining, progress tracking, cancellation, and streams.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Scripting reference"}]},{"id":"d375c5c4e58f4a666f3cb8c940558eb222674e75","title":"Platform guides","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides","siteSpaceId":"sitesp_wqN6M","description":"Deploy the Convai Unity SDK on any supported platform — covers what requires extra configuration on WebGL, iOS, Android, and XR headsets before shipping.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"f635f366dd1077c203af8bdee8521341b6e36cf5","title":"Windows, macOS, and Linux","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/windows-macos-and-linux","siteSpaceId":"sitesp_wqN6M","description":"Windows, macOS, and Linux builds require no extra SDK configuration — all features including Vision, spatial audio, and screen share work after standard setup.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Platform guides"}]},{"id":"7b2c74ff6faeac7d9557447799d0496b11e50783","title":"WebGL","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/webgl","siteSpaceId":"sitesp_wqN6M","description":"Configure and validate the Convai Unity SDK for WebGL — covers HTTPS requirements, browser audio gesture handling, Vision canvas capture, and the known lip-sync drift defect.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Platform guides"}]},{"id":"32708cb5ab33fa2d1d0f91e747cc06da20220bc1","title":"iOS and Android","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/ios-and-android","siteSpaceId":"sitesp_wqN6M","description":"Declare microphone and camera permissions for iOS and Android builds — omitting them causes crashes on iOS and silent failures on Android.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Platform guides"}]},{"id":"86442e40afdd1c7fd12eb8dc8331a0cc75827347","title":"XR headsets","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/xr-headsets","siteSpaceId":"sitesp_wqN6M","description":"Find guides for deploying the Convai Unity SDK on XR headsets, including Meta Quest Vision passthrough setup and custom XR frame source implementation.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Platform guides"}]},{"id":"iRseCYB4vBfleWvWqnEO","title":"Meta Quest Vision setup","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/meta-quest-vision","siteSpaceId":"sitesp_wqN6M","description":"Configure QuestVisionFrameSource to stream the Meta Quest passthrough camera to a Convai character on Quest 3 and 3S builds.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Platform guides"}]},{"id":"50715c11049002775f940f15ab236a3bc207395c","title":"Customize and extend the SDK","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics","siteSpaceId":"sitesp_wqN6M","description":"Replace SDK providers, extend the runtime with custom modules, and diagnose latency using built-in telemetry — for deployments where the defaults are not enough.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"RSZXpj40gmNFoKyKxdOV","title":"Credentials, identity, and storage","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/custom-providers","siteSpaceId":"sitesp_wqN6M","description":"Replace the SDK's default credential, identity, and persistence providers with custom implementations suited to your deployment environment.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Customize and extend the SDK"}]},{"id":"31f40f584b5fb6b136f239a3d28d2ec74eb938e7","title":"Custom credential provider","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/custom-providers/custom-credential-provider","siteSpaceId":"sitesp_wqN6M","description":"Override the SDK's default credential source to supply API keys from environment variables, a secrets vault, or any runtime-resolved credential store.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Customize and extend the SDK"},{"label":"Credentials, identity, and storage"}]},{"id":"ab23b641f90fca90f9440603f9ec5293143b86e4","title":"Custom identity provider","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/custom-providers/custom-identity-provider","siteSpaceId":"sitesp_wqN6M","description":"Implement a custom end-user identity provider to tie Convai's memory and MAU tracking to your own auth system, learner records, or kiosk login flow.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Customize and extend the SDK"},{"label":"Credentials, identity, and storage"}]},{"id":"ed2429f37bbe856909dff42ad46c8c9e20800e6c","title":"Custom persistence provider","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/custom-providers/custom-persistence-provider","siteSpaceId":"sitesp_wqN6M","description":"Replace PlayerPrefs session storage with a cloud backend, encrypted file store, or in-memory implementation by implementing IKeyValueStore or IPersistenceProvider.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Customize and extend the SDK"},{"label":"Credentials, identity, and storage"}]},{"id":"a3f7030703670bbb62edbb00ba2ab32fd0f7c82a","title":"Personal access token","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/custom-providers/personal-access-token","siteSpaceId":"sitesp_wqN6M","description":"Generate short-lived tokens from your backend so the real API key never ships inside your Unity build, eliminating credential exposure from client applications.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Customize and extend the SDK"},{"label":"Credentials, identity, and storage"}]},{"id":"5c7f9583038d0635f6ec4cab5bab3847c7c9e158","title":"Runtime module system","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/extending-the-sdk","siteSpaceId":"sitesp_wqN6M","description":"Understand the Convai runtime module system, including when to use custom modules, the module lifecycle states, and which SDK extension points are safe to use.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Customize and extend the SDK"}]},{"id":"18ZqcEJr2DgHzICW0BuO","title":"Implement a custom module","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/implement-a-custom-module","siteSpaceId":"sitesp_wqN6M","description":"Implement `IConvaiModule` to add custom runtime behavior that starts with the SDK, accesses runtime services, and reacts to domain events.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Customize and extend the SDK"}]},{"id":"5679714dc01a4244d0d11caee67e8c32da80d5c3","title":"Logging, metrics, and retry policy","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/performance-and-optimization","siteSpaceId":"sitesp_wqN6M","description":"Configure SDK log verbosity per subsystem, route logs to custom sinks, read RTVI pipeline latency metrics, and tune the connection retry policy.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Customize and extend the SDK"}]},{"id":"d5350da7bd6402bba0c66f41fe2dadd0116fb2da","title":"Troubleshooting","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/troubleshooting","siteSpaceId":"sitesp_wqN6M","description":"Find troubleshooting guides for installation errors, API issues, audio failures, and debug tools in the Convai Unity SDK.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"}]},{"id":"21f9d826ef71da7f70e7312d5dca5de0bcbfa2f2","title":"Installation and package issues","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/troubleshooting/installation-and-package-issues","siteSpaceId":"sitesp_wqN6M","description":"Fix Convai Unity SDK import failures, missing dependencies, assembly errors, and bootstrapper startup warnings with step-by-step remediation.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Troubleshooting"}]},{"id":"bf2d3c0310bc8496a310e6c0331136dd3cf2399d","title":"Connection and API issues","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/troubleshooting/connection-and-api-issues","siteSpaceId":"sitesp_wqN6M","description":"Interpret Convai session error codes, read ConvaiRoomManager diagnostics, and resolve authentication, transport, and rate-limit failures.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Troubleshooting"}]},{"id":"607bf5ace60fb89b0eb5ed9df13d6a2718028170","title":"Audio and microphone issues","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/troubleshooting/audio-and-microphone-issues","siteSpaceId":"sitesp_wqN6M","description":"Fix microphone input failures and character voice playback issues on all Convai Unity SDK platforms, including Android, iOS, and WebGL.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Troubleshooting"}]},{"id":"33d51f5b9dd5b0b2ef292fc1b0dd113786346c3e","title":"Debug tools reference","pathname":"/api-docs/plugins-and-integrations/convai-unity-sdk/troubleshooting/debug-tools-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai SDK debug tools, including logging configuration, ConvaiActionDebugProbe, session diagnostics, and client latency metrics.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unity SDK"},{"label":"Troubleshooting"}]},{"id":"vAerDmlPwB1EoS3RixrT","title":"Convai Unreal Engine plugin","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin","siteSpaceId":"sitesp_wqN6M","description":"Find installation guides, feature documentation, Blueprint reference, and troubleshooting pages for the Convai Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"YZJCXRAzNrUUtxgSDzG8","title":"Convai Unreal Engine plugin overview","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/overview","siteSpaceId":"sitesp_wqN6M","description":"Find explanations of what the Convai Unreal Engine plugin is, how its four modules and runtime components are structured, and what changed in each release.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"10h7Zgk3jx1Y3dSXWFS4","title":"What is the Convai Unreal Engine plugin","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/overview/what-is-the-convai-unreal-engine-plugin","siteSpaceId":"sitesp_wqN6M","description":"Understand what the Convai Unreal Engine plugin adds to a project: Blueprint components, a real-time voice pipeline, and opt-in feature add-ons.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Convai Unreal Engine plugin overview"}]},{"id":"avDtqiuctK8vS16Q8s7w","title":"Plugin architecture","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/overview/plugin-architecture","siteSpaceId":"sitesp_wqN6M","description":"Understand the Convai Unreal Engine plugin's four modules, runtime components, session proxies, and subsystem routing model.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Convai Unreal Engine plugin overview"}]},{"id":"HcWIzLmISVXTnaagYQMj","title":"Feature map","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/overview/feature-map","siteSpaceId":"sitesp_wqN6M","description":"Find the right Convai Unreal Engine plugin feature, guide, or reference page for any development goal, indexed by use case.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Convai Unreal Engine plugin overview"}]},{"id":"Z2cuD4gzRs1MiHPN778m","title":"Release notes","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/overview/release-notes","siteSpaceId":"sitesp_wqN6M","description":"Version history and notable changes for the Convai Unreal Engine plugin, covering public 4.x beta releases and the full 3.x history.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Convai Unreal Engine plugin overview"}]},{"id":"3oblPsurIGf7eseuvZPm","title":"Compatibility and requirements","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/compatibility-and-requirements","siteSpaceId":"sitesp_wqN6M","description":"Find the Unreal Engine version support, platform targets, character rig compatibility, and network requirements for the Convai Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"CA2WtOTx4l3bXAkUWO4l","title":"Unreal Engine versions","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/compatibility-and-requirements/unreal-engine-versions","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai Unreal Engine plugin version support, including module availability per UE version, load phases, and per-version setup notes.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Compatibility and requirements"}]},{"id":"aLS9wREFDwmaOgsKQZ3Z","title":"Unreal Engine platform support matrix","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/compatibility-and-requirements/unreal-engine-platform-support-matrix","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai Unreal Engine plugin platform support, including build targets, engine plugin dependencies, and Android microphone access.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Compatibility and requirements"}]},{"id":"9aF3O66XI2Xgu5NV461L","title":"Character rig support","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/compatibility-and-requirements/character-rig-support","siteSpaceId":"sitesp_wqN6M","description":"Which character rigs work with the Convai Unreal Engine plugin, what setup each requires, and where to find the rig-specific setup guides.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Compatibility and requirements"}]},{"id":"6QAApU1I0cvIZPD3M50b","title":"Network and API requirements","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/compatibility-and-requirements/network-and-api-requirements","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai Unreal Engine plugin network access, including Convai and LiveKit hosts, firewall rules, authentication, and session log checks.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Compatibility and requirements"}]},{"id":"5oPvRJZZEVuIVMYZLYh8","title":"Getting started","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started","siteSpaceId":"sitesp_wqN6M","description":"Install the Convai Unreal Engine plugin, configure your API key, and place your first talking character — follow the core path in order for the fastest result.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"rEn97nz5rOXoeSAteVQt","title":"Prerequisites","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/prerequisites","siteSpaceId":"sitesp_wqN6M","description":"Verify engine version, account, platform, and network requirements before installing the Convai Unreal Engine plugin into your project.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"zf9D2ktrnLMIujjWxizK","title":"Install the Convai plugin","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/install-the-convai-plugin","siteSpaceId":"sitesp_wqN6M","description":"Install the Convai Unreal Engine plugin from Fab or GitHub Releases, enable it in your project, and restart the Unreal Editor.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"yK6s42eZv16JXJzJnF9d","title":"Configure your API key","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/configure-your-api-key","siteSpaceId":"sitesp_wqN6M","description":"Sign in through the Convai editor window to store your API key and allow the plugin to send authenticated requests to Convai.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"TAMFvBX6DiCF3cUBeYtP","title":"Scene components reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/scene-components-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for the Convai Chatbot, Player, Object, and Face Sync components — their fields, runtime properties, and how they connect in a scene.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"62jSGyEcDL1LUmbU2yXD","title":"Add your first Convai character","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/add-your-first-convai-character","siteSpaceId":"sitesp_wqN6M","description":"Build a talking Convai character in Unreal Engine by adding Chatbot and Player components, setting a Character ID, and testing in Play mode.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"XbtaAPxghTKgeXTDOIn3","title":"Set up a MetaHuman character","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/set-up-a-metahuman-character","siteSpaceId":"sitesp_wqN6M","description":"Add Convai Chatbot and Face Sync components to a MetaHuman, assign the Convai animation classes, and configure lip sync for MetaHuman blendshapes.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"GjMgGIpOc6IFNfXiyJTr","title":"Set up a Reallusion (CC) character","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/set-up-a-reallusion-cc-character","siteSpaceId":"sitesp_wqN6M","description":"Export a Reallusion CC5 avatar, import it into Unreal Engine, configure Convai components, and add the Reallusion animation Blueprint for lip sync.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"9KUQ9XKjAMU6OaZfGxfJ","title":"Configure the microphone","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/configure-the-microphone","siteSpaceId":"sitesp_wqN6M","description":"Select a capture device, adjust volume, and handle Android microphone permissions so player speech reaches the Convai character correctly.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"hFMUaDotYrGAMPyQ8J6G","title":"Configure character audio","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/configure-character-audio","siteSpaceId":"sitesp_wqN6M","description":"Adjust character speech playback volume, enable spatial audio attenuation, and configure the interrupt fade duration on the Convai Chatbot component.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"wO1MGAXD0InYM2apk7cV","title":"Configure conversation input","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/configure-conversation-input","siteSpaceId":"sitesp_wqN6M","description":"Switch between push-to-talk and hands-free voice capture modes, tune VAD settings, and send text messages to a character without a microphone.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"HucPjSqJx8pLUO4dNPgQ","title":"Add the chat UI","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/add-the-chat-ui","siteSpaceId":"sitesp_wqN6M","description":"Add the built-in chat overlay to your scene, switch between interface styles, attach the 3D in-world widget to a character, or replace it with a custom widget.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"g8UGNK2Dicyeh9I9zZ6x","title":"Validate your setup","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/validate-your-setup","siteSpaceId":"sitesp_wqN6M","description":"Run through a checklist of plugin, component, audio, and API key checks to confirm your Convai Unreal Engine setup is working before adding features.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Getting started"}]},{"id":"uL5SILtUmeFvx3EidUSt","title":"Core concepts","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/core-concepts","siteSpaceId":"sitesp_wqN6M","description":"Understand the component model of the Convai Unreal Engine plugin, how each component is owned, and how they work together at runtime.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"36aeWZiRCKCEuHABFcbC","title":"Runtime architecture","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/core-concepts/runtime-architecture","siteSpaceId":"sitesp_wqN6M","description":"Understand the roles, ownership, and relationships between the Convai Chatbot, Player, Object, Face Sync components, and the Convai Subsystem.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Core concepts"}]},{"id":"eoZKwdeLf9Z6eibYUijz","title":"Session lifecycle","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/core-concepts/session-lifecycle","siteSpaceId":"sitesp_wqN6M","description":"Understand how Convai sessions start and stop, what connection states mean, and which Blueprint nodes monitor the global connection.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Core concepts"}]},{"id":"zDu9dPOf91gdHtGGWLZw","title":"Conversation flow","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/core-concepts/conversation-flow","siteSpaceId":"sitesp_wqN6M","description":"Understand voice input, playback state, transcription events, action queue execution, narrative triggers, and interruption handling.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Core concepts"}]},{"id":"qLn90PJJUY78IXQ8NIrm","title":"Event system","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/core-concepts/event-system","siteSpaceId":"sitesp_wqN6M","description":"Reference for core runtime Blueprint delegates on Convai components and the subsystem, organized by category with timing details.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Core concepts"}]},{"id":"AGnvNMLpxOxMFMMgKjWH","title":"Features","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features","siteSpaceId":"sitesp_wqN6M","description":"Find guides for all Convai Unreal Engine plugin features — lip sync, character actions, narrative design, long-term memory, vision, and more.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"NjVHOB3MELicvSSurEPd","title":"Character actions","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions","siteSpaceId":"sitesp_wqN6M","description":"Find guides, references, and examples for the Convai Unreal Engine character actions system — from quick start to Blueprint API reference.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"J36C3clan8yhcgYGTrUP","title":"How character actions work","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/how-character-actions-work","siteSpaceId":"sitesp_wqN6M","description":"Understand how Convai character actions move from session setup to queued Blueprint handler execution and completion reporting.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"B8YtLNagBWrxMPwLZWxf","title":"Character actions quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/character-actions-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Enable character actions, set up pawn movement and navigation, register scene objects, and verify default movement actions in Play mode.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"qIWRz61DFTTZdII0U2XA","title":"Configuring actions","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/configuring-actions","siteSpaceId":"sitesp_wqN6M","description":"Define the action set, enable character actions, and register environment objects and characters so Convai can reference them.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"t5DSC6B706zfqaDzJzHT","title":"Built-in action handlers","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/built-in-action-handlers","siteSpaceId":"sitesp_wqN6M","description":"Reference handler patterns for the four default Convai character actions, including parameters, completion rules, and Blueprint flow.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"Q9OxeZ4EchM8ABZ4pIOW","title":"Building custom action handlers","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/building-custom-action-handlers","siteSpaceId":"sitesp_wqN6M","description":"Add a custom action template, scaffold a Blueprint handler with the editor utility, and report completion so the queue advances.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"y5n6zO4nhEgGfJnXzGk4","title":"Parameterized actions","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/parameterized-actions","siteSpaceId":"sitesp_wqN6M","description":"Declare typed action parameters and read resolved values in Blueprint handlers for text, references, choices, and animations.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"H0jjq9t6AueURwGJUpI3","title":"Attention and reference grounding","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/attention-and-reference-grounding","siteSpaceId":"sitesp_wqN6M","description":"Understand how the Convai Unreal Engine plugin resolves pronoun references and attention targets so characters understand which object a player means.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"lEX58Owo3bAVjCGO0ezK","title":"Actions Blueprint reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/actions-blueprint-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for the Blueprint structs, enums, events, and queue functions that power Convai character actions in Unreal Engine.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"KjK5RrpmmborH095i0oC","title":"Character actions examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/character-actions-examples","siteSpaceId":"sitesp_wqN6M","description":"End-to-end action recipes for navigating to a registered object, following a character, and using parameterized actions in the Convai Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"EeeGTar0veyeNxdDlpfy","title":"Troubleshoot character actions","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/troubleshoot-character-actions","siteSpaceId":"sitesp_wqN6M","description":"Fix character actions that do not fire, movement failures, reference issues, and queue stalls in the Convai Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Character actions"}]},{"id":"VtreGBSkV3v9EqIKSNQH","title":"Dynamic context","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context","siteSpaceId":"sitesp_wqN6M","description":"Find guides for pushing live state and events to Convai characters through Blueprint nodes and verifying context-aware responses in your level.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"HGItmryh4PHfi7WIN9UG","title":"How dynamic context works","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/how-dynamic-context-works","siteSpaceId":"sitesp_wqN6M","description":"Understand how dynamic context tracks runtime state, batches events, chooses response behavior, and assembles payloads for Convai.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"uLheo1rAJDdMVNFZj7ZL","title":"Dynamic context quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/dynamic-context-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Push a state property and a context event to a connected Convai character in Blueprint and verify the update reaches the context pipeline.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"cf6u0S8978Cad9J2oR2W","title":"Static context at connection time","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/static-context-at-connection-time","siteSpaceId":"sitesp_wqN6M","description":"Understand which verified connection data is fixed at session start and how live context updates use separate runtime messages.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"R2QEV8nZly3I7Sd1ew7G","title":"Sync behavior and timing","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/sync-behavior-and-timing","siteSpaceId":"sitesp_wqN6M","description":"Understand how dynamic context payloads flush after debounce, how offline queueing works, and when immediate flushes bypass batching.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"KeXDDGyIx8dXyg80DYwi","title":"Dynamic context Blueprint reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/dynamic-context-blueprint-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference the Blueprint controls that send runtime state, event, reset, and timing updates from an Unreal character to Convai during a live session.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"m4rqRxdMbmG8hRxTM7Q2","title":"Dynamic context usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/dynamic-context-usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Blueprint recipes for health tracking, context events, zone transitions, state removal, and dynamic context resets in training simulations.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"G3KIxXwGh1BmpM1vFq9B","title":"Troubleshoot dynamic context","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/troubleshoot-dynamic-context","siteSpaceId":"sitesp_wqN6M","description":"Fix dynamic context updates that arrive too late, trigger unexpected responses, or appear ignored after a flush or reconnect.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Dynamic context"}]},{"id":"dXQYIyvmX3Z6hN65zfqt","title":"Emotion","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion","siteSpaceId":"sitesp_wqN6M","description":"Find guides for animating AI character expressions in sync with conversation — from quick Blueprint setup to full reference and troubleshooting.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"rhrJSUDsxJtlVoC5RBxt","title":"How the emotion system works","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion/how-the-emotion-system-works","siteSpaceId":"sitesp_wqN6M","description":"Understand how Convai delivers emotion state as per-emotion scores, how server scale maps to score values, and what the offset and lock controls do.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Emotion"}]},{"id":"DdElnRB3Nhl5aVIsBAlu","title":"Emotion quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion/emotion-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Wire a Convai character's emotion scores to morph targets on its Skeletal Mesh so facial expressions update automatically during conversation.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Emotion"}]},{"id":"49dLglYXwdqtxoT5OviR","title":"Emotion Blueprint reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion/emotion-blueprint-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for emotion properties, functions, events, and enums on the Convai Chatbot component — including types, defaults, and parameter details.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Emotion"}]},{"id":"b9ztYs8XT0CsQtGnPjeC","title":"Emotion examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion/emotion-examples","siteSpaceId":"sitesp_wqN6M","description":"Six scenarios covering forced expressions, cutscene locks, score-driven VFX, offset tuning, neutral reset, and Animation Blueprint blend poses.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Emotion"}]},{"id":"tBJKhFf61Mm1mKyjfr69","title":"Troubleshoot emotion","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion/troubleshoot-emotion","siteSpaceId":"sitesp_wqN6M","description":"Fix common emotion problems — expressions not appearing, state locked unintentionally, morph target mismatches, and offset changes with no visible effect.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Emotion"}]},{"id":"DMTej4CYSOHRGmpxRVHi","title":"Long-term memory","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory","siteSpaceId":"sitesp_wqN6M","description":"Find guides for enabling long-term memory, identifying players, resuming sessions, and troubleshooting recall in Unreal Engine.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"Bc8OjnguS3F6H3oW7CJi","title":"How long-term memory works","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/how-long-term-memory-works","siteSpaceId":"sitesp_wqN6M","description":"Understand how Unreal long-term memory uses character settings, player identity, and connect-time parameters to recall prior interactions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"qCWhjxGBv6qEO4Rkl0Ph","title":"Long-term memory quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/long-term-memory-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Set up long-term memory for an Unreal character, assign a stable player identity, and confirm recall across Play In Editor sessions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"F5FsqjGFVKgO3SLqnTYj","title":"Configure memory for a character","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/configure-memory-for-a-character","siteSpaceId":"sitesp_wqN6M","description":"Enable long-term memory for an Unreal character, verify the dashboard setting, and reset the local conversation link when needed.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"qcfr1PrPOizoztRNloCY","title":"End-user identity","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/end-user-identity","siteSpaceId":"sitesp_wqN6M","description":"Configure a stable Unreal player identity so each Convai character loads memory for the correct user before a session starts.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"xIpC6mQGKNJNnXc3TQWn","title":"Speaker ID management","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/speaker-id-management","siteSpaceId":"sitesp_wqN6M","description":"Create, list, and delete Speaker ID records from Unreal Blueprints so each player keeps a stable memory identity across sessions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"mwNxFe292Uo2iGpZiLAp","title":"LTM Blueprint reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/ltm-blueprint-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for Unreal long-term memory Blueprint nodes, Speaker ID data, component properties, and session fields used during startup.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"tyOWumFxG4lNGELvqAOH","title":"Long-term memory usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/long-term-memory-usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Apply Unreal long-term memory patterns for returning learners, shared devices, first sessions, and fresh-start reset flows.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"rHYMia3zb5OAQe1S06cT","title":"Troubleshoot long-term memory","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/troubleshoot-long-term-memory","siteSpaceId":"sitesp_wqN6M","description":"Diagnose disabled memory, unstable player identity, speaker identity failures, and shared-device recall issues for Unreal characters.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Long-term memory"}]},{"id":"adQWw1CiOcNdZRsmpBeB","title":"Narrative design","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design","siteSpaceId":"sitesp_wqN6M","description":"Drive character story graphs from Unreal Engine by invoking narrative triggers, injecting template keys, and handling section change events.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"5UHlXoAxUOLuWB0TElfn","title":"How narrative design works","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/how-narrative-design-works","siteSpaceId":"sitesp_wqN6M","description":"Understand the narrative design story graph, the runtime pipeline that advances sections, and how triggers and template keys shape character behavior.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"9naQ9wL6wpdxFfJuDkfH","title":"Narrative design quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/narrative-design-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Invoke a named narrative trigger from Blueprint and confirm a section change by printing the new section ID to the screen.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"Khv7SfpK36SvMkUjcjoW","title":"Narrative triggers","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/narrative-triggers","siteSpaceId":"sitesp_wqN6M","description":"Invoke named narrative triggers or dynamic context messages on a Convai chatbot component to advance the story graph and handle the section change event.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"WlLowI3BqDYQNs4lfQM4","title":"Template keys","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/template-keys","siteSpaceId":"sitesp_wqN6M","description":"Populate the Narrative Template Keys map on a chatbot component so section objectives reference live gameplay values through placeholder substitution.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"9dcZ9ULB2iFBCZcNEu6i","title":"Fetching narrative data","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/fetching-narrative-data","siteSpaceId":"sitesp_wqN6M","description":"Query a character's narrative sections and triggers at runtime using Convai Fetch Narrative Sections and Convai Fetch Narrative Triggers.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"7L5OLPdjT22ynoNiU7gD","title":"Narrative design Blueprint reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/narrative-design-blueprint-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for Blueprint functions, events, properties, and narrative structs on UConvaiChatbotComponent in the narrative design API.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"Y84uFwti8p03e69iFquR","title":"Narrative design usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/narrative-design-usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Blueprint recipes for linear scene progression, dynamic context events, template key injection, and trigger-name validation in narrative design.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"uGDfbeU2MRjQlg7HV1GY","title":"Troubleshoot narrative design","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/troubleshoot-narrative-design","siteSpaceId":"sitesp_wqN6M","description":"Diagnose and fix narrative design issues including missing section events, wrong transitions, ignored template keys, and fetch failures.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Narrative design"}]},{"id":"vbGxc89Y9wflNJFl3EW4","title":"Scene metadata","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata","siteSpaceId":"sitesp_wqN6M","description":"Find guides, reference pages, and examples for giving Convai characters awareness of objects in your Unreal Engine level.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"ct7GZc4pJVR5cE2Nx02x","title":"How scene metadata works","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/how-scene-metadata-works","siteSpaceId":"sitesp_wqN6M","description":"Understand how scene object metadata reaches Convai at connect time, through live updates, and via tracked property changes.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"wMA4p35fTyTTaaCVW5Iq","title":"Scene metadata quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/scene-metadata-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Tag a world actor with the Convai Object Component, assign its name and description, and confirm a Convai character can reference it in conversation.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"D7AS0tddjNnZ6oTWwtlC","title":"Scene metadata component reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/scene-metadata-component-reference","siteSpaceId":"sitesp_wqN6M","description":"Full property, function, and event reference for the Convai Object Component, including object identity, tracked properties, proximity state, and gaze events.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"0IWX9Z34917gjSpzDUY8","title":"Managing the environment at runtime","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/managing-the-environment-at-runtime","siteSpaceId":"sitesp_wqN6M","description":"Reference for chatbot environment methods that add, remove, and update objects and characters during an active gameplay session.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"4fgSEKKPL6fKko07SAoV","title":"Scene metadata usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/scene-metadata-usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Complete scene metadata setups for training simulations, industrial drills, military bases, and runtime environment updates in Unreal Engine.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"vDCzfp22bc2x6dppbHkD","title":"Troubleshoot scene metadata","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/troubleshoot-scene-metadata","siteSpaceId":"sitesp_wqN6M","description":"Diagnose and fix common problems with scene objects not being recognized, stale environment data, and tracked properties failing to update.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Scene metadata"}]},{"id":"5TGq7ASz4xWw1Dhn8qy3","title":"Vision","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision","siteSpaceId":"sitesp_wqN6M","description":"Give Convai characters scene vision in Unreal Engine so they can respond to what is visible in the level during conversation.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"RNP7gLRl8F8AfVtFryly","title":"How vision works","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/how-vision-works","siteSpaceId":"sitesp_wqN6M","description":"Understand how Unreal vision components are discovered, started, throttled, and used to send scene frames during a Convai session.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Vision"}]},{"id":"wz9pG5dZWcD3ZCNsrxON","title":"Vision quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/vision-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Add scene vision to a Convai character Blueprint and verify that captured frames affect the character's response in Play In Editor.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Vision"}]},{"id":"1zs9olIHfeqwXONkvpVT","title":"Vision frame sources","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/vision-frame-sources","siteSpaceId":"sitesp_wqN6M","description":"Configure the built-in Environment Webcam frame source, create its render target, and select the active vision component at runtime.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Vision"}]},{"id":"LiRqiZh8lqH02mdwtjJn","title":"Custom vision components","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/custom-vision-components","siteSpaceId":"sitesp_wqN6M","description":"Implement a C++ frame source component for custom Unreal image pipelines that need to provide scene frames to a Convai chatbot.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Vision"}]},{"id":"8W9Lmm4Mqew1zEfyrsje","title":"Vision Blueprint reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/vision-blueprint-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for Blueprint-accessible vision enums, Environment Webcam properties, webcam nodes, events, and Chatbot integration functions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Vision"}]},{"id":"jR121aXRSrtaarm2aad5","title":"Vision usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/vision-usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Apply common Blueprint patterns for Unreal vision, including auto-start capture, manual control, FPS tuning, and source switching.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Vision"}]},{"id":"P6Q0IslTrewgSnb1grWo","title":"Troubleshoot vision","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/troubleshoot-vision","siteSpaceId":"sitesp_wqN6M","description":"Fix common Unreal vision problems including missing visual context, failed starts, blank render targets, and invalid source registration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Vision"}]},{"id":"LWOprxC8MMYzTxzOV4pu","title":"Gaze attention","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention","siteSpaceId":"sitesp_wqN6M","description":"Find guides and reference for the gaze attention system, which lets players direct a Convai character's focus by looking at world objects.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"tzRboWm1eecuLuhSsAmt","title":"How gaze attention works","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention/how-gaze-attention-works","siteSpaceId":"sitesp_wqN6M","description":"Understand the gaze trace pipeline, attention promotion timers, component-scoped targeting, highlight rendering, and the attention-source locking rule.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Gaze attention"}]},{"id":"8wms0FA96K4gf9BhKcAt","title":"Gaze attention quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention/gaze-attention-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Enable gaze attention on the Convai Player Component and verify that a character responds when the player looks at a tagged world object.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Gaze attention"}]},{"id":"Y1a2EJCnlVUVqiuNeKuC","title":"Gaze attention reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention/gaze-attention-reference","siteSpaceId":"sitesp_wqN6M","description":"Complete property, event, method, and class reference for the gaze attention system, including all defaults and version-specific behavior.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Gaze attention"}]},{"id":"bPs8fXX51q1pu4P47Ypq","title":"Gaze attention usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention/gaze-attention-usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Blueprint recipes for gaze events, custom highlight visuals, component-scoped targeting, manual attention locking, and building a custom cursor widget.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Gaze attention"}]},{"id":"vhd0cZEs5OqbzqVwljKh","title":"Troubleshoot gaze attention","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention/troubleshoot-gaze-attention","siteSpaceId":"sitesp_wqN6M","description":"Diagnose and fix gaze attention issues — objects not highlighting, attention never promoting, cursor not appearing, and component-scoped gaze not matching.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Gaze attention"}]},{"id":"MUqoUJUdEwZL84AyCxoU","title":"Lip sync","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync","siteSpaceId":"sitesp_wqN6M","description":"Animate a character's face in sync with Convai speech using precomputed blendshape data and the Convai Face Sync AnimGraph node.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"}]},{"id":"lOSnElQlgFyVpLhYq4IH","title":"How lip sync works","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/how-lip-sync-works","siteSpaceId":"sitesp_wqN6M","description":"Understand how Convai delivers facial animation data alongside audio, the supported lip-sync modes, and how the AnimGraph node applies it.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Lip sync"}]},{"id":"rHjIjF6OivZ5wW5NeV4L","title":"Lip sync quick start","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/lip-sync-quick-start","siteSpaceId":"sitesp_wqN6M","description":"Add the Convai Face Sync component and Convai animation classes to a MetaHuman character and hear lip-synced speech in Play In Editor.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Lip sync"}]},{"id":"lsZCsc7Ypsg79ozXB0fr","title":"Face Sync component reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/face-sync-component-reference","siteSpaceId":"sitesp_wqN6M","description":"Property reference for the Convai Face Sync component and all six lip-sync mode values with rig compatibility guidance for MetaHuman, CC4, CC5, and custom rigs.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Lip sync"}]},{"id":"ShOSJ5HqZshB5R4ioXln","title":"Face Sync AnimGraph node reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/face-sync-animgraph-node-reference","siteSpaceId":"sitesp_wqN6M","description":"Reference for all properties of the Convai Face Sync AnimGraph node — apply mode, face alphas, smoothing, starvation blending, and blendshape mapping.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Lip sync"}]},{"id":"ZuNnaqm1ldGai22u0MPD","title":"Record and replay lip sync","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/record-and-replay-lip-sync","siteSpaceId":"sitesp_wqN6M","description":"Capture a live lip-sync sequence during a Convai conversation and replay it later in cutscenes, cached responses, or offline previews without re-streaming.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Lip sync"}]},{"id":"n5M1eapXfiR0tOlawpbm","title":"Lip sync usage examples","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/lip-sync-usage-examples","siteSpaceId":"sitesp_wqN6M","description":"Configure lip sync for common scenarios: Add vs Override blending, tuning smoothing, mixing with body animation, and remapping blendshapes to a custom rig.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Lip sync"}]},{"id":"OrGmrNEAMlVbk4NSYCL3","title":"Troubleshoot lip sync","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/troubleshoot-lip-sync","siteSpaceId":"sitesp_wqN6M","description":"Diagnose and fix lip sync issues in the Convai Unreal Engine plugin — no mouth movement, frame starvation, wrong blendshape map, and rig mismatch.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Features"},{"label":"Lip sync"}]},{"id":"2OW0dOqVCY8obz8ud9x2","title":"Advanced topics","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/advanced-topics","siteSpaceId":"sitesp_wqN6M","description":"Find production authentication, security, and integration guides for the Convai Unreal Engine plugin beyond the core setup path.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"gCewWm6yF4QDWKLcH5rn","title":"Use personal access tokens","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/advanced-topics/personal-access-token","siteSpaceId":"sitesp_wqN6M","description":"Generate a short-lived token on your backend and pass it to the Unreal plugin so production builds do not ship a real API key.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Advanced topics"}]},{"id":"YJZ9npCu6kBrPvgWNPcz","title":"Blueprint reference","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference","siteSpaceId":"sitesp_wqN6M","description":"Find verified Blueprint component, utility, audio, and shared data references for the Convai Unreal Engine plugin runtime workflow.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"0VDwXeI6AzMabnJyekSQ","title":"Convai Chatbot Component","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/convai-chatbot-component","siteSpaceId":"sitesp_wqN6M","description":"Reference for the AI character component — every Blueprint-visible property, function, and event exposed by the Convai Chatbot Component.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Blueprint reference"}]},{"id":"qPgHSr8R4sd5rplgr5u4","title":"Convai Player Component","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/convai-player-component","siteSpaceId":"sitesp_wqN6M","description":"Reference for the player conversation component — every Blueprint-visible property, function, and event exposed by the Convai Player Component.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Blueprint reference"}]},{"id":"DkhdClgCqO2tHqAGtVFi","title":"Convai Object Component","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/convai-object-component","siteSpaceId":"sitesp_wqN6M","description":"Reference for the object tagging component — every Blueprint-visible property, function, and event exposed by the Convai Object Component.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Blueprint reference"}]},{"id":"6BNXkLsA5NhP4cLsdovV","title":"Microphone and audio capture","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/microphone-and-audio-capture","siteSpaceId":"sitesp_wqN6M","description":"Reference for microphone device enumeration, selection, and volume on the Convai Player Component, the audio capture component, and Android permissions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Blueprint reference"}]},{"id":"SZgrn5ikGQTQteegD5Hr","title":"Convai utility functions","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/convai-utility-functions","siteSpaceId":"sitesp_wqN6M","description":"Find cross-cutting Blueprint helper nodes for look-at queries, component lookup, audio utilities, settings, diagnostics, and command-line flags.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Blueprint reference"}]},{"id":"gyOnm5SFuaK37xai5UZx","title":"Data types and enums","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/data-types-and-enums","siteSpaceId":"sitesp_wqN6M","description":"Reference for Blueprint-exposed structs and enums in the Convai Unreal Engine plugin, including object entries, action types, emotions, and connection states.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Blueprint reference"}]},{"id":"dfPAsmC4gI49gaBgUn6h","title":"The Convai editor window","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/editor-window","siteSpaceId":"sitesp_wqN6M","description":"Open the Convai editor window, understand its main sections, and find account, update, support, and log export workflows.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"4loiR0UybR6vGeWAAZWs","title":"Sign in and manage your account","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/editor-window/sign-in-and-manage-your-account","siteSpaceId":"sitesp_wqN6M","description":"Connect your Convai account through the editor window, sign out to switch accounts, and review plan, quota, and usage details inside Unreal Editor.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"The Convai editor window"}]},{"id":"VFZLJxq2P7nVfIJDWiVU","title":"Browse samples and content","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/editor-window/browse-samples-and-content","siteSpaceId":"sitesp_wqN6M","description":"Check the current Samples area in the Convai Editor window and understand how sample projects will be surfaced in future updates.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"The Convai editor window"}]},{"id":"r1y21YG8W9pILVbbKTX7","title":"Export diagnostic logs","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/editor-window/export-diagnostic-logs","siteSpaceId":"sitesp_wqN6M","description":"Export Convai diagnostics from Unreal Editor and attach the generated log package to a Convai Developer Forum support request.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"The Convai editor window"}]},{"id":"RoMMd8QlITNHZ4C7DbG4","title":"Troubleshooting","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting","siteSpaceId":"sitesp_wqN6M","description":"Find fixes for installation, API key, audio, lip sync, and connection problems in the Convai Unreal Engine plugin, plus log export and diagnostic guidance.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"}]},{"id":"hAqxIeXv5sv60SseRsHZ","title":"Installation and plugin issues","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting/installation-and-plugin-issues","siteSpaceId":"sitesp_wqN6M","description":"Fix plugin-not-found errors, module load failures, Blueprint-only project limitations, and Android packaging errors in the Convai Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Troubleshooting"}]},{"id":"vjpN4AOUQxqogF37p0pC","title":"Connection and API key issues","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting/connection-and-api-key-issues","siteSpaceId":"sitesp_wqN6M","description":"Fix authentication failures, missing API key errors, session timeout, and firewall problems in the Convai Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Troubleshooting"}]},{"id":"dLpMCOKrWYMkRx1BXob8","title":"Audio and microphone issues","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting/audio-and-microphone-issues","siteSpaceId":"sitesp_wqN6M","description":"Fix audio capture failures, wrong microphone device, Android permission errors, and audio playback problems in the Convai Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Troubleshooting"}]},{"id":"I0ObYlUKKH4xrA1bmEGA","title":"Lip sync and animation issues","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting/lip-sync-and-animation-issues","siteSpaceId":"sitesp_wqN6M","description":"Fix missing mouth movement, wrong blendshape curves, frame starvation, and packaged build animation failures in the Convai Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Troubleshooting"}]},{"id":"pZV8WWWMb3ZTg1Gyagbc","title":"Diagnostics and log export","pathname":"/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting/diagnostics-and-log-export","siteSpaceId":"sitesp_wqN6M","description":"Reference for Convai log categories, verbosity levels, configuration defaults, Blueprint diagnostic nodes, and log file export for the Unreal Engine plugin.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Unreal Engine plugin"},{"label":"Troubleshooting"}]},{"id":"Ufgfxad0qAjE4Lb97w0c","title":"Web Plugins","pathname":"/api-docs/plugins-and-integrations/web-plugins","siteSpaceId":"sitesp_wqN6M","description":"Integrate Convai AI with your website. Follow our Web plugin documentation for seamless setup.","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"bg0KbmaczTTieGzr3iU7","title":"Convai Web SDK","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk","siteSpaceId":"sitesp_wqN6M","description":"Explore the Convai Web SDK — Fast, low-latency, voice-first AI character interaction for the browser","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"}]},{"id":"QARm23s6FuiamQWrYu2J","title":"React","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react","siteSpaceId":"sitesp_wqN6M","icon":"react","description":"Learn how to install, configure, and integrate the Convai Web SDK (@convai/web-sdk) to bring low-latency conversational AI, voice interaction, and optional video into your web applications.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"GQ2YU7yGQqbMXjFYj2Pd","title":"useConvaiClient Hook","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/useconvaiclient-hook","siteSpaceId":"sitesp_wqN6M","description":"useConvaiClient manages all Convai connection logic, audio/video pipelines, and message flows.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"VVA0bI3FaMJjHAXp7Ce4","title":"ConvaiWidget","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/convaiwidget","siteSpaceId":"sitesp_wqN6M","description":"ConvaiWidget is an all-in-one interface for voice, text, video, and screen sharing.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"BsYjAXPL7ouWHomF7333","title":"Real-time Lipsync","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/real-time-lipsync","siteSpaceId":"sitesp_wqN6M","description":"Integrate real-time facial animation in your React applications.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"pnBdTq1ZprIrW02nBrkE","title":"Custom UI & Advanced Usage","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/custom-ui-and-advanced-usage","siteSpaceId":"sitesp_wqN6M","description":"Build your own UI while using Convai’s audio pipelines and message system.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"69dkBZG1to4kDHLmJYeP","title":"Audio Visualizer (Optional)","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/audio-visualizer-optional","siteSpaceId":"sitesp_wqN6M","description":"You can create real-time visualizations from the bot’s audio using Web Audio + the WebRTC room.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"mskfPzpQqd1cn7uDGJGm","title":"Vanilla Typescript","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript","siteSpaceId":"sitesp_wqN6M","icon":"js","description":"Complete guide for using @convai/web-sdk with vanilla TypeScript applications (no React or framework required). Use the ConvaiClient class directly, wire up events, and build your own UI.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"hoQvlTU9Xdyx4zRfPNAo","title":"ConvaiClient (Core API)","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/convaiclient-core-api","siteSpaceId":"sitesp_wqN6M","description":"ConvaiClient is the main class for managing Convai in vanilla TypeScript.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"MXjYUMCl5Jq7hr0wdRLg","title":"Events & Message Handling","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/events-and-message-handling","siteSpaceId":"sitesp_wqN6M","description":"ConvaiClient provides a strongly typed event system. Use client.on(event, handler) to subscribe.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"skNItzZaOkTbepJMsmUF","title":"Real-time Lipsync","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/real-time-lipsync","siteSpaceId":"sitesp_wqN6M","description":"Integrate real-time facial animation in vanilla JavaScript/TypeScript applications.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"XcLdxS5Xkd0vnutCN9a5","title":"Building a Custom UI (TypeScript)","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/building-a-custom-ui-typescript","siteSpaceId":"sitesp_wqN6M","description":"This page shows how to wire up a simple DOM-based chat UI using vanilla TypeScript.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"Ao6AKyD9m1Dhix32kGFx","title":"Best Practices & Type Definitions","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/best-practices-and-type-definitions","siteSpaceId":"sitesp_wqN6M","description":"A summary of recommended patterns and the main TypeScript types for quick reference.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"zryHbFTZ6NP3reRcdOj3","title":"Mappings Reference","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/mappings-reference","siteSpaceId":"sitesp_wqN6M","description":"","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"TAz5xoB9ykfQi3tP2LRX","title":"Actions","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/actions","siteSpaceId":"sitesp_wqN6M","icon":"person-running","description":"Actions let the character decide what to do in your scene. You declare the available affordances at connect time; the character decides when and what to do based on the conversation.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"brSoliFuVGCEifdBfwhR","title":"Emotions","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/emotions","siteSpaceId":"sitesp_wqN6M","icon":"face-smile-plus","description":"Enable emotion detection to receive the character's emotional state during a conversation.Enable emotion detection to receive the character's emotional state alongside each response.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"sFpT256I5RmNHTSEwNSV","title":"Dynamic Context","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/dynamic-context","siteSpaceId":"sitesp_wqN6M","icon":"connectdevelop","description":"Inject real-time context into the character's understanding — game state, user preferences, scene changes — without reconnecting.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"WyjROD93MGIykd6sRYNa","title":"Long Term Memory","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/long-term-memory","siteSpaceId":"sitesp_wqN6M","icon":"brain","description":"Convai can remember things about your users across sessions. When you provide an `endUserId`, the character automatically builds and recalls long-term memories.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"L89pCRRDKa1Dt7pFtuFn","title":"Auth Tokens","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/auth-tokens","siteSpaceId":"sitesp_wqN6M","icon":"fingerprint","description":"For production apps, use a short-lived auth token instead of embedding your Convai API key in client-side code. The API key stays on your server; the client receives a token that expires after 1 hour.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"QOOOI31YjB7Tih8ktqsx","title":"Error Handling","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/error-handling","siteSpaceId":"sitesp_wqN6M","icon":"cloud-xmark","description":"The SDK surfaces errors through four channels. Each has a different scope and payload — knowing which one to use for a given scenario is the key to reliable apps.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"MiNDmyWrgUbQ50cb2Qvq","title":"WebSocket Transport Layer","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/websocket-transport-layer","siteSpaceId":"sitesp_wqN6M","icon":"webhook","description":"The SDK defaults to WebRTC for real-time voice conversations. In environments where WebRTC is unavailable, you can opt in to a WebSocket-based transport instead.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"i6rUAK1CuEI8BPWN76eT","title":"Event Reference","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/event-reference","siteSpaceId":"sitesp_wqN6M","icon":"arrow-up-small-big","description":"Subscribe with `client.on(event, callback)`. The return value is an unsubscribe function.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"n9v4tFFO4pRJ6O541ZRa","title":"PlayCanvas Plugin","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin","siteSpaceId":"sitesp_wqN6M","description":"PlayCanvas template for Convai integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"}]},{"id":"QgtCmdlCRV50DHC1iEtC","title":"Adding External Script","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/adding-external-script","siteSpaceId":"sitesp_wqN6M","description":"Adding External Script - PlayCanvas Plugin Guide for Convai integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"Fk34BucslC2wJcI0XFFW","title":"First Person View","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/first-person-view","siteSpaceId":"sitesp_wqN6M","description":"First Person View - PlayCanvas Plugin Guide for Convai integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"QpyJz01hLP2wvlL4upOz","title":"Adding characters to scene","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/adding-characters-to-scene","siteSpaceId":"sitesp_wqN6M","description":"Adding Characters to Scene - PlayCanvas Plugin Guide for Convai integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"cE5ZZSi57PuSNgUL4Xpu","title":"Character Animations","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/character-animations","siteSpaceId":"sitesp_wqN6M","description":"Add character animations in PlayCanvas with Convai. Enhance your web projects with interactive AI.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"cxJUrJf4fgW8f1YGTzYv","title":"Convai Integration","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/convai-integration","siteSpaceId":"sitesp_wqN6M","description":"Convai Integration - PlayCanvas Plugin Guide for seamless integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"Ep4ijjZn9V9P2RKuPGF0","title":"Chat Overlay","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/chat-overlay","siteSpaceId":"sitesp_wqN6M","description":"Chat Overlay - PlayCanvas Plugin Guide for Convai integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"Kc2Von4OI1yH7YuY9OIh","title":"Narrative Design Guide","pathname":"/api-docs/plugins-and-integrations/web-plugins/narrative-design-guide","siteSpaceId":"sitesp_wqN6M","description":"Narrative Design - Narrative based NPCs with convai on web.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"}]},{"id":"D6uP7zLp4pbknqrkdSsa","title":"Narrative Design Triggers","pathname":"/api-docs/plugins-and-integrations/web-plugins/narrative-design-guide/narrative-design-triggers","siteSpaceId":"sitesp_wqN6M","description":"","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Narrative Design Guide"}]},{"id":"Qkt6MfVHhjdzZdrdSr9X","title":"Narrative Design Keys","pathname":"/api-docs/plugins-and-integrations/web-plugins/narrative-design-guide/narrative-design-keys","siteSpaceId":"sitesp_wqN6M","description":"This guide shows how to dynamically pass variables to Narrative Design section and triggers","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Narrative Design Guide"}]},{"id":"xSv83YrJNeitsFOaOxgm","title":"GLB/FBX animations for Convai","pathname":"/api-docs/plugins-and-integrations/web-plugins/glb-fbx-animations-for-convai","siteSpaceId":"sitesp_wqN6M","description":"Learn to integrate GLB and FBX animations into Convai's web plugin for dynamic character actions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"}]},{"id":"WOPfcFOkzv1ZgtzuZceM","title":"Modding Framework","pathname":"/api-docs/plugins-and-integrations/modding-framework","siteSpaceId":"sitesp_wqN6M","description":"Convai introduces a Modding Framework, enabling easy integration of AI-driven NPCs into games across engines like Unreal, Unity, and more.","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"GH02p9AZOVvnhbp1Sb4E","title":"Modding Cyberpunk 2077","pathname":"/api-docs/plugins-and-integrations/modding-framework/modding-cyberpunk-2077","siteSpaceId":"sitesp_wqN6M","description":"This guide will show you how to make Mods that add Convai's features to Cyberpunk 2077","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Modding Framework"}]},{"id":"UISZJcESbADnVXDFGLET","title":"Other Integrations","pathname":"/api-docs/plugins-and-integrations/other-integrations","siteSpaceId":"sitesp_wqN6M","description":"","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"GqV13lmDXJ8bTbW3cmZV","title":"Third-Party API Integrations","pathname":"/api-docs/plugins-and-integrations/other-integrations/third-party-api-integrations","siteSpaceId":"sitesp_wqN6M","description":"Integrate external APIs like ElevenLabs to enhance your applications with advanced features.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Other Integrations"}]},{"id":"8dkGWxai0jzPFeE7OVza","title":"ElevenLabs API Integration","pathname":"/api-docs/plugins-and-integrations/other-integrations/third-party-api-integrations/elevenlabs-api-integration","siteSpaceId":"sitesp_wqN6M","description":"This is a guide on how to integrate your ElevenLabs voices with Convai characters","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Other Integrations"},{"label":"Third-Party API Integrations"}]},{"id":"mCC3cioDPzGqMj6BUUat","title":"Convai Pixel Streaming Embed","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed","siteSpaceId":"sitesp_wqN6M","description":"","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"Iwsgfz11iH7bumaekCAn","title":"Whitelisting & Publishing an Experience","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/whitelisting-and-publishing-an-experience","siteSpaceId":"sitesp_wqN6M","icon":"chalkboard","description":"Learn how to publish your scene and whitelist domains to embed Convai experiences securely in your web application.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"HYyLcups49ZlTYkAC5N6","title":"React Typescript","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/react-typescript","siteSpaceId":"sitesp_wqN6M","icon":"react","description":"Set up and integrate Convai's Pixel Streaming component in your React TypeScript app using @convai/experience-embed.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"l8vv3zd6ARamfWWoZHLp","title":"ReactJS (JavaScript)","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/reactjs-javascript","siteSpaceId":"sitesp_wqN6M","icon":"react","description":"Integrate Convai's Pixel Streaming into your React JavaScript app using the @convai/experience-embed component.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"Bl1WM6LpsANKMtp0LQOW","title":"Vanilla JavaScript (ES Modules)","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/vanilla-javascript-es-modules","siteSpaceId":"sitesp_wqN6M","icon":"js","description":"Use Convai's Pixel Streaming client directly in browser-based JavaScript apps with native ES module support.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"MhibeeodX75C0pjpQiDH","title":"CDN (UMD Script)","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/cdn-umd-script","siteSpaceId":"sitesp_wqN6M","icon":"js","description":"Integrate Convai's Pixel Streaming into your web app using the UMD build directly from a CDN","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"SKht31jhLhAvwhNt1BBj","title":"On Premise Deployment","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/on-premise-deployment","siteSpaceId":"sitesp_wqN6M","icon":"building","description":"Configure Convai’s Pixel Streaming client to connect with your own backend and streaming servers for on-premise or self-hosted deployments.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"MWe8NjQDMtLGGeNG14mq","title":"API Reference","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/api-reference","siteSpaceId":"sitesp_wqN6M","icon":"webhook","description":"Explore the available props, options, and methods for using Convai's Pixel Streaming client across React, Vanilla JS, TypeScript, and CDN setups.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"aHV8dG6zd7DRJsjbazzV","title":"Asset Uploader","pathname":"/api-docs/asset-uploader","siteSpaceId":"sitesp_wqN6M","description":"Upload Metahumans, Reallusion characters, and Scenes from Unreal Engine to Convai Sim and Avatar Studio with ease."},{"id":"s3lrIqucxPSGo95OOgM0","title":"Core API Reference","pathname":"/api-docs/api-reference/core-api-reference","siteSpaceId":"sitesp_wqN6M","description":"Explore Convai’s Core APIs, divided into Character Crafting and Interaction APIs, to create, customize, and interact with intelligent AI characters.","breadcrumbs":[{"label":"API Reference"}]},{"id":"gsTUYbL4ZFKCtOINokQj","title":"Character Crafting APIs","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis","siteSpaceId":"sitesp_wqN6M","description":"Create and configure AI characters with Convai’s Character Crafting APIs to define their personality, behavior, knowledge and more.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"}]},{"id":"XWE3BRSoU4D0tOAIAYF9","title":"Character Base API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/character-api","siteSpaceId":"sitesp_wqN6M","description":"All the relevant APIs needed to create your own intelligent AI characters with Convai.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"FFi1yUiXmETgoUw75AHX","title":"Backstory API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/backstory-api","siteSpaceId":"sitesp_wqN6M","description":"Learn how to use the Backstory API to create and manage character backstories, adding depth and personality to your NPCs.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"UOtHPa6ISx9iKUY1oY8f","title":"Mindview API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/mindview-api","siteSpaceId":"sitesp_wqN6M","description":"Learn how to use the Backstory API to create and manage character backstories, adding depth and personality to your NPCs.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"G8p6SIjsyhuaiIN7rkWz","title":"Core AI Settings API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/core-ai-settings-api","siteSpaceId":"sitesp_wqN6M","description":"All the relevant APIs needed to modify Core AI setting of your Convai Character.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"oCIidcCW4TDhTMwOM7W8","title":"Narrative Design API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/narrative-design-api","siteSpaceId":"sitesp_wqN6M","description":"The page list all the APIs needed to interact Narrative Design","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"3ggYWwe3Bv6K0A4KMVjn","title":"Knowledge Bank API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/knowledge-bank-api","siteSpaceId":"sitesp_wqN6M","description":"All the relevant APIs needed to interact with Knowledge Bank for you AI characters with Convai.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"w9NkMyt9Xl0jW2J3XPzO","title":"Action API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/action-api","siteSpaceId":"sitesp_wqN6M","description":"This page describes the Action API and how to use it.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"5Wcbc7O4hgMexjJCzSIt","title":"Chat History API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/chat-history-api","siteSpaceId":"sitesp_wqN6M","description":"All the relevant APIs needed to interact with Chat History of a session or character.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"XWKGoRyiqLL5CSNGM93v","title":"Evaluation API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/evaluation-api","siteSpaceId":"sitesp_wqN6M","description":"API to evaluate a conversation transcript based on user defined attributes (e.g. clarity of responses, courtesy, listening skills, and more).","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"MteKvBX7fweeVkU90Ry4","title":"Language List API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/language-list-api","siteSpaceId":"sitesp_wqN6M","description":"API to retrieve the full list of languages, both public and private, available to a user.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"PfsvJRo5OzlyGVrnZG06","title":"Voice List API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/voice-list-api","siteSpaceId":"sitesp_wqN6M","description":"API to retrieve the full list of voices, both public and private, available to a user.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"oO9thYF55EFX4iuE7zxC","title":"Character List API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/character-list-api","siteSpaceId":"sitesp_wqN6M","description":"API to retrieve the list of characters, created by a user.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"fne9do28bEO2Kg1iO5GS","title":"Live APIs (Beta)","pathname":"/api-docs/api-reference/core-api-reference/live-apis-beta","siteSpaceId":"sitesp_wqN6M","description":"Enable real-time, low-latency interaction with Convai AI characters through WebRTC-based Live APIs that support text, audio, and dynamic contextual communication.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"}]},{"id":"KRZRHxk7U8Q3yHwi9YFj","title":"Connect API","pathname":"/api-docs/api-reference/core-api-reference/live-apis-beta/connect-api","siteSpaceId":"sitesp_wqN6M","description":"Establish a live chatbot session for your Convai character, enabling users to connect via audio or video and maintain conversational context.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Live APIs (Beta)"}]},{"id":"8d9VYXokFuzhWLEylqwu","title":"Metrics","pathname":"/api-docs/api-reference/core-api-reference/live-apis-beta/metrics","siteSpaceId":"sitesp_wqN6M","description":"This page explains the metrics sent to clients over the WebRTC data channel.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Live APIs (Beta)"}]},{"id":"Zc962pHlSz8gkDgP6twF","title":"Audio Data (via data channel)","pathname":"/api-docs/api-reference/core-api-reference/live-apis-beta/audio-data-via-data-channel","siteSpaceId":"sitesp_wqN6M","description":"This page explains the metrics sent to clients over the WebRTC data channel.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Live APIs (Beta)"}]},{"id":"sSGFU83mQqghMh4MsRmp","title":"Message Glossary","pathname":"/api-docs/api-reference/core-api-reference/live-apis-beta/message-glossary","siteSpaceId":"sitesp_wqN6M","description":"Complete glossary of all message types available in Convai's Live APIs for real-time communication between clients and the server.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Live APIs (Beta)"}]},{"id":"wSmBAKZXKPsKEwIbphpj","title":"Client-to-server messages","pathname":"/api-docs/api-reference/core-api-reference/live-apis-beta/client-to-server-messages","siteSpaceId":"sitesp_wqN6M","description":"Reference for all messages a client sends to Convai's Live API server over the WebRTC data channel, including payloads, fields, and response details.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Live APIs (Beta)"}]},{"id":"HoQ5XhrSyrgJpxu9Dw4R","title":"Server-to-client messages","pathname":"/api-docs/api-reference/core-api-reference/live-apis-beta/server-to-client-messages","siteSpaceId":"sitesp_wqN6M","description":"Complete reference for all messages Convai sends to the client over a WebRTC data channel in Live APIs, including fields, types, and recommended actions.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Live APIs (Beta)"}]},{"id":"hIPRKZO2HDe3YYFi3g7J","title":"Interaction APIs","pathname":"/api-docs/api-reference/core-api-reference/interaction-apis","siteSpaceId":"sitesp_wqN6M","description":"Enable real-time interaction with AI characters using Convai’s Interaction APIs for natural text and voice-based communication.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"}]},{"id":"NOI4Ph3RXtXVmdFcNVoU","title":"Interaction API","pathname":"/api-docs/api-reference/core-api-reference/interaction-apis/interaction-api","siteSpaceId":"sitesp_wqN6M","description":"This page details on how you can interact with Character.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Interaction APIs"}]}]}