> For the complete documentation index, see [llms.txt](https://docs.convai.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.convai.com/api-docs/plugins-and-integrations.md).

# Plugins & Integrations

- [Convai Unity SDK](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk.md): Add real-time AI characters to Unity training simulations, interactive experiences, and games — with speech, emotion, actions, and persistent memory.
- [Convai Unity SDK overview](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/overview.md): Find explanations of what the Convai Unity SDK is, how its four-tier architecture is organized, and what feature modules ship with the package.
- [What is the Convai Unity SDK](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/overview/what-is-the-convai-unity-sdk.md): Real-time conversational AI characters for Unity — voice pipeline, opt-in feature modules, supported platforms, and minimum requirements.
- [Convai Unity SDK architecture](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/overview/convai-unity-sdk-architecture.md): Understand the Convai Unity SDK four-tier architecture — Runtime, Room, Agent, and Module — and the responsibilities of each tier.
- [Feature map](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/overview/feature-map.md): Find the right Convai Unity SDK feature, module, guide, or reference page for any development goal, indexed by use case.
- [Release notes](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/overview/release-notes.md): Release notes for the Convai Unity SDK — current version highlights, previous release notes, bug fixes, and migration guidance for each release.
- [Compatibility and requirements](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/compatibility-and-requirements.md): Find the Unity version, render pipeline, platform, and network requirements you need before installing the Convai Unity SDK.
- [Unity versions and render pipelines](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/compatibility-and-requirements/unity-versions-and-render-pipelines.md): Reference for Convai Unity SDK environment requirements, including the minimum Unity version, required package dependencies, and render pipeline support.
- [Platform support matrix](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/compatibility-and-requirements/platform-support-matrix.md): Reference for Convai Unity SDK platform support, including feature availability across Windows, macOS, Android, iOS, Meta Quest, and WebGL.
- [Network and API requirements](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/compatibility-and-requirements/network-and-api-requirements.md): Reference for Convai Unity SDK network access, including Convai and LiveKit hosts, firewall rules, authentication, and log-based connection checks.
- [Getting started](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started.md): Step-by-step path from installing the Convai Unity SDK to a validated, working conversational AI character in your scene.
- [Prerequisites](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/prerequisites.md): Confirm the Unity version, package dependencies, and Convai account the Convai Unity SDK requires before you begin installation.
- [Install the Convai Unity SDK](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/installation.md): Install the Convai Unity SDK into a Unity project using Package Manager or Asset Store so the SDK and its dependencies resolve correctly.
- [Configure the API key](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/configure-api-key.md): Enter and validate your Convai API key for local development in the Unity Editor so a Convai character can authenticate while you build a scene.
- [Import and run sample scenes](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/import-and-run-sample-scenes.md): Import the bundled sample scenes and verify the SDK is installed and connected correctly before building your own scene.
- [Scene components reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/scene-components.md): Understand the role of each core Convai scene component — manager, room manager, character, and player — and how they depend on each other.
- [Build a custom scene](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/build-a-custom-scene.md): Add required Convai components to a new Unity scene using the Setup Required Components command and configure your first character.
- [Validate your setup](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/validate-your-setup.md): Check a Convai character with the Troubleshooter window and confirm required components are present before entering Play Mode.
- [Configure conversation input mode](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/configure-conversation-input-mode.md): Choose between hands-free voice activation and push-to-talk, configure the trigger key or controller button, and switch between the two modes at runtime.
- [Configure character audio](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/configure-character-audio.md): Configure per-character and project-wide voice volume, spatial audio, and audio feedback, and control playback in script with mute and unmute calls.
- [Configure microphone](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/configure-microphone.md): Select an active microphone device at runtime, set a project-wide default, and configure platform permissions for Android, iOS, and WebGL builds.
- [Add chat UI](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/add-chat-ui.md): Add the shipped chat transcript prefab to display scrolling conversation history on screen during character interactions.
- [Add lip sync](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/add-lip-sync.md): Connect Convai audio output to your character's facial blendshapes, synchronize mouth movement with speech, and tune playback latency.
- [Profiles and mappings](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/add-lip-sync/profiles-and-mappings.md): Reference for the profile and map assets that control how Convai blendshape data reaches your character's face mesh, and when to create custom ones.
- [Create a lip sync profile](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/add-lip-sync/create-a-lip-sync-profile.md): Create a ConvaiLipSyncProfile asset to define a custom transport format identifier for blendshape formats beyond the three bundled profiles.
- [Create a custom lip sync map](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/add-lip-sync/create-a-custom-blendshape-map.md): Create a lip sync map that routes incoming blendshape channels to your character's mesh, with per-channel weight and clamp tuning.
- [Authentication](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/authentication.md): Compare Convai Unity SDK API Key and Auth Token authentication modes, understand when each applies, and see what ships in a player build.
- [How authentication works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/authentication/how-authentication-works.md): Understand the credential resolution order the Convai Unity SDK follows and the transport header each authentication mode sends.
- [Configure Auth Token mode](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/authentication/configure-auth-token-mode.md): Switch a Convai Unity SDK project to Auth Token mode and configure the token endpoint in Project Settings for a shipped build.
- [Write a custom token provider](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/authentication/custom-token-provider.md): Register a custom credential provider so your backend issues short-lived Convai auth tokens automatically for each connection.
- [Connect with an existing auth token](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/authentication/connect-with-auth-token.md): Pass an already-issued Convai auth token directly into a single connection call when your login layer already holds one.
- [Authentication scripting reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/authentication/scripting-reference.md): Reference for the Convai Unity SDK authentication API, including the token provider interface, registry, and settings accessors.
- [Ship a secure build](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/authentication/ship-a-secure-build.md): Build a Convai Unity SDK player in Auth Token mode so the account API key never reaches the shipped build, and meet WebGL CORS requirements.
- [Troubleshoot authentication](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/authentication/troubleshooting.md): Fix Convai Unity SDK authentication failures using exact console messages, error codes, and causes for API Key and Auth Token mode.
- [AI coding assistant](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/ai-coding-assistant.md): Find guides for connecting AI coding agents to Unity through Convai's SDK-aware MCP tools, including setup, supported agents, and troubleshooting.
- [AI coding assistant quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/ai-coding-assistant/quick-start.md): Open the AI Coding section of the Convai Editor, accept the Unity MCP terms, install a coding agent's instructions, and verify Convai's tools.
- [Supported coding agents](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/ai-coding-assistant/supported-coding-agents.md): Reference for the coding agents the Convai Unity SDK supports, including the exact instruction file path and install behavior for each agent.
- [MCP tools reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/ai-coding-assistant/mcp-tools-reference.md): Reference for every Convai MCP tool exposed to a coding agent, including default enablement and scene-mutation behavior.
- [Troubleshoot AI coding assistant setup](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/ai-coding-assistant/troubleshooting.md): Diagnose and fix Unity MCP bridge reconnects, tool registry refreshes, stale tool rejections, and Unity AI Assistant install failures in the Convai Unity SDK.
- [Core concepts](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts.md): Find explanations for how the Convai Unity SDK works at runtime — connections, sessions, embodiment, dialogue state, and event-driven responses.
- [Runtime architecture](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/runtime-architecture.md): Understand the layered Convai Unity SDK runtime — what each layer owns, the per-character embodiment layer, and how the runtime's lifecycle states are managed.
- [Session lifecycle](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/session-lifecycle.md): Understand how ConvaiCharacter sessions transition through states, persist session IDs, and support explicit pause, resume, and background policy controls.
- [Character embodiment](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/character-embodiment.md): Understand how a character's embodiment modules share one composition root, tick deterministically, and never write the same bone twice.
- [Dialogue state](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/dialogue-state.md): Understand the eight-value dialogue state every embodiment module reads to know whether a character is idle, listening, or speaking.
- [Asset ownership and copy-on-write](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/asset-ownership.md): Understand why editing a package-shipped Convai profile creates an editable project copy instead of changing the original asset.
- [Turn-taking modes](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/turn-taking-modes.md): Configure hands-free and push-to-talk conversation modes, including turn detection, release timing, and barge-in interruption behavior.
- [Voice activity detection](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/voice-activity-detection.md): Understand how the Convai Unity SDK resolves user voice activity detection settings once, at connect time, using either Convai's defaults or your custom values.
- [Event system](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/event-system.md): Reference for Convai event relay components, including available events, payload fields, and subscription patterns for scene logic.
- [Embodiment](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment.md): Find the modules that give a Convai character eye contact, gestures, posture, and expression, and learn which one to add first.
- [How embodiment works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/how-embodiment-works.md): Understand how Convai builds each character's embodiment infrastructure at runtime and the fixed order in which modules run every frame.
- [Embodiment quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/quick-start.md): Add the Gaze module to an existing Convai character so it makes eye contact with the player, visible immediately in Play mode.
- [Character rig setup](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/character-rig-setup.md): Configure a character's rig so Convai automatically detects its facial blendshape convention and bones, and resolve low-confidence detection.
- [Embodiment presets](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/embodiment-presets.md): Bundle multiple embodiment modules' profiles into one reusable preset and apply it to a character so every module's settings travel together.
- [Facial composition](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/facial-composition.md): Reference for the facial composition profile, including per-region blend configuration, blend modes, and layer priority.
- [Embodiment Editor window](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/embodiment-editor.md): Reference for the Convai Embodiment Editor window, covering the Setup, Presets, and Live tabs and what each one shows about a character.
- [Embodiment scripting reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/scripting-reference.md): Reference for the Convai embodiment scripting surface, including the character context, module base class, rig binding, and shared enums.
- [Troubleshoot embodiment](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/troubleshooting.md): Diagnose rig detection, preset slot, module tick, and facial compositing problems in the Convai embodiment system, with fixes and verification steps.
- [Conversation flow](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/conversation-flow.md): Understand what the Conversation Flow module tracks in a conversation and why every other embodiment module depends on its timing.
- [Configure conversation flow](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/conversation-flow/configure.md): Add the Conversation Flow module to a character, or let Convai auto-create it, then assign a profile to tune its timing.
- [Conversation flow reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/conversation-flow/reference.md): Full reference for the Conversation Flow controller's public API, the dialogue-state reading it returns, and every timing field on its profile asset.
- [Troubleshoot conversation flow](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/conversation-flow/troubleshooting.md): Diagnose a dialogue state stuck on Idle, timing that feels wrong, and conflicts between conversation flow drivers in multi-character scenes.
- [Gaze](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/gaze.md): Find guides for adding eye contact and gaze behavior to a Convai character, and see how Gaze replaces the retired Attention module.
- [How gaze works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/gaze/how-gaze-works.md): Understand how the Gaze module chooses a target, shares the look across eyes, head, and body, and reacts to the conversation's dialogue state.
- [Gaze quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/gaze/quick-start.md): Add the Gaze module to an existing Convai character and confirm it makes eye contact with the player immediately in Play mode.
- [Configure eye contact](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/gaze/configure-eye-contact.md): Configure how strongly a Convai character commits to eye contact with the player, from natural behavior to a permanent lock.
- [Gaze targets and providers](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/gaze/targets-and-providers.md): Mark scene objects as gaze candidates, add advanced provider components, and register a custom gaze target provider from code.
- [Scripted gaze](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/gaze/scripted-gaze.md): Direct a Convai character's gaze at a transform or point from code, and await the result to gate a follow-up action on it landing.
- [Gaze profile reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/gaze/profile-reference.md): Reference for every setting group and field in the Convai Gaze profile asset, including defaults and value ranges for each entry.
- [Gaze scripting reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/gaze/scripting-reference.md): Reference for the Convai Gaze system's public API, including the controller, gaze readings, handles, and the target provider interface.
- [Migrate from Attention](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/gaze/migrate-from-attention.md): Replace the retired Attention and legacy Gaze components with Convai Gaze, and avoid losing scene references when you save.
- [Gaze usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/gaze/usage-examples.md): Configure eye contact, script glances, and coordinate multi-character gaze with four complete Convai Gaze usage examples.
- [Troubleshoot gaze](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/gaze/troubleshooting.md): Fix static eyes, heads that will not turn, unselected gaze targets, and refused scripted gaze on Convai Gaze characters.
- [Body animation](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-animation.md): Find guides for giving a Convai character idles, talk motion, walking, and gestures with the code-driven Body Animation module.
- [How body animation works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-animation/how-body-animation-works.md): Understand the layered animation graph that plays idle, talk, locomotion, action, and pointing motion, and how dialogue state drives it.
- [Body animation quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-animation/quick-start.md): Add the Body Animation module to a Convai character with the shipped animation set and see idle and talk motion in Play mode.
- [Build an animation set](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-animation/build-an-animation-set.md): Assemble your own animation set from a folder of clips using the Create Animation Set wizard, or by authoring entries field by field.
- [Configure locomotion](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-animation/configure-locomotion.md): Add NavMesh-based movement to a Convai character, tune its walk and jog speeds, and report travel manually for a custom mover.
- [Play actions and gestures](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-animation/play-actions-and-gestures.md): Play named actions, anchored actions, and pointing gestures on a Convai character from script, and read the handles each call returns.
- [Body animation config reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-animation/config-reference.md): Reference for every setting group and field in the Convai Body Animation config asset, including defaults and value ranges for each entry.
- [Body animation scripting reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-animation/scripting-reference.md): Reference for the Convai Body Animation public API, including the controller, action and pointing handles, and locomotion types.
- [Migrate from Dialogue Animation](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-animation/migrate-from-dialogue-animation.md): Replace the retired Dialogue Animation components with Convai Body Animation and delete the Animator Controller assets it replaces.
- [Body animation usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-animation/usage-examples.md): Script a character that walks to a target and greets on arrival, plays gestures on cue, points at scene objects, and reports custom travel.
- [Troubleshoot body animation](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-animation/troubleshooting.md): Diagnose no motion, a T-pose, locomotion desync, a fighting Animator Controller, actions that never fire, and misaimed pointing gestures.
- [Body language](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-language.md): Find guides for adding ambient posture, breathing, weight shifts, and small reactive movements that keep a Convai character's body alive between animations.
- [How body language works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-language/how-body-language-works.md): Understand how Body Language directs a Convai character's posture, breathing, and gestures every tick, and how it yields to scripted gestures.
- [Body language quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-language/quick-start.md): Add the Body Language component to a Convai character and see breathing, weight shift, and idle life running in Play mode.
- [Tune expressiveness](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-language/tune-expressiveness.md): Make a Convai character's body language read as subtle or theatrical using the expressiveness preset, a runtime override, and per-behavior gains.
- [Trigger gestures and reactions](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-language/gestures-and-reactions.md): Trigger scripted head nods, semantic gesture cues, and one-shot reactions on a Convai character, and handle a refused or busy request.
- [Body language profile reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-language/profile-reference.md): Every field on a Convai character's Body Language profile asset, grouped by section, with its default value and numeric range.
- [Body language scripting reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-language/scripting-reference.md): Complete API reference for the Convai Body Language module, covering the controller, reading struct, handles, and every public enum type.
- [Troubleshoot body language](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/body-language/troubleshooting.md): Diagnose why a Convai character's Body Language controller shows no motion, fights other modules, or reads too subtle or theatrical.
- [Emotion](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/emotion.md): Find guides for a Convai character's facial expression and mood, from first setup through the scripting API and troubleshooting.
- [How the emotion system works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/emotion/how-the-emotion-system-works.md): Understand how Emotion resolves the emotion signal in Convai's response, smooths it, and composes the character's face and mood.
- [Emotion quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/emotion/quick-start.md): Add the Convai Emotion component to a character, run its setup checklist, and see its face react to the conversation in Play mode.
- [Moods](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/emotion/moods.md): Set and clear a Convai character's resting mood from code, and understand how a mood differs from a passing emotion reaction.
- [Emotion profile](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/emotion/emotion-profile.md): Reference for ConvaiEmotionProfile fields, including resting mood, mood drift, contagion, blending, and micro-expression life.
- [Emotion output bindings](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/emotion/output-bindings.md): Reference for the Emotion module's remaining output binding, now that the slot-list facial output path has been removed as a breaking change.
- [Emotion taxonomy](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/emotion/emotion-taxonomy.md): Reference for EmotionTaxonomyAsset, including the built-in emotion set, server alias resolution, and custom taxonomy authoring.
- [Emotion scripting API](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/emotion/scripting-api.md): Reference for ConvaiEmotionController — reading emotion state, mood control, locks, overrides, events, and known emotion labels.
- [Emotion editor windows](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/emotion/emotion-editor.md): Reference for the Emotion editor window, covering its four tabs and the Emotion Timeline recorder opened from the Live tab.
- [Emotion examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/emotion/usage-examples.md): Seven complete scenarios covering hazard overrides, locked expressions, mood shifts, distress branching, analytics logging, and no-code UI wiring.
- [Troubleshoot emotion](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/embodiment/emotion/troubleshooting-and-diagnostics.md): Fix common Convai Unity SDK emotion pipeline failures — from no facial output to silent neutral fallback and LipSync conflicts.
- [Features](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features.md): Index of the Convai Unity SDK feature modules: actions, dynamic context, long-term memory, multi-character sessions, narrative design, scene metadata, vision.
- [Character actions](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions.md): Find the Actions Editor, executor reference, dispatcher configuration, scripting API, and usage guides for Convai character actions in Unity.
- [How character actions work](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/how-character-actions-work.md): Understand the Convai character actions pipeline — how Convai selects actions, how Unity resolves targets, and which components are required.
- [Character actions quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/quick-start.md): Add a ready-made action to a Convai character from the Actions Editor's starter catalog, with no scripting, and confirm it runs in Play mode.
- [Actions Editor](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/actions-editor.md): Reference for the Convai Actions Editor window — its four modes, the Add Action catalog, and one-click executor provisioning.
- [Configure character actions](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/configuring-actions.md): Configure which actions, objects, and characters a Convai NPC can use, then update those affordances during an active session.
- [Update character actions at runtime](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/update-actions-at-runtime.md): Send an action configuration patch mid-session, track its update ID, and confirm the backend's acknowledgement before assuming the change applied.
- [Action executors](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/action-executors.md): Reference for all 21 built-in action executor components, grouped by pack, with every Inspector field, default, and required peer.
- [Write a custom action executor](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/writing-custom-executors.md): Connect custom movement, inventory, UI, or physics behaviors to the Convai action pipeline by writing your own executor component.
- [Dispatcher and batch policies](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/dispatcher-and-batch-policies.md): Configure the dispatcher's batch policy, failure policy, speech gate timeout, barge-in, and lifecycle events for character action execution.
- [How action target resolution works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/attention-and-reference-grounding.md): Understand how a spoken reference resolves to a specific scene object or character, from Convai's language match to Unity's local lookup.
- [Character actions scripting reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/actions-scripting-reference.md): API reference for the Convai character actions system — executor base classes, dispatcher, config types, invocation objects, and enums.
- [Character actions examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/usage-examples.md): Progressive examples for the Convai character actions system — Inspector setup, event subscriptions, scripted batch injection, and an observation action.
- [Migrate actions to v4.5.0](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/migrate-to-v4-5.md): Repair scenes broken by the Character Actions changes in Convai Unity SDK 4.5.0, including a renamed executor, removed executors, and a timing fix.
- [Troubleshoot character actions](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/debugging-and-troubleshooting.md): Diagnose character action setup and runtime issues with the Convai Troubleshooter, the Action Monitor, and a symptom-and-fix reference.
- [Dynamic context](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context.md): Find guides for sending live scene state to Convai characters through the dynamic context relay, scripting API, and synced world-object properties.
- [How dynamic context works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/how-dynamic-context-works.md): Understand how Dynamic Context tracks scene state and events, batches updates, and reports acknowledgement and token feedback.
- [Dynamic context quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/dynamic-context-quick-start.md): Add a Dynamic Context Relay component to an NPC, send a tracked update from a UI button, and confirm the character references it.
- [Relay component reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/relay-component-reference.md): Reference for the Dynamic Context relay component, covering its Inspector fields, public methods, events, and character resolution behavior.
- [Static context at connection time](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/static-context-at-connection-time.md): Configure fixed scenario facts a character receives once at the start of a conversation, separate from updates sent while the conversation is running.
- [Sync behavior and timing](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/sync-behavior-and-timing.md): Understand how the SDK batches dynamic context updates before sending them and how action and attention changes are confirmed by Convai.
- [Dynamic context scripting API](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/dynamic-context-scripting-api.md): Reference for the Convai Unity SDK dynamic context scripting interface, including every method, the respond mode enum, and the attention object API.
- [Dynamic context usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/dynamic-context-usage-examples.md): Five Dynamic Context examples show a relay-driven trigger, a batched update, an event log, an emergency transition, and synced world-object context.
- [Troubleshoot dynamic context](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/troubleshoot-dynamic-context.md): Fix common dynamic context problems in the Convai Unity SDK, including missed updates, delayed responses, and reset behavior that does not clear everything.
- [Long-term memory](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory.md): Find all long-term memory guides — enable memory on characters, manage user identity, use the memory API, and access the scripting reference.
- [How long-term memory works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/how-long-term-memory-works.md): Understand the long-term memory session lifecycle, how memory is scoped by user and character, and how facts are extracted, deduplicated, and injected.
- [Long-term memory quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/quick-start.md): Enable long-term memory for a Convai character in three steps and verify that recall survives across separate sessions in the Unity Editor.
- [Configure memory for a character](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/configure-memory-for-a-character.md): Toggle Long-Term Memory on or off per character via the Convai dashboard or the CharacterService scripting API, and understand the global scope implications.
- [End-user identity](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/end-user-identity.md): Understand how the SDK identifies users for long-term memory scoping and how to implement a custom authentication-backed identity provider.
- [Manage end-user records](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/end-user-management.md): Browse and manage end-user records from the Convai Editor window or from a script, covering the editor tool, every method, and pagination.
- [Memory management API](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/memory-management-api.md): List, add, retrieve, and delete a character's memory records for one player, with setup, every method, response types, and error handling.
- [Long-term memory scripting reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/long-term-memory-scripting-reference.md): Complete memory and end-user API reference: method signatures, parameters, return types, identity interfaces, and the data models each one returns.
- [Long-term memory usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/usage-examples.md): Four complete long-term memory patterns for Unity — zero-config persistence, authenticated identity, memory seeding, and memory reset.
- [Troubleshoot long-term memory](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/long-term-memory/troubleshooting-and-diagnostics.md): Diagnose why long-term memory isn't persisting, verify end-user identity stability across sessions, and resolve Memory Management API HTTP errors.
- [Multi-character sessions](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/multi-character-sessions.md): Find guides for running several Convai characters in one shared room in Unity, choosing who the player is addressing, and changing the cast at runtime.
- [How multi-character sessions work](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/multi-character-sessions/how-multi-character-sessions-work.md): Understand how a Unity scene with several characters becomes one shared room, how its cast list is built at connect, and how ordered commands keep it in sync.
- [Character identity and addressing](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/multi-character-sessions/character-identity.md): Understand the six identifiers a Convai character carries inside a shared Unity room, and which one to use for addressing, audio, and conversation history.
- [Build your first multi-character session](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/multi-character-sessions/quick-start.md): Put two or more Convai characters in one Unity scene, connect them as a single shared room, and confirm that the room becomes ready for input.
- [Roster readiness and partial dispatch](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/multi-character-sessions/readiness-and-partial-dispatch.md): Understand when a shared Unity room is ready to take player input, why one slow character does not block the others, and how start failures are reported.
- [Switch the interaction target](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/multi-character-sessions/switch-the-interaction-target.md): Route player input to a chosen character in a shared Unity room, and release the target without interrupting the character already speaking.
- [Add and remove characters at runtime](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/multi-character-sessions/update-the-roster.md): Add and remove characters in a connected Unity room at runtime, including replacement targets, the clone rule, and roster limits.
- [Join an existing multi-character session](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/multi-character-sessions/join-an-existing-session.md): Bring a second human participant into a Unity multi-character room another client already created, using exactly one room locator.
- [Route audio for each character](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/multi-character-sessions/route-character-audio.md): Control the shared room microphone, bind and mute each character's audio by identity, and measure character playback in Unity.
- [React to roster and target changes](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/multi-character-sessions/handle-roster-events.md): Subscribe to roster and interaction-target events in a shared Unity room, and rely on the order the SDK guarantees between them.
- [Multi-character room session reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/multi-character-sessions/room-session-reference.md): Reference for the multi-character room session type, its membership and status fields, and the results and exceptions its commands return.
- [Multi-character connection API reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/multi-character-sessions/connection-api-reference.md): Reference for the multi-character connection operations, their join and connect option types, and every exception each operation can throw.
- [Multi-character usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/multi-character-sessions/usage-examples.md): Implement look-to-address targeting and a scripted roster swap so a Unity scene manages which character in a room the player addresses.
- [Troubleshoot multi-character sessions](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/multi-character-sessions/troubleshooting.md): Fix roster rejections, readiness failures, misrouted audio, and command errors when running a multi-character session in Unity.
- [Narrative design](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design.md): Find guides for setting up, configuring, scripting, and troubleshooting the Narrative Design system in the Convai Unity SDK.
- [How narrative design works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/how-narrative-design-works.md): Understand the Narrative Design pipeline — how sections, triggers, and template keys connect at runtime to advance a story graph.
- [Narrative design quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/quick-start.md): Add a Narrative Design Manager and a collision trigger to a Convai character and confirm a section change in Play Mode — no code required.
- [Configure the narrative design manager](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/setting-up-the-narrative-design-manager.md): Add and configure ConvaiNarrativeDesignManager on a character, sync sections from Convai, and wire per-section Unity Events in the Inspector.
- [Configure narrative design triggers](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/setting-up-narrative-design-triggers.md): Configure ConvaiNarrativeDesignTrigger to advance the narrative graph using collision, proximity, time-based, or manual activation modes.
- [Configure narrative template keys](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/template-keys-dynamic-narrative-variables.md): Set narrative template keys so a Convai character can reference runtime values — player name, scenario parameters, or session state — in its objectives.
- [Narrative design scripting reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/scripting-narrative-design.md): Reference for controlling a character's narrative flow from code, covering section events, trigger invocation, scripted speech, and data fetching.
- [Narrative design usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/usage-examples.md): Four worked Narrative Design examples from a single-trigger welcome sequence to an adaptive multi-section scenario with dynamic feedback.
- [Troubleshoot narrative design](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/narrative-design/troubleshooting-and-diagnostics.md): Resolve trigger status failures, Inspector misconfigurations, fetch errors, and queue timeouts using built-in validation and diagnostic tools.
- [Scene metadata](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata.md): Find guides, component reference, and examples for Scene Metadata — the feature that gives Convai characters awareness of objects in your Unity scene.
- [How scene metadata works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/how-scene-metadata-works.md): Understand the registration and delivery flow for scene object metadata, and learn when to use Scene Metadata versus Dynamic Context.
- [Scene metadata quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/quick-start.md): Add object awareness to a Unity scene so a Convai character can reference named objects in conversation from the moment it connects.
- [Scene metadata component reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/component-reference.md): Reference for the two components that describe scene objects to Convai and expose their live tracked state, including Inspector fields and lifecycle.
- [Scene metadata scripting API](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/scripting-api-reference.md): Complete C# reference for Scene Metadata's classes, covering object properties, tracked-property updates, registry queries, and manual send triggers.
- [Scene metadata usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/usage-examples.md): Complete Scene Metadata setups for medical training, industrial drills, museum guides, runtime object updates, and tracked property state.
- [Troubleshoot scene metadata](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/troubleshooting-and-diagnostics.md): Fix scene metadata problems including empty payloads, missing collection logs, dependency injection failures, and AI characters ignoring scene objects.
- [Vision](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision.md): Find guides for adding real-time scene vision to Convai characters in Unity, including frame sources, publish policies, scripting, and troubleshooting.
- [How vision works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/how-vision-works.md): Understand the Vision pipeline architecture, including frame sources, publish policy, the WebRTC track to Convai, and how dynamic vision context fits in.
- [Dynamic vision context](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/dynamic-vision-context.md): Reference for the dynamic vision context types that configure backend-driven camera frame sampling and per-lane respond-mode defaults.
- [Vision quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/quick-start.md): 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.
- [Vision frame sources](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/frame-sources.md): Reference for CameraVisionFrameSource, WebcamVisionFrameSource, and QuestVisionFrameSource, including Inspector fields, capture presets, and platform support.
- [Publish policies](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/publishing-and-policies.md): Reference for Vision publish policies, including FPS and bitrate budgets, runtime control methods, auto-publish behavior, and WebGL-specific behavior.
- [Vision debug preview](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/debug-preview.md): Verify the vision camera feed and confirm that vision status requests and triggers reach Convai using Unity Editor debug tools.
- [Custom frame sources](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/custom-frame-sources.md): Implement IVisionFrameSource to publish a custom video pipeline to Convai, including the Y-flip requirement, lifecycle state pattern, and auto-discovery rules.
- [Vision scripting API](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/scripting-api.md): Reference for the Convai Unity SDK vision scripting API, including publish control, runtime status queries, on-demand triggers, and respond-mode events.
- [Vision usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/usage-examples.md): Find code patterns for common Vision setups, including safety training, webcam selection, look-at activation, on-demand triggers, and WebGL deployment.
- [Troubleshoot vision](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/vision/troubleshooting-and-diagnostics.md): Fix Vision publishing failures, blank feeds, permission errors, and platform-specific issues in Unity using a structured checklist and decision tree.
- [UI and Presentation](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation.md): Optional, scene-level UI for displaying transcripts, surfacing notifications, and giving users a runtime settings panel — add only what your project needs.
- [Transcript UI](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/transcript-ui.md): Understand how the Convai Unity SDK separates durable chat history from speech-aligned captions, and which built-in component displays each.
- [Transcript history and queries](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/transcript-ui/transcript-history-and-queries.md): Read the current conversation turn timeline from code, react to live turn changes as they happen, and export session history as text, Markdown, or JSON.
- [Chat and subtitle modes](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/transcript-ui/chat-and-subtitle-modes.md): Add scrolling chat history, live subtitle captions, or both to a scene, and configure how each transcript display looks and behaves.
- [Notification system](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/notification-system.md): Add toast-style alerts that surface session errors automatically, and raise your own in-scene alerts from code using notification assets.
- [Notification system reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/notification-system/notification-system-reference.md): Reference for SONotification, SONotificationGroup, UINotificationController, and SONotificationErrorMap — fields, methods, and configuration options.
- [Settings panel](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/settings-panel.md): Add a runtime settings panel so users can adjust microphone, transcript visibility, and notification preferences, or access the same settings programmatically.
- [Runtime settings API](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/settings-panel/runtime-settings-api.md): Reference for IConvaiRuntimeSettingsService — read current settings, apply patches, react to changes, and reset to defaults from code.
- [Customizing UI components](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/ui-and-presentation/customizing-ui-components.md): Restyle or replace the built-in transcript, notification, and settings UI using character visibility filters or prefab swapping.
- [Scripting reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference.md): Reference for the Convai Unity SDK C# scripting APIs — events, transcripts, audio control, and async operation patterns.
- [Session events](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/session-events.md): Reference for session events — connection state, errors, idle warnings, and participant changes — via relay component or the \`ConvaiEvents\` C# hub.
- [Character events](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/character-events.md): Reference for character events — speech, emotion, transcripts, turn lifecycle, and actions — via relay component or the \`ConvaiEvents\` C# hub.
- [Transcript API](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/transcript-api.md): Query transcript turns, subscribe to live changes, read captions, and export session history from Unity scripts using the transcript facade.
- [Character and Player API](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/character-and-player-api.md): Reference for ConvaiCharacter and ConvaiPlayer, including properties, methods, and events for session control, speech, audio, and attention.
- [ConvaiManager API](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/convaimanager-api.md): Scripting reference for ConvaiManager — the SDK entry point for connection control, facade access, conversation ownership, and service discovery.
- [Audio API](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/audio-api.md): Scripting reference for ConvaiAudio — microphone muting, per-character audio control, audio playback unlock, and listening state management.
- [Operation and stream types](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/operation-and-stream-types.md): Type reference for IConvaiOperation\<T>, IConvaiStream\<T>, ConvaiError, and Unit — the async primitives used across all Convai SDK scripting APIs.
- [Async patterns](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/scripting-reference/async-patterns.md): Consume IConvaiOperation\<T> and IConvaiStream\<T> using async/await, coroutines, chaining, progress tracking, cancellation, and streams.
- [Platform guides](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides.md): Deploy the Convai Unity SDK on any supported platform — covers what requires extra configuration on WebGL, iOS, Android, and XR headsets before shipping.
- [Windows, macOS, and Linux](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/windows-macos-and-linux.md): Windows, macOS, and Linux builds require no extra SDK configuration — all features including Vision, spatial audio, and screen share work after standard setup.
- [WebGL](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/webgl.md): Deploy the Convai Unity SDK to WebGL, covering HTTPS, browser audio gestures, Vision canvas capture, and the known lip-sync drift issue.
- [iOS and Android](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/ios-and-android.md): Declare microphone and camera permissions for iOS and Android builds — omitting them causes crashes on iOS and silent failures on Android.
- [XR headsets](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/xr-headsets.md): Find guides for deploying the Convai Unity SDK on XR headsets, including Meta Quest Vision passthrough setup and custom XR frame source implementation.
- [Meta Quest Vision setup](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/platform-guides/meta-quest-vision.md): Configure QuestVisionFrameSource to stream the Meta Quest passthrough camera to a Convai character on Quest 3 and 3S builds.
- [Customize and extend the SDK](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics.md): Replace the SDK-supplied providers, extend the runtime with your own modules, and diagnose latency with the built-in telemetry.
- [Credentials, identity, and storage](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/custom-providers.md): Replace the SDK's default credential, identity, and persistence providers with custom implementations suited to your deployment environment.
- [Custom credential provider](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/custom-providers/custom-credential-provider.md): Override the SDK's default credential source to supply API keys from environment variables, a secrets vault, or any runtime-resolved credential store.
- [Custom identity provider](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/custom-providers/custom-identity-provider.md): 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.
- [Custom persistence provider](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/custom-providers/custom-persistence-provider.md): Replace the default session storage with your own remote service, an encrypted file store, or an in-memory implementation for tests.
- [Personal access token](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/custom-providers/personal-access-token.md): Generate short-lived tokens from your backend so the real API key never ships inside your Unity build, eliminating credential exposure from client applications.
- [Runtime module system](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/extending-the-sdk.md): 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.
- [Implement a custom module](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/implement-a-custom-module.md): Implement \`IConvaiModule\` to add custom runtime behavior that starts with the SDK, accesses runtime services, and reacts to domain events.
- [Logging, metrics, and retry policy](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/advanced-topics/performance-and-optimization.md): Configure SDK log verbosity per subsystem, route logs to custom sinks, read RTVI pipeline latency metrics, and tune the connection retry policy.
- [Troubleshooting](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/troubleshooting.md): Find the Convai Troubleshooter window plus troubleshooting guides for installation, API, audio, and debug tools in the Unity SDK.
- [Convai Troubleshooter](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/troubleshooting/convai-troubleshooter.md): Reference for the Convai Troubleshooter window, including how it reports findings, applies fixes, and lets a project add its own checks.
- [Installation and package issues](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/troubleshooting/installation-and-package-issues.md): Fix Convai Unity SDK import failures, unsupported Unity versions, missing package dependencies, and bootstrapper startup warnings.
- [Connection and API issues](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/troubleshooting/connection-and-api-issues.md): Interpret Convai session error codes, read ConvaiRoomManager diagnostics, and resolve authentication, transport, and rate-limit failures.
- [Audio and microphone issues](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/troubleshooting/audio-and-microphone-issues.md): Fix microphone input failures and character voice playback issues on all Convai Unity SDK platforms, including Android, iOS, and WebGL.
- [Debug tools reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/troubleshooting/debug-tools-reference.md): Reference for Convai SDK debug tools, including the Troubleshooter, per-module editor windows, logging, and client latency metrics.
- [Convai Unreal Engine plugin](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin.md): Find installation guides, feature documentation, Blueprint reference, and troubleshooting pages for the Convai Unreal Engine plugin.
- [Convai Unreal Engine plugin overview](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/overview.md): Find explanations of what the Convai Unreal Engine plugin is, how its five modules and runtime components are structured, and what changed in each release.
- [What is the Convai Unreal Engine plugin](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/overview/what-is-the-convai-unreal-engine-plugin.md): Understand what the Convai Unreal Engine plugin adds to a project: Blueprint components, a real-time voice pipeline, and opt-in feature add-ons.
- [Plugin architecture](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/overview/plugin-architecture.md): Understand the Convai Unreal Engine plugin's four modules, runtime components, session proxies, and subsystem routing model.
- [Feature map](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/overview/feature-map.md): Find the right Convai Unreal Engine plugin feature, guide, or reference page for any development goal, indexed by use case.
- [Release notes](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/overview/release-notes.md): Version history and notable changes for the Convai Unreal Engine plugin, covering public 4.x beta releases and the full 3.x history.
- [Migrate to 4.0.0-beta.27](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/overview/migrate-to-4-0-0-beta-27.md): Update an existing Unreal project from the previous plugin beta, covering every removed pin, retired enum, and Blueprint node that needs refreshing.
- [Compatibility and requirements](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/compatibility-and-requirements.md): Find the Unreal Engine version support, platform targets, character rig compatibility, and network requirements for the Convai Unreal Engine plugin.
- [Unreal Engine versions](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/compatibility-and-requirements/unreal-engine-versions.md): Reference for Convai Unreal Engine plugin version support, including module availability per UE version, load phases, and per-version setup notes.
- [Unreal Engine platform support matrix](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/compatibility-and-requirements/unreal-engine-platform-support-matrix.md): Reference for Convai Unreal Engine plugin platform support, including build targets, engine plugin dependencies, and Android microphone access.
- [Character rig support](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/compatibility-and-requirements/character-rig-support.md): Which character rigs work with the Convai Unreal Engine plugin, what setup each requires, and where to find the rig-specific setup guides.
- [Network and API requirements](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/compatibility-and-requirements/network-and-api-requirements.md): Reference for Convai Unreal Engine plugin network access, including Convai and LiveKit hosts, firewall rules, authentication, and session log checks.
- [Getting started](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started.md): 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.
- [Prerequisites](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/prerequisites.md): Verify engine version, account, platform, and network requirements before installing the Convai Unreal Engine plugin into your project.
- [Install the Convai plugin](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/install-the-convai-plugin.md): Install the Convai Unreal Engine plugin from Fab or GitHub Releases, enable it in your project, and restart the Unreal Editor.
- [Configure your API key](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/configure-your-api-key.md): Sign in through the Convai editor window to store your API key and allow the plugin to send authenticated requests to Convai.
- [Scene components reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/scene-components-reference.md): Reference for the Convai Chatbot, Player, Object, and Face Sync components — their fields, runtime properties, and how they connect in a scene.
- [Add your first Convai character](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/add-your-first-convai-character.md): Build a talking Convai character in Unreal Engine by adding Chatbot and Player components, setting a Character ID, and testing in Play mode.
- [Set up a MetaHuman character](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/set-up-a-metahuman-character.md): Add Convai Chatbot and Face Sync components to a MetaHuman, assign the Convai animation classes, and configure lip sync for MetaHuman blendshapes.
- [Set up a Reallusion (CC) character](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/set-up-a-reallusion-cc-character.md): Export a Reallusion CC5 avatar, import it into Unreal Engine, configure Convai components, and add the Reallusion animation Blueprint for lip sync.
- [Configure the microphone](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/configure-the-microphone.md): Select a capture device, adjust volume, test the microphone, and handle Android permissions so player speech reaches the Convai character.
- [Configure character audio](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/configure-character-audio.md): Adjust character speech playback volume, enable spatial audio attenuation, and configure the interrupt fade duration on the Convai Chatbot component.
- [Configure conversation input](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/configure-conversation-input.md): Switch between push-to-talk and hands-free voice capture modes, tune VAD settings, and send text messages to a character without a microphone.
- [Add the chat UI](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/add-the-chat-ui.md): 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.
- [Validate your setup](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/validate-your-setup.md): Run through a checklist of plugin, component, audio, and API key checks to confirm your Convai Unreal Engine setup is working before adding features.
- [Stack O Bot tutorial setup](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/getting-started/stack-o-bot-tutorial-setup.md): Build the sample project used by the Convai character actions tutorial, starting from Epic's free Stack O Bot and applying the Convai tutorial files.
- [Core concepts](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/core-concepts.md): Understand the component model of the Convai Unreal Engine plugin, how each component is owned, and how they work together at runtime.
- [Runtime architecture](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/core-concepts/runtime-architecture.md): Understand the roles, ownership, and relationships between the Convai Chatbot, Player, Object, Face Sync components, and the Convai Subsystem.
- [Session lifecycle](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/core-concepts/session-lifecycle.md): Understand how Convai sessions start and stop, what connection states mean, and which Blueprint nodes monitor the global connection.
- [Conversation flow](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/core-concepts/conversation-flow.md): Understand voice input, playback state, transcription events, action queue execution, narrative triggers, and interruption handling.
- [Event system](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/core-concepts/event-system.md): Reference for core runtime Blueprint delegates on Convai components and the subsystem, organized by category with timing details.
- [Features](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features.md): Find guides for all Convai Unreal Engine plugin features — lip sync, character actions, narrative design, long-term memory, vision, and more.
- [Character actions](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions.md): Find guides, references, and examples for the Convai Unreal Engine character actions system — from quick start to Blueprint API reference.
- [How character actions work](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/how-character-actions-work.md): Understand how Convai character actions move from session setup to queued Blueprint handler execution and completion reporting.
- [Character actions quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/character-actions-quick-start.md): Enable character actions, set up pawn movement and navigation, register scene objects, and verify default movement actions in Play mode.
- [Configuring actions](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/configuring-actions.md): Define the action set, enable character actions, and register environment objects and characters so Convai can reference them.
- [Writing clear action names and descriptions](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/writing-clear-action-names-and-descriptions.md): Simple examples for naming, describing, and testing character actions.
- [Built-in action handlers](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/built-in-action-handlers.md): Reference handler patterns for the four default Convai character actions, including parameters, completion rules, and Blueprint flow.
- [Building custom action handlers](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/building-custom-action-handlers.md): Add a custom action template, scaffold a Blueprint handler with the editor utility, and report completion so the queue advances.
- [Parameterized actions](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/parameterized-actions.md): Declare typed action parameters and read resolved values in Blueprint handlers for text, references, choices, and animations.
- [Attention and reference grounding](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/attention-and-reference-grounding.md): Understand how the Convai Unreal Engine plugin resolves pronoun references and attention targets so characters understand which object a player means.
- [Actions Blueprint reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/actions-blueprint-reference.md): Reference for the Blueprint structs, enums, events, and queue functions that power Convai character actions in Unreal Engine.
- [Character actions examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/character-actions-examples.md): End-to-end action recipes for navigating to a registered object, following a character, and using parameterized actions in the Convai Unreal Engine plugin.
- [Troubleshoot character actions](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-actions/troubleshoot-character-actions.md): Fix character actions that do not fire, movement failures, reference issues, and queue stalls in the Convai Unreal Engine plugin.
- [Character movement](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-movement.md): Find guides and references for making Convai characters walk to objects, escort the player to a destination, and author movement points.
- [How character movement works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-movement/how-character-movement-works.md): Explains how Convai resolves a movement destination, picks a movement point, falls back to an object's bounds, and defines arrival.
- [Move a character to an object](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-movement/move-a-character-to-an-object.md): Wire the Convai Move To node so an AI-controlled character walks to an actor, a component, or an authored movement point in your level.
- [Escort a character](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-movement/escort-a-character.md): Wire the Convai Escort node so one character leads another to a destination in your level, waiting for them when they fall behind.
- [Author movement points](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-movement/author-movement-points.md): Place named destinations on a Convai Object Component using the viewport visualizer or the Details panel, so characters approach it correctly.
- [Movement Blueprint reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-movement/movement-blueprint-reference.md): Reference for the Convai Move To and Convai Escort Blueprint nodes, their inputs, outputs, and every result code they can return.
- [Troubleshoot character movement](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/character-movement/troubleshoot-character-movement.md): Diagnose why Convai Move To or Convai Escort fails, reports an unexpected result code, or never reaches its destination.
- [Spatial awareness](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/spatial-awareness.md): Give Convai characters a plain-language sense of where objects, other characters, and the player are around them, and why it matters.
- [How spatial awareness works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/spatial-awareness/how-spatial-awareness-works.md): Understand distance bands, direction, facing, line of sight, relations, and how spatial facts become the sentences a character reads.
- [Spatial awareness quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/spatial-awareness/spatial-awareness-quick-start.md): Turn on spatial awareness, tune the distance bands for your level's scale, and confirm what a character actually receives.
- [Describe objects from the player's view](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/spatial-awareness/describe-from-player-perspective.md): Make a character describe its surroundings from the player's own camera frame instead of its own, so it can give directions.
- [Merge same-named objects](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/spatial-awareness/merge-same-named-objects.md): Merge a pile of identically named objects, like a stack of crates, so a character perceives the whole set as one logical thing.
- [Spatial awareness settings reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/spatial-awareness/spatial-awareness-reference.md): Look up every spatial awareness and object-naming project setting, its default value, its unit, and the condition that enables it.
- [Troubleshoot spatial awareness](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/spatial-awareness/troubleshoot-spatial-awareness.md): Fix a character that describes nothing, hides objects behind walls, reads everything as far away, or confuses duplicate object names.
- [Dynamic context](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context.md): Find guides for pushing live state and events to Convai characters through Blueprint nodes and verifying context-aware responses in your level.
- [How dynamic context works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/how-dynamic-context-works.md): Understand how dynamic context tracks runtime state, batches events, chooses response behavior, and assembles payloads for Convai.
- [Dynamic context quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/dynamic-context-quick-start.md): Push a state property and a context event to a connected Convai character in Blueprint and verify the update reaches the context pipeline.
- [Static context at connection time](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/static-context-at-connection-time.md): Understand which verified connection data is fixed at session start and how live context updates use separate runtime messages.
- [Sync behavior and timing](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/sync-behavior-and-timing.md): Understand how dynamic context flushes after debounce, how Wait Until Conversation Is Idle holds updates, and how offline queueing works.
- [Dynamic context Blueprint reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/dynamic-context-blueprint-reference.md): Reference the Blueprint controls that send runtime state, event, reset, timing, and delivery updates from an Unreal character to Convai during a live session.
- [Dynamic context usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/dynamic-context-usage-examples.md): Blueprint recipes for health tracking, context events, ephemeral cues, zone transitions, state removal, and dynamic context resets in training simulations.
- [Troubleshoot dynamic context](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/dynamic-context/troubleshoot-dynamic-context.md): Fix dynamic context updates that arrive too late, trigger unexpected responses, or appear ignored after a flush or reconnect.
- [Emotion](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion.md): Find guides for animating AI character expressions in sync with conversation — from quick Blueprint setup to full reference and troubleshooting.
- [How the emotion system works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion/how-the-emotion-system-works.md): 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.
- [Emotion quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion/emotion-quick-start.md): Wire a Convai character's emotion scores to morph targets on its Skeletal Mesh so facial expressions update automatically during conversation.
- [Emotion Blueprint reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion/emotion-blueprint-reference.md): Reference for emotion properties, functions, events, and enums on the Convai Chatbot component — including types, defaults, and parameter details.
- [Emotion examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion/emotion-examples.md): Six scenarios covering forced expressions, cutscene locks, score-driven VFX, offset tuning, neutral reset, and Animation Blueprint blend poses.
- [Troubleshoot emotion](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/emotion/troubleshoot-emotion.md): Fix common emotion problems — expressions not appearing, state locked unintentionally, morph target mismatches, and offset changes with no visible effect.
- [Long-term memory](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory.md): Find guides for enabling long-term memory, identifying players, resuming sessions, and troubleshooting recall in Unreal Engine.
- [How long-term memory works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/how-long-term-memory-works.md): Understand how Unreal long-term memory uses character settings, player identity, and connect-time parameters to recall prior interactions.
- [Long-term memory quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/long-term-memory-quick-start.md): Set up long-term memory for an Unreal character, assign a stable player identity, and confirm recall across Play In Editor sessions.
- [Configure memory for a character](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/configure-memory-for-a-character.md): Enable long-term memory for an Unreal character, verify the dashboard setting, and reset the local conversation link when needed.
- [End-user identity](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/end-user-identity.md): Configure a stable Unreal player identity so each Convai character loads memory for the correct user before a session starts.
- [Speaker ID management](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/speaker-id-management.md): Create, list, and delete Speaker ID records from Unreal Blueprints so each player keeps a stable memory identity across sessions.
- [LTM Blueprint reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/ltm-blueprint-reference.md): Reference for Unreal long-term memory Blueprint nodes, Speaker ID data, component properties, and session fields used during startup.
- [Long-term memory usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/long-term-memory-usage-examples.md): Apply Unreal long-term memory patterns for returning learners, shared devices, first sessions, and fresh-start reset flows.
- [Troubleshoot long-term memory](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/long-term-memory/troubleshoot-long-term-memory.md): Diagnose disabled memory, unstable player identity, speaker identity failures, and shared-device recall issues for Unreal characters.
- [Narrative design](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design.md): Drive character story graphs from Unreal Engine by invoking narrative triggers, injecting template keys, and handling section change events.
- [How narrative design works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/how-narrative-design-works.md): Understand the narrative design story graph, the runtime pipeline that advances sections, and how triggers and template keys shape character behavior.
- [Narrative design quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/narrative-design-quick-start.md): Invoke a named narrative trigger from Blueprint and confirm a section change by printing the new section ID to the screen.
- [Narrative triggers](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/narrative-triggers.md): Invoke named narrative triggers or dynamic context messages on a Convai chatbot component to advance the story graph and handle the section change event.
- [Template keys](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/template-keys.md): Populate the Narrative Template Keys map on a chatbot component so section objectives reference live gameplay values through placeholder substitution.
- [Fetching narrative data](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/fetching-narrative-data.md): Query a character's narrative sections and triggers at runtime using Convai Fetch Narrative Sections and Convai Fetch Narrative Triggers.
- [Narrative design Blueprint reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/narrative-design-blueprint-reference.md): Reference for Blueprint functions, events, properties, and narrative structs on UConvaiChatbotComponent in the narrative design API.
- [Narrative design usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/narrative-design-usage-examples.md): Blueprint recipes for linear scene progression, dynamic context events, template key injection, and trigger-name validation in narrative design.
- [Troubleshoot narrative design](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/narrative-design/troubleshoot-narrative-design.md): Diagnose and fix narrative design issues including missing section events, wrong transitions, ignored template keys, and fetch failures.
- [Scene metadata](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata.md): Find guides, reference pages, and examples for giving Convai characters awareness of objects in your Unreal Engine level.
- [How scene metadata works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/how-scene-metadata-works.md): Understand how scene object metadata reaches Convai at connect time, through live updates, and via tracked property changes.
- [Scene metadata quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/scene-metadata-quick-start.md): Tag a world actor with the Convai Object Component, assign its name and description, and confirm a Convai character can reference it in conversation.
- [Scene metadata component reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/scene-metadata-component-reference.md): Full property, function, and event reference for the Convai Object Component, including object identity, tracked properties, proximity state, and gaze events.
- [Managing the environment at runtime](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/managing-the-environment-at-runtime.md): Reference for chatbot environment methods that add, remove, and update objects and characters during an active gameplay session.
- [Scene metadata usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/scene-metadata-usage-examples.md): Complete scene metadata setups for training simulations, industrial drills, military bases, and runtime environment updates in Unreal Engine.
- [Troubleshoot scene metadata](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/scene-metadata/troubleshoot-scene-metadata.md): Diagnose and fix common problems with scene objects not being recognized, stale environment data, and tracked properties failing to update.
- [Vision](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision.md): Give Convai characters scene vision in Unreal Engine so they can respond to what is visible in the level during conversation.
- [How vision works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/how-vision-works.md): Understand how Unreal vision components are discovered, started, throttled, and used to send scene frames during a Convai session.
- [Vision quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/vision-quick-start.md): Add scene vision to a Convai character Blueprint and verify that captured frames affect the character's response in Play In Editor.
- [Vision frame sources](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/vision-frame-sources.md): Configure the built-in Environment Webcam frame source, create its render target, and select the active vision component at runtime.
- [Custom vision components](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/custom-vision-components.md): Implement a C++ frame source component for custom Unreal image pipelines that need to provide scene frames to a Convai chatbot.
- [Vision Blueprint reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/vision-blueprint-reference.md): Reference for Blueprint-accessible vision enums, Environment Webcam properties, webcam nodes, events, and Chatbot integration functions.
- [Vision usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/vision-usage-examples.md): Apply common Blueprint patterns for Unreal vision, including auto-start capture, manual control, FPS tuning, and source switching.
- [Troubleshoot vision](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/vision/troubleshoot-vision.md): Fix common Unreal vision problems including missing visual context, failed starts, blank render targets, and invalid source registration.
- [Gaze attention](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention.md): Find guides and reference for the gaze attention system, which lets players direct a Convai character's focus by looking at world objects.
- [How gaze attention works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention/how-gaze-attention-works.md): Understand the gaze trace pipeline, attention promotion timers, component-scoped targeting, highlight rendering, and the attention-source locking rule.
- [Gaze attention quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention/gaze-attention-quick-start.md): Enable gaze attention on the Convai Player Component and verify that a character responds when the player looks at a tagged world object.
- [Gaze attention reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention/gaze-attention-reference.md): Complete property, event, method, and class reference for the gaze attention system, including all defaults and version-specific behavior.
- [Gaze attention usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention/gaze-attention-usage-examples.md): Blueprint recipes for gaze events, custom highlight visuals, component-scoped targeting, manual attention locking, and building a custom cursor widget.
- [Troubleshoot gaze attention](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/gaze-attention/troubleshoot-gaze-attention.md): Diagnose and fix gaze attention issues — objects not highlighting, attention never promoting, cursor not appearing, and component-scoped gaze not matching.
- [Lip sync](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync.md): Animate a character's face in sync with Convai speech using precomputed blendshape data and the Convai Face Sync AnimGraph node.
- [How lip sync works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/how-lip-sync-works.md): Understand how Convai delivers facial animation data alongside audio, the supported lip-sync modes, and how the AnimGraph node applies it.
- [Lip sync quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/lip-sync-quick-start.md): Add the Convai Face Sync component and Convai animation classes to a MetaHuman character and hear lip-synced speech in Play In Editor.
- [Face Sync component reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/face-sync-component-reference.md): 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.
- [Face Sync AnimGraph node reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/face-sync-animgraph-node-reference.md): Reference for all properties of the Convai Face Sync AnimGraph node — apply mode, face alphas, smoothing, starvation blending, and blendshape mapping.
- [Record and replay lip sync](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/record-and-replay-lip-sync.md): Capture a live lip-sync sequence during a Convai conversation and replay it later in cutscenes, cached responses, or offline previews without re-streaming.
- [Lip sync usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/lip-sync-usage-examples.md): Configure lip sync for common scenarios: Add vs Override blending, tuning smoothing, mixing with body animation, and remapping blendshapes to a custom rig.
- [Troubleshoot lip sync](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/features/lip-sync/troubleshoot-lip-sync.md): Diagnose and fix lip sync issues in the Convai Unreal Engine plugin — no mouth movement, frame starvation, wrong blendshape map, and rig mismatch.
- [AI coding assistant](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/ai-coding-assistant.md): Connect a supported coding agent to the Unreal Editor so it can set up Convai characters and read Convai's skill library for you.
- [AI coding assistant quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/ai-coding-assistant/quick-start.md): Open Set Up AI Coding in the Convai editor window, pick a coding agent, restart the editor, and confirm Convai's tools are registered.
- [Supported coding agents](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/ai-coding-assistant/supported-coding-agents.md): Reference for the five coding agents AI coding setup supports, including each agent's context file, terminal support, and options.
- [Convai Toolset reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/ai-coding-assistant/convai-toolset-reference.md): Reference for the seven editor actions a connected coding agent can call to set up Convai characters, players, and actions.
- [Convai AgentSkills](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/ai-coding-assistant/convai-agent-skills.md): Reference for the 17 shipped skill documents that teach a connected coding agent how each Convai feature in the plugin behaves.
- [Advanced topics](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/advanced-topics.md): Find production authentication, security, and integration guides for the Convai Unreal Engine plugin beyond the core setup path.
- [Use personal access tokens](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/advanced-topics/personal-access-token.md): 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.
- [Blueprint reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference.md): Find verified Blueprint component, utility, audio, and shared data references for the Convai Unreal Engine plugin runtime workflow.
- [Convai Chatbot Component](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/convai-chatbot-component.md): Reference for the AI character component — every Blueprint-visible property, function, and event exposed by the Convai Chatbot Component.
- [Convai Player Component](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/convai-player-component.md): Reference for the player conversation component — every Blueprint-visible property, function, and event exposed by the Convai Player Component.
- [Convai Object Component](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/convai-object-component.md): Reference for the object tagging component — every Blueprint-visible property, function, and event exposed by the Convai Object Component.
- [Microphone and audio capture](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/microphone-and-audio-capture.md): Reference for microphone device enumeration, selection, volume, and persisted settings on the Convai Player Component and the microphone subsystem.
- [Convai utility functions](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/convai-utility-functions.md): Find cross-cutting Blueprint helper nodes for look-at queries, component lookup, audio utilities, settings, diagnostics, and command-line flags.
- [Data types and enums](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/blueprint-reference/data-types-and-enums.md): Reference for Blueprint-exposed structs and enums in the Convai Unreal Engine plugin, including object entries, action types, emotions, and connection states.
- [The Convai editor window](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/editor-window.md): Open the Convai editor window, understand its main sections, and find account, update, support, and log export workflows.
- [Sign in and manage your account](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/editor-window/sign-in-and-manage-your-account.md): Connect your Convai account through the editor window, sign out to switch accounts, and review plan, quota, and usage details inside Unreal Editor.
- [Browse samples and content](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/editor-window/browse-samples-and-content.md): Check the current Samples area in the Convai Editor window and understand how sample projects will be surfaced in future updates.
- [Export diagnostic logs](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/editor-window/export-diagnostic-logs.md): Export Convai diagnostics from Unreal Editor and attach the generated log package to a Convai Developer Forum support request.
- [Troubleshooting](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting.md): Find fixes for installation, API key, audio, lip sync, and connection problems in the Convai Unreal Engine plugin, plus log export and diagnostic guidance.
- [Installation and plugin issues](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting/installation-and-plugin-issues.md): Fix plugin-not-found errors, module load failures, Blueprint-only project limitations, and Android packaging errors in the Convai Unreal Engine plugin.
- [Connection and API key issues](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting/connection-and-api-key-issues.md): Fix authentication failures, missing API key errors, session timeout, and firewall problems in the Convai Unreal Engine plugin.
- [Audio and microphone issues](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting/audio-and-microphone-issues.md): Fix audio capture failures, wrong microphone device, Android permission errors, and audio playback problems in the Convai Unreal Engine plugin.
- [Lip sync and animation issues](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting/lip-sync-and-animation-issues.md): Fix missing mouth movement, wrong blendshape curves, frame starvation, and packaged build animation failures in the Convai Unreal Engine plugin.
- [Diagnostics and log export](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting/diagnostics-and-log-export.md): Reference for Convai log categories, verbosity levels, configuration defaults, Blueprint diagnostic nodes, and log file export for the Unreal Engine plugin.
- [Inspect a character with the Convai Debug Overlay](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting/convai-debug-overlay.md): Turn on the in-game overlay to see the context, facts, surroundings text, and action queue a Convai character currently has.
- [Convai Debug Overlay reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unreal-engine-plugin/troubleshooting/convai-debug-overlay-reference.md): Every panel, glyph, key, and setting the in-game Convai Debug Overlay exposes, with exact on-screen labels, colors, and keyboard shortcuts.
- [Web Plugins](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins.md): Integrate Convai AI with your website. Follow our Web plugin documentation for seamless setup.
- [Convai Web SDK](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk.md): Explore the Convai Web SDK — Fast, low-latency, voice-first AI character interaction for the browser
- [React](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react.md): 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.
- [useConvaiClient Hook](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/useconvaiclient-hook.md): useConvaiClient manages all Convai connection logic, audio/video pipelines, and message flows.
- [ConvaiWidget](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/convaiwidget.md): ConvaiWidget is an all-in-one interface for voice, text, video, and screen sharing.
- [Real-time Lipsync](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/real-time-lipsync.md): Integrate real-time facial animation in your React applications.
- [Custom UI & Advanced Usage](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/custom-ui-and-advanced-usage.md): Build your own UI while using Convai’s audio pipelines and message system.
- [Audio Visualizer (Optional)](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/audio-visualizer-optional.md): You can create real-time visualizations from the bot’s audio using Web Audio + the WebRTC room.
- [Vanilla Typescript](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript.md): 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.
- [ConvaiClient (Core API)](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/convaiclient-core-api.md): ConvaiClient is the main class for managing Convai in vanilla TypeScript.
- [Events & Message Handling](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/events-and-message-handling.md): ConvaiClient provides a strongly typed event system. Use client.on(event, handler) to subscribe.
- [Real-time Lipsync](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/real-time-lipsync.md): Integrate real-time facial animation in vanilla JavaScript/TypeScript applications.
- [Building a Custom UI (TypeScript)](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/building-a-custom-ui-typescript.md): This page shows how to wire up a simple DOM-based chat UI using vanilla TypeScript.
- [Best Practices & Type Definitions](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/best-practices-and-type-definitions.md): A summary of recommended patterns and the main TypeScript types for quick reference.
- [Mappings Reference](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/mappings-reference.md)
- [Quickstart](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/quickstart.md): Get a Convai character speaking in your app in under five minutes.
- [Lipsync & Blendshape](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/lipsync-and-blendshape.md): Drive real-time facial animation on 3D characters using blendshape data streamed alongside the bot's audio.
- [MetaHuman limit drivers — REQUIRED for \`mha\`](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/lipsync-and-blendshape/metahuman-limit-drivers-required-for-mha.md)
- [Actions](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/actions.md): 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.
- [Emotions](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/emotions.md): 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.
- [Dynamic Context](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/dynamic-context.md): Inject real-time context into the character's understanding — game state, user preferences, scene changes — without reconnecting.
- [Long Term Memory](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/long-term-memory.md): Convai can remember things about your users across sessions. When you provide an \`endUserId\`, the character automatically builds and recalls long-term memories.
- [Auth Tokens](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/auth-tokens.md): 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.
- [Error Handling](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/error-handling.md): 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.
- [WebSocket Transport Layer](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/websocket-transport-layer.md): 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.
- [Event Reference](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/event-reference.md): Subscribe with \`client.on(event, callback)\`. The return value is an unsubscribe function.
- [Convai Web SDK (Legacy)](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk-1.md): Integrate Convai conversational services in your own web application
- [Getting Started](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk-1/getting-started.md): Begin building applications with our quick start guide for the Web SDK
- [Facial Expressions](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk-1/facial-expressions.md): This section provides comprehensive information on integrating and handling facial expressions and lipsync within your web applications using the convai-web-sdk.
- [Actions](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk-1/actions.md): Ask your NPC to perform actions using our JavaScript SDK
- [PlayCanvas Plugin](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin.md): PlayCanvas template for Convai integration.
- [Adding External Script](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/adding-external-script.md): Adding External Script - PlayCanvas Plugin Guide for Convai integration.
- [First Person View](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/first-person-view.md): First Person View - PlayCanvas Plugin Guide for Convai integration.
- [Adding characters to scene](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/adding-characters-to-scene.md): Adding Characters to Scene - PlayCanvas Plugin Guide for Convai integration.
- [Character Animations](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/character-animations.md): Add character animations in PlayCanvas with Convai. Enhance your web projects with interactive AI.
- [Convai Integration](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/convai-integration.md): Convai Integration - PlayCanvas Plugin Guide for seamless integration.
- [Chat Overlay](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/chat-overlay.md): Chat Overlay - PlayCanvas Plugin Guide for Convai integration.
- [Narrative Design Guide](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/narrative-design-guide.md): Narrative Design - Narrative based NPCs with convai on web.
- [Narrative Design Triggers](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/narrative-design-guide/narrative-design-triggers.md)
- [Narrative Design Keys](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/narrative-design-guide/narrative-design-keys.md): This guide shows how to dynamically pass variables to Narrative Design section and triggers
- [GLB Characters for Convai](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/glb-characters-for-convai.md): Discover how to use GLB characters with Convai's web plugin for immersive virtual experiences.
- [GLB/FBX animations for Convai](https://docs.convai.com/api-docs/plugins-and-integrations/web-plugins/glb-fbx-animations-for-convai.md): Learn to integrate GLB and FBX animations into Convai's web plugin for dynamic character actions.
- [Modding Framework](https://docs.convai.com/api-docs/plugins-and-integrations/modding-framework.md): Convai introduces a Modding Framework, enabling easy integration of AI-driven NPCs into games across engines like Unreal, Unity, and more.
- [Modding Cyberpunk 2077](https://docs.convai.com/api-docs/plugins-and-integrations/modding-framework/modding-cyberpunk-2077.md): This guide will show you how to make Mods that add Convai's features to Cyberpunk 2077
- [Other Integrations](https://docs.convai.com/api-docs/plugins-and-integrations/other-integrations.md)
- [Roblox](https://docs.convai.com/api-docs/plugins-and-integrations/other-integrations/roblox.md): Integrating Convai character chatbot services in Roblox game.
- [Sample Game 1](https://docs.convai.com/api-docs/plugins-and-integrations/other-integrations/roblox/sample-game-1.md): Interact with the character in a simple implementation from Convai
- [Sample Game 2](https://docs.convai.com/api-docs/plugins-and-integrations/other-integrations/roblox/sample-game-2.md): Interact with an intelligent character in a different environment and explore it.
- [Code Example](https://docs.convai.com/api-docs/plugins-and-integrations/other-integrations/roblox/code-example.md): API Request code from Roblox
- [Character Conversation API](https://docs.convai.com/api-docs/plugins-and-integrations/other-integrations/roblox/code-example/character-conversation-api.md): Character Conversation API - Code Example for Roblox integration with Convai.
- [Discord](https://docs.convai.com/api-docs/plugins-and-integrations/other-integrations/discord.md): Integrating Convai Character with Discord Bot
- [Create a Discord Bot](https://docs.convai.com/api-docs/plugins-and-integrations/other-integrations/discord/create-a-discord-bot.md): Create your own Discord Bot to share with people in various servers.
- [Hosting Discord Bot from Personal Server](https://docs.convai.com/api-docs/plugins-and-integrations/other-integrations/discord/hosting-discord-bot-from-personal-server.md): Successfully host a Discord Bot server connected with Convai API
- [Hosting Discord Bot from Replit](https://docs.convai.com/api-docs/plugins-and-integrations/other-integrations/discord/hosting-discord-bot-from-replit.md): Successfully host a Discord Bot server connected with Convai API from Replit
- [Omniverse Extension](https://docs.convai.com/api-docs/plugins-and-integrations/other-integrations/omniverse-extension.md): This guide will show you how to integrate the Convai and NVIDIA Omniverse using the Convai Extension plugin.
- [Third-Party API Integrations](https://docs.convai.com/api-docs/plugins-and-integrations/other-integrations/third-party-api-integrations.md): Integrate external APIs like ElevenLabs to enhance your applications with advanced features.
- [ElevenLabs API Integration](https://docs.convai.com/api-docs/plugins-and-integrations/other-integrations/third-party-api-integrations/elevenlabs-api-integration.md): This is a guide on how to integrate your ElevenLabs voices with Convai characters
- [Convai Pixel Streaming Embed](https://docs.convai.com/api-docs/plugins-and-integrations/convai-pixel-streaming-embed.md)
- [Whitelisting & Publishing an Experience](https://docs.convai.com/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/whitelisting-and-publishing-an-experience.md): Learn how to publish your scene and whitelist domains to embed Convai experiences securely in your web application.
- [React Typescript](https://docs.convai.com/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/react-typescript.md): Set up and integrate Convai's Pixel Streaming component in your React TypeScript app using @convai/experience-embed.
- [ReactJS (JavaScript)](https://docs.convai.com/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/reactjs-javascript.md): Integrate Convai's Pixel Streaming into your React JavaScript app using the @convai/experience-embed component.
- [Vanilla JavaScript (ES Modules)](https://docs.convai.com/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/vanilla-javascript-es-modules.md): Use Convai's Pixel Streaming client directly in browser-based JavaScript apps with native ES module support.
- [CDN (UMD Script)](https://docs.convai.com/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/cdn-umd-script.md): Integrate Convai's Pixel Streaming into your web app using the UMD build directly from a CDN
- [On Premise Deployment](https://docs.convai.com/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/on-premise-deployment.md): Configure Convai’s Pixel Streaming client to connect with your own backend and streaming servers for on-premise or self-hosted deployments.
- [API Reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/api-reference.md): Explore the available props, options, and methods for using Convai's Pixel Streaming client across React, Vanilla JS, TypeScript, and CDN setups.
- [Asset Uploader](https://docs.convai.com/api-docs/plugins-and-integrations/asset-uploader.md): Upload Metahumans, Reallusion characters, and scenes from Unreal Engine to Convai Sim and Avatar Studio using the Convai Asset Uploader tool.
- [Migrate Your Unreal Engine 5.5 Convai Assets to 5.8](https://docs.convai.com/api-docs/plugins-and-integrations/asset-uploader/migrate-your-unreal-engine-5.5-convai-assets-to-5.8.md): Migrate an existing Unreal Engine 5.5 Convai asset project to the current supported Unreal Engine version using the Asset Uploader tool.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.convai.com/api-docs/plugins-and-integrations.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.