# Plugins & Integrations

- [Introduction](https://docs.convai.com/api-docs/plugins-and-integrations/introduction.md): Introduction to Convai's plugins and integrations. Learn how to enhance your projects with AI.
- [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 connectivity requirements, including required domains, protocols, ports, and firewall rules for runtime operation.
- [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): System requirements, Unity version, required packages, and account prerequisites for the Convai Unity SDK.
- [Install the Convai Unity SDK](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/installation.md): Add the Convai Unity SDK to your Unity 2023.1+ project via the Package Manager or Asset Store. Both methods install the identical package.
- [Configure the API key](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/configure-api-key.md): Enter your Convai API key in the SDK settings to authenticate your project and enable character communication.
- [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): Learn the role of ConvaiManager, ConvaiRoomManager, ConvaiCharacter, and ConvaiPlayer, 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): Run the scene validation tool to confirm all required components are present, connected, and configured correctly.
- [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, and configure the trigger key or button for your project.
- [Configure character audio](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/configure-character-audio.md): Set character voice volume, enable spatial audio, and control NPC playback through the ConvaiAudio facade for scripted mute and unmute.
- [Configure microphone](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/configure-microphone.md): Select the active microphone device and configure platform-specific 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 a transcript UI component to display conversation text 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 to synchronize mouth movement with speech.
- [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 two ScriptableObject types — profiles and maps — that control how Convai blendshape data reaches your character's SkinnedMeshRenderer.
- [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 ConvaiLipSyncMapAsset to route stream blendshape channels to your character's actual SkinnedMeshRenderer blendshape names, with per-channel multiplier and clamp tuning.
- [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 — connection management, session state, turn-taking, and event-driven scene responses.
- [Runtime architecture](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/runtime-architecture.md): Understand the four-layer Convai Unity SDK runtime — what each layer owns, which components are replaceable, and how RuntimeState transitions 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, where session IDs are stored, and how to configure reconnection and conversation-resume behavior.
- [Turn-taking modes](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts/turn-taking-modes.md): Reference for TurnTakingOptions, SmartTurnSettings, and PushToTalkPolicy — field reference for hands-free voice detection and push-to-talk modes.
- [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 — available events, payload fields, subscription patterns, and the ConvaiNotificationEventBridge service.
- [Features](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features.md)
- [Character actions](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions.md): Find quick-start guides, executor references, dispatcher configuration, scripting API, and usage examples for the Convai character actions system.
- [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 the backend 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 working Move To action to your NPC using ConvaiActionConfigSource, ConvaiActionDispatcher, and TransformMoveToActionExecutor without writing any scripts.
- [Configure character actions](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/configuring-actions.md): Reference for ConvaiActionConfigSource — action definitions, target objects, actionable characters, and scripted connect-time overrides.
- [Action executors](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/action-executors.md): Reference for all six action executor components — look-at, event, NavMesh movement, animation trigger, and compound pickup executors.
- [Write a custom action executor](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/writing-custom-executors.md): Implement IConvaiActionExecutor on a MonoBehaviour to connect custom movement, inventory, UI, or physics behaviors to the Convai action pipeline.
- [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 ConvaiActionDispatcher's batch policy, failure policy, and lifecycle events, and inject action batches programmatically for testing or scripted sequences.
- [Attention and reference grounding](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/attention-and-reference-grounding.md): Update NPC focus at runtime so Convai resolves vague player references such as "pick that up" or "go to it" to the correct registered scene object.
- [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 — dispatcher types, executor interface, config classes, invocation objects, result types, 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 navigation error recovery.
- [Troubleshoot character actions](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/character-actions/debugging-and-troubleshooting.md): Diagnose action pipeline issues using ConvaiActionDebugProbe's Inspector counters and test batch injection — with a complete symptom/cause/fix reference for common failures.
- [Dynamic context](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context.md): Find all Dynamic Context guides — feed live state and events to characters from Inspector or C# and verify context-aware dialogue.
- [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 the states and events model, canonical context format, and how updates queue and flush before and during conversations.
- [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 ConvaiDynamicContextCommand to an NPC, configure a SetState command, and confirm the character acknowledges live scene conditions.
- [Command component reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/command-component-reference.md): Complete field-by-field reference for ConvaiDynamicContextCommand — all six command types, reaction modes, validation warnings, and multi-command child GameObject patterns.
- [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 InitialDynamicInfoText and InitialDynamicInfoKeepInContext on ConvaiCharacter to send fixed scenario facts once at the start of each conversation.
- [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 transmits Replace, Append, and Reset messages for each Dynamic Context operation, including queueing and Apply() behavior.
- [Dynamic context scripting API](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/dynamic-context-scripting-api.md): API reference for IConvaiDynamicContext — all seven method signatures, default parameters, pre-conversation queueing behavior, and Apply() caveats.
- [Dynamic context usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/dynamic-context-usage-examples.md): Four Dynamic Context examples covering a safety drill, an onboarding walkthrough, a guided tour with timeline events, and a multi-state emergency transition.
- [Troubleshoot dynamic context](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/dynamic-context/troubleshoot-dynamic-context.md): Diagnose Dynamic Context issues with a five-step checklist, a symptom table, a character-not-responding decision tree, and the full Console log reference.
- [Emotion](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion.md): Find guides for adding emotionally responsive facial animation to Convai characters — from quick setup to scripting API and troubleshooting.
- [How the emotion system works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/how-the-emotion-system-works.md): Understand the emotion pipeline — how Convai sends emotion signals, how the SDK resolves and smooths them, and which components to place and where.
- [Emotion quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/quick-start.md): Build a working emotion pipeline on a Convai NPC — attach the Emotion Controller, assign the bundled sample profile, and verify expressions in Play Mode.
- [Emotion profile](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/emotion-profile.md): Reference for ConvaiEmotionProfile, including smoothing speed, micro-burst settings, neutral alternation, and output binding configuration.
- [Emotion output bindings](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/output-bindings.md): Reference for EmotionSlotBinding and the two binding types — field ranges, weight calculation, isMouthShape routing, and the pre-built slot factory.
- [Emotion taxonomy](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/emotion-taxonomy.md): Reference for EmotionTaxonomyAsset, including the built-in Plutchik set, server alias resolution, and custom taxonomy authoring.
- [Emotion scripting API](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/scripting-api.md): Reference for the emotion scripting surface — ConvaiEmotionController, EmotionReading, override and lock methods, C# events, and IEmotionStateSource.
- [Emotion examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/usage-examples.md): Six complete scenarios covering hazard overrides, locked expressions, distress branching, analytics logging, no-code UI wiring, and Editor authoring.
- [Troubleshoot emotion](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/emotion/troubleshooting-and-diagnostics.md): Fix common emotion pipeline failures in the Convai Unity SDK — from missing output and silent neutral fallback to LipSync conflicts and locked expressions.
- [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 and verify cross-session recall in the Unity Editor in three steps.
- [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 Configuration Window or via the EndUsersService scripting API — covers the editor tool, all four methods, 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): Use ConvaiRestClient.Memory to list, add, retrieve, and delete memory records for a user–character pair — includes setup, all five methods, response types, and error handling.
- [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 API reference for ConvaiRestClient.Memory and ConvaiRestClient.EndUsers — all method signatures, parameters, return types, identity interfaces, and data models.
- [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.
- [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 IConvaiNarrativeDesign, including section events, trigger invocation, speech injection, template keys, and async fetch methods.
- [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 ConvaiObjectMetadata to scene objects and configure ConvaiSceneMetadataCollector so a Convai character receives object awareness at session start.
- [Scene metadata component reference](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/component-reference.md): Reference for ConvaiObjectMetadata and ConvaiSceneMetadataCollector, including Inspector fields, lifecycle events, validation rules, and dependency injection behavior.
- [Scene metadata scripting API](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/features/scene-metadata/scripting-api-reference.md): Reference for ConvaiMetadataRegistry and ConvaiSceneMetadataCollector, including static events, manual trigger patterns, and debug utilities.
- [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, phase-based industrial drills, museum guides, and runtime object inclusion and exclusion.
- [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, the publish coordinator, the WebRTC track to Convai, and the startup sequence.
- [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): Reference for VisionDebugPreview, including Inspector fields, statistics overlay output, and script access for verifying the live feed in the Editor.
- [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 ConvaiVisionPublisher and the frame source interfaces, including properties, methods, domain events, and state monitoring patterns.
- [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, overhead cameras, look-at activation, 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.
- [Utilities](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/utilities.md): Opt-in presentation modules that enhance character animation, eye tracking, and head movement — running entirely in Unity with no data sent to Convai.
- [Dialogue Animation](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation.md): Drive body and head gesture animation from dialogue state and emotion using a pooled clip library and an AnimatorOverrideController — no per-clip animator states required.
- [How Dialogue Animation works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/how-dialogue-animation-works.md): Understand how Dialogue Animation selects clips, drives the four-layer animator stack, and uses emotion and dialogue state to animate AI characters.
- [Dialogue Animation quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/quick-start.md): Add ConvaiDialogueAnimationController to a character, assign a library and runtime config, and verify gesture animation in Play Mode.
- [Animation libraries and profiles](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/animation-libraries-and-profiles.md): Complete field reference for all Dialogue Animation ScriptableObject assets — library, clip entries, runtime config, and bundled profiles.
- [Animator Controller requirements](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/animator-controller-requirements.md): Dialogue Animation Animator Controller contract — required layer structure, state names, placeholder clip names, and DialogueAnimatorContract fields.
- [Build a compatible Animator Controller](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/animator-controller-setup.md): Build a compatible four-layer Animator Controller from scratch so the Dialogue Animation module can inject and swap gesture clips at runtime.
- [Dialogue Animation usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/usage-examples.md): Four progressive examples — from Inspector-only setup to runtime library swapping — covering training, medical, corporate, and adaptive assessment scenarios.
- [Dialogue Animation scripting API](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/scripting-api.md): Runtime scripting reference for ConvaiDialogueAnimationController — swap libraries and configs at runtime, and read current layer weights and clip selection state.
- [Dialogue Animation troubleshooting](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/dialogue-animation/troubleshooting.md): Symptom-driven fixes for silent talk layers, missing animations, clip snapping, layer index errors, and speech energy issues in the Dialogue Animation module.
- [Gaze and Attention](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention.md): Two-system pipeline for natural eye and head behavior — Attention selects focus targets, Gaze drives procedural eye tracking, head rotation, saccades, and blinks.
- [How Gaze and Attention works](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/how-gaze-and-attention-works.md): Understand the two-layer pipeline where Attention selects focus targets and Gaze drives procedural eye tracking, head rotation, and saccades.
- [Gaze and Attention quick start](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/quick-start.md): Add ConvaiAttentionController, ConvaiEyeGazeActuator, and ConvaiHeadLookActuator to a character, assign profiles, and verify eye and head tracking in Play Mode.
- [Attention and gaze profiles](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/profiles-and-tuning.md): Complete field reference for all four gaze profile ScriptableObjects — attention timing, gaze coordination, eye behavior, and head rotation.
- [Gaze and Attention usage examples](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/usage-examples.md): Four progressive examples of Gaze & Attention configuration — from basic Inspector setup to custom IFocusTargetProvider implementations and attention profile tuning.
- [Gaze and Attention scripting API](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/scripting-api.md): Runtime scripting reference for ConvaiAttentionController, AttentionReading, IFocusTargetProvider, ConvaiGazeCoordinator, and GazeIntent.
- [Gaze and Attention troubleshooting](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk/utilities/gaze-and-attention/troubleshooting.md): Fixes for the 13 most common Gaze & Attention issues — static eyes, frozen head, eyelid clipping, attention not targeting, and focus provider conflicts.
- [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): Display character and player transcripts using the built-in chat prefab, ITranscriptListener callbacks, or a custom ITranscriptUI implementation.
- [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): Query the conversation turn timeline from code — read committed turns, detect interruptions, and build post-session exports or live analytics.
- [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): Configure Chat mode's scrollable message bubbles or Subtitle mode's auto-hiding overlay, switch between them at runtime, and add per-response feedback buttons to chat.
- [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 automatically display session error notifications and let you trigger custom in-scene alerts from code using ScriptableObject 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 mode, 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): Pull-based API reference for ConvaiTranscripts — query, filter, and subscribe to the live in-memory transcript timeline from C# scripts.
- [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): Configure and validate the Convai Unity SDK for WebGL — covers HTTPS requirements, browser audio gesture handling, Vision canvas capture, and the known lip-sync drift defect.
- [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 SDK providers, extend the runtime with custom modules, and diagnose latency using built-in telemetry — for deployments where the defaults are not enough.
- [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 PlayerPrefs session storage with a cloud backend, encrypted file store, or in-memory implementation by implementing IKeyValueStore or IPersistenceProvider.
- [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 troubleshooting guides for installation errors, API issues, audio failures, and debug tools in the Convai Unity SDK.
- [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, missing dependencies, assembly errors, and bootstrapper startup warnings with step-by-step remediation.
- [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 logging configuration, ConvaiActionDebugProbe, session diagnostics, and client latency metrics.
- [Unreal Engine Plugin (Beta) Overview](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine-plugin-beta-overview.md): Explore the Convai Unreal Plugin Beta — built on the new Convai backend to deliver hands-free, low-latency, and vision-enabled AI character interactions in Unreal Engine.
- [Installation and Setup | Unreal Engine](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine-plugin-beta-overview/installation-and-setup.md): Learn how to install, configure, and integrate the Convai Unreal Plugin Beta to bring conversational AI and real-time vision into your Unreal Engine projects.
- [Dynamic Context inside Unreal Engine](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine-plugin-beta-overview/dynamic-context-inside-unreal-engine.md): Give AI characters real-time awareness of game state, player actions, and environment using Dynamic Context.
- [Convai Actions](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine-plugin-beta-overview/convai-actions.md)
- [Phase 1: Default Actions](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine-plugin-beta-overview/convai-actions/phase-1-default-actions.md)
- [Phase 2: Custom Actions](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine-plugin-beta-overview/convai-actions/phase-2-custom-actions.md)
- [Phase 3: Parameterized Actions](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine-plugin-beta-overview/convai-actions/phase-3-parameterized-actions.md)
- [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)
- [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.
- [Unity Plugin (Beta) Overview](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview.md): Discover the all-new Convai Unity Plugin Beta — redesigned from the ground up for faster, more immersive, and hands-free AI character experiences in Unity.
- [Compatibility & Requirements](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/compatibility-and-requirements.md): Supported Unity versions, render pipelines, and target platforms for the Convai Unity SDK.
- [Getting Started with Unity Plugin](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started.md): Get the Convai Unity SDK installed, configured, and verified with a quick conversation test.
- [Installation](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/installation.md): Choose an installation method and add the Convai Unity SDK to your project.
- [Install via UPM](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/installation/install-via-upm.md): Install the Convai Unity SDK via the Unity Package Manager using the package name.
- [Install via Unity Asset Store](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/installation/install-via-unity-asset-store.md): Install the Convai Unity SDK from the Unity Asset Store.
- [Install via Unity Package](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/installation/install-via-unity-package.md): Install the Convai Unity SDK by importing a .unitypackage release build.
- [Setup](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup.md): Configure credentials and choose how you want to test Convai: samples or your own scene.
- [Configure API Key](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/configure-api-key.md): Add your Convai API key in Unity to enable the SDK.
- [Import & Run Sample Scenes](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/import-and-run-sample-scenes.md): Import Convai sample content and run a scene to test a conversation immediately.
- [Custom Scene Setup](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/custom-scene-setup.md): Add the Convai Manager, set up a player, and connect characters to Convai.
- [Add Chat UI (Transcript UI)](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/add-chat-ui-transcript-ui.md): Add a ready-made chat UI prefab to enable text input and conversation transcripts.
- [Add Lip Sync to Your Character](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/add-lip-sync-to-your-character.md): Learn how to add and configure the Convai Lip Sync component on your character, assign profiles and maps, configure playback and latency settings, and verify real-time facial animation in Unity.
- [Lip Sync Profiles and Mappings](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/add-lip-sync-to-your-character/lip-sync-profiles-and-mappings.md): Learn how Convai Lip Sync uses profiles and maps to drive real-time facial blendshape animation, how built-in defaults work, and when to create custom assets.
- [Creating a Profile](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/add-lip-sync-to-your-character/lip-sync-profiles-and-mappings/creating-a-profile.md): Create and register a custom Lip Sync profile in Unity, understand profile fields, and configure supported transport formats for your project.
- [Creating a Custom Map](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/add-lip-sync-to-your-character/lip-sync-profiles-and-mappings/creating-a-custom-map.md): Create a custom Lip Sync map, understand the Map Inspector, and connect supported profile channels to your character's blendshapes in Unity.
- [Migration Guide](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/migration-guide.md): Convai Plugin 3.3.4 to 4.0.0
- [Additional Feature Migration](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/migration-guide/additional-feature-migration.md)
- [Features](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features.md)
- [Actions](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/actions.md): Give AI characters the ability to act on what players say. Covers the complete Action system — architecture, configuration, executors, and runtime control.
- [Quick Start](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/actions/quick-start.md): A step-by-step walkthrough of your first working Convai Action — from adding components to testing a live command in Play Mode.
- [Configuring Actions](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/actions/configuring-actions.md): Define available actions, register scene objects and characters as targets, and configure executor bindings using ConvaiActionConfigSource.
- [Action Executors](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/actions/action-executors.md): A reference for every executor included in the SDK — behavior, configuration fields, and when to use each one.
- [Dispatcher & Batch Policies](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/actions/dispatcher-and-batch-policies.md): Control how the dispatcher sequences action batches, resolves command conflicts, and surfaces lifecycle events through its UnityEvent API.
- [Writing Custom Executors](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/actions/writing-custom-executors.md): Implement IConvaiActionExecutor to create any behavior your project requires — with full examples, cancellation handling, and compound action patterns.
- [Attention & Reference Grounding](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/actions/attention-and-reference-grounding.md): How the backend resolves vague player references — and how object descriptions and the current attention object shape target resolution.
- [Debugging & Troubleshooting](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/actions/debugging-and-troubleshooting.md): Identify and resolve Action pipeline issues using the built-in debug probe, console log reference, and diagnostic checklist.
- [Dynamic Context](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/dynamic-context.md): Inject live game state into a Convai character's awareness so it can reference environments, player actions, and simulation events naturally in dialogue.
- [Quick Start](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/dynamic-context/quick-start.md): A step-by-step walkthrough to your first working Dynamic Context integration — a character that knows where the player is standing, updated from a single button click.
- [Command Component Reference](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/dynamic-context/command-component-reference.md): Every field, command type, and event on the Dynamic Context Command component — the complete reference for driving character awareness from the Unity Inspector.
- [Static Context at Connection Time](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/dynamic-context/static-context-at-connection-time.md): Establish what your character knows before the first word is spoken — a fixed scenario description that persists for the entire conversation.
- [Usage Examples](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/dynamic-context/usage-examples.md): Four complete simulation scenarios — a safety drill, an onboarding walkthrough, a guided tour, and an emergency transition — each demonstrating a different context strategy.
- [Scripting API Reference](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/dynamic-context/scripting-api-reference.md): Complete reference for every method, parameter, and return value on the Dynamic Context scripting interface — for developers driving character awareness from game code.
- [Sync Behavior and Timing](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/dynamic-context/sync-behavior-and-timing.md): A precise explanation of when context updates reach the character, what happens before a conversation starts, and how the SDK decides what to send.
- [Troubleshooting & Diagnostics](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/dynamic-context/troubleshooting-and-diagnostics.md): Diagnose the most common Dynamic Context issues — from characters that ignore context updates to unexpected behavior after a session reset.
- [Emotion](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/emotion.md): How the Emotion system works, what each component does, and where to go next — the starting point for adding facial emotion to any Convai character.
- [Quick Start](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/emotion/quick-start.md): A step-by-step setup walkthrough that ends with a Convai character reacting emotionally to live conversation.
- [Emotion Profile](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/emotion/emotion-profile.md): Every configurable parameter in one place — how quickly expressions rise and fall, how micro-bursts add naturalism, and how neutral alternation prevents frozen faces.
- [Output Bindings](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/emotion/output-bindings.md): Map each emotion to the specific facial shapes or Animator parameters on your character's rig, with per-slot weight and LipSync coordination.
- [Emotion Taxonomy](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/emotion/emotion-taxonomy.md): The emotion vocabulary that connects backend labels to your character's expressions — how it works, what the built-in set includes, and how to extend it.
- [Scripting API Reference](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/emotion/scripting-api-reference.md): Read live emotion state, drive expressions from code, react to emotion events, and lock characters to specific moods during scripted sequences.
- [Usage Examples](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/emotion/usage-examples.md): Worked scenarios that show the Emotion system in action: hazard responses, scripted greetings, adaptive branching, analytics, and authoring workflows.
- [Troubleshooting & Diagnostics](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/emotion/troubleshooting-and-diagnostics.md): Step-by-step fixes for the most common Emotion system problems — from expressions that will not move to LipSync conflicts and production build gotchas.
- [Long-Term Memory](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/long-term-memory.md): Give your Convai characters persistent memory of individual users across sessions. Understand how the feature works and navigate the full reference documentation.
- [Quick Start](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/long-term-memory/quick-start.md): Enable memory on a character and verify cross-session recall using the Convai dashboard and the Unity Editor.
- [End-User Identity](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/long-term-memory/end-user-identity.md): Learn how the SDK identifies users across sessions and how to replace the default device-based provider with your own account-scoped identity system.
- [Enabling Memory on Characters](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/long-term-memory/enabling-memory-on-characters.md): Enable or disable Long-Term Memory per character using the Convai dashboard or the CharacterService scripting API. Off by default — opt in explicitly.
- [Memory Management API](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/long-term-memory/memory-management-api.md): Add, list, retrieve, and delete individual memory records for any user–character pair programmatically using the MemoryService scripting API.
- [End-User Management](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/long-term-memory/end-user-management.md): Browse and manage end-user records using the Configuration Window or the EndUsersService API. Includes pagination, metadata editing, and safe deletion.
- [Usage Examples](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/long-term-memory/usage-examples.md): Complete, working code for four common Long-Term Memory scenarios: automatic persistence, account-scoped identity, memory seeding before first session, and targeted resets.
- [Troubleshooting & Diagnostics](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/long-term-memory/troubleshooting-and-diagnostics.md): Diagnose why Long-Term Memory is not persisting, resolve identity and API errors, and verify stored memories at runtime with built-in diagnostic tools.
- [Narrative Design](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/narrative-design.md): Structured narrative graphs for Convai AI characters — how sections, triggers, and template keys converge at runtime to create state-aware experiences that adapt to every player action.
- [Quick Start](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/narrative-design/quick-start.md): Walk through the complete Inspector-first setup — Manager, Trigger, and collider zone — and trace the full signal path from player interaction through to a confirmed section change in Play Mode.
- [Setting Up the Narrative Design Manager](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/narrative-design/setting-up-the-narrative-design-manager.md): Everything ConvaiNarrativeDesignManager controls — section syncing, per-section Unity Events, global transition callbacks, and the sync status fields that confirm what the dashboard returned.
- [Setting Up Narrative Design Triggers](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/narrative-design/setting-up-narrative-design-triggers.md): ConvaiNarrativeDesignTrigger's four activation modes — Collision, Proximity, TimeBased, Manual — examined in full, alongside the queue system, TriggerStatus states, and per-trigger Unity Events.
- [Template Keys: Dynamic Narrative Variables](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/narrative-design/template-keys-dynamic-narrative-variables.md): Inject runtime values into the character's narrative objectives using key-value pairs — from the Inspector or code — with automatic delivery on session open and reconnect.
- [Scripting Narrative Design](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/narrative-design/scripting-narrative-design.md): The complete C# surface of Narrative Design — IConvaiNarrativeDesign events, InvokeTrigger, InvokeSpeech with speak tags, async section fetching, and runtime trigger reconfiguration.
- [Usage Examples](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/narrative-design/usage-examples.md): Four worked examples at increasing complexity — from a single-trigger welcome sequence to an adaptive multi-section scenario — showing how to compose Narrative Design components in practice.
- [Troubleshooting & Diagnostics](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/narrative-design/troubleshooting-and-diagnostics.md): Resolve every TriggerStatus state, common Inspector misconfiguration, fetch failure, and queue timeout using the built-in validation tools, diagnostic logger, and PrintDiagnostics output.
- [Vision](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/vision.md): Enable Convai characters to perceive and respond to your Unity scene in real time. Overview of the Vision feature, its components, and platform support.
- [Quick Start](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/vision/quick-start.md): The fastest path to a working Vision setup. Add a frame source and publisher from the Inspector, verify the stream, and understand what happens at runtime.
- [Frame Sources](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/vision/frame-sources.md): Select and configure the right frame source for your platform. Covers all Inspector fields, capture presets, platform requirements, and source state diagnostics.
- [Publishing & Policies](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/vision/publishing-and-policies.md): Control how Vision frames are delivered to the backend. Covers publish policies, frame rate and bitrate configuration, and manual publishing control.
- [Debug Preview](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/vision/debug-preview.md): Verify Vision capture in the Unity Editor with a live overlay showing the active frame source, capture statistics, and source state.
- [Usage Examples](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/vision/usage-examples.md): Four end-to-end Vision configurations covering scene cameras, physical webcams, Meta Quest passthrough, and manual-trigger publishing workflows.
- [Advanced Topics](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/vision/advanced-topics.md): Scripting API reference, custom frame source implementation, domain events, WebGL platform behaviour, and cross-platform compatibility.
- [Troubleshooting & Diagnostics](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/features/vision/troubleshooting-and-diagnostics.md): Diagnose and resolve Vision issues — publishing failures, blank feeds, permission errors, and platform-specific problems — using a structured checklist and decision tree.
- [Mixed Reality AI Characters with Vision (Meta Quest)](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/mixed-reality-ai-characters-with-vision-meta-quest.md): Build a Convai-powered AI character that runs in a Meta Quest passthrough Mixed Reality app and can see and describe the real world around the user through the Quest camera.
- [Dynamic Context](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/dynamic-context.md): Learn how Dynamic Context enables more relevant, adaptive, and context-aware AI character interactions.
- [Use Cases](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/dynamic-context/use-cases.md): Explore practical use cases for Dynamic Context and learn how it improves character responsiveness, relevance, and contextual awareness in conversations.
- [Installation and Setup](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/installation-and-setup.md): Learn how to install, set up, and run the Convai Unity Plugin Beta to integrate conversational AI characters directly within your Unity projects.
- [Dynamic Context](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/dynamic-context-1.md): Learn how Dynamic Context enables more relevant, adaptive, and context-aware AI character interactions.
- [Use Cases](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/dynamic-context-1/use-cases.md): Explore practical use cases for Dynamic Context and learn how it improves character responsiveness, relevance, and contextual awareness in conversations.
- [Unity Plugin](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin.md): Integrate advanced conversational AI to create intelligent, interactive NPCs for your games.
- [Pre-Requisites](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/pre-requisites.md): Review the prerequisites for integrating Convai with Unity. Ensure seamless setup and functionality.
- [Compatibility](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/compatibility.md): Check Convai plugin compatibility with Unity. Ensure smooth integration with your development tools.
- [Downloads](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/downloads.md): Download Convai tools for Unity. Access the latest plugins and updates for AI integration.
- [Limitations of WebGL Plugin](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/downloads/limitations-of-webgl-plugin.md): Understand the limitations of the WebGL plugin for Unity with Convai. Optimize your development.
- [Setting Up Unity Plugin](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/setting-up-unity-plugin.md): Follow these instructions to setup the Unity Plugin into your project.
- [Import and Setup (nightly)](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/import-and-setup.md): Follow these steps to import and configure the Unity SDK.
- [Troubleshooting Guide](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/troubleshooting-guide.md): Troubleshoot common issues with Convai's Unity plugin. Get solutions for seamless AI integration.
- [Disable Assembly Validation](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/troubleshooting-guide/enabled-assembly-validation.md)
- [Missing Newtonsoft Json](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/troubleshooting-guide/missing-newtonsoft-json.md): Fix missing Newtonsoft JSON issues in Unity with Convai. Resolve integration problems efficiently.
- [Microphone Permission Issues](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/troubleshooting-guide/microphone-permission-issues.md): Resolve microphone permission issues in Unity with Convai. Ensure smooth voice interactions.
- [Default Animations Incompatibility](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/troubleshooting-guide/default-animations-incompatibility.md): Fix default animation incompatibilities in Unity with Convai. Ensure smooth AI character animations.
- [Animations have Facial Blendshapes](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/troubleshooting-guide/animations-have-facial-blendshapes.md): Resolve facial blendshape issues in Unity animations with Convai. Improve character realism.
- [Jaw Bone in Avatar is not Free](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/troubleshooting-guide/jaw-bone-in-avatar-is-not-free.md): Fix jaw bone issues in Unity avatars with Convai. Ensure smooth lip sync and animations.
- [macOS Permission Issues](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/troubleshooting-guide/macos-permission-issues.md): macOS security permission issue with custom DLLs in Unity and Mac Configuration in build settings
- [Creating a Convai Powered Scene from Template](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/creating-a-convai-powered-scene-from-template.md): This guide will help you make a scene in unity with Convai Essentials already present in it. It will help you to get started with our plugin very fast.
- [Importing Ready Player Me (RPM) Characters](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/unity-importing-ready-player-me-rpm-characters.md): This guide walks you through the process of importing Ready Player Me (RPM) characters into a Convai-powered Unity project, configuring them, and integrating Convai NPC components.
- [Importing Custom Characters](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/importing-custom-characters.md): Follow these instructions to set up your imported character with Custom Model with Convai.
- [Adding Actions to your Character](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/adding-actions-to-your-character.md): Follow these instructions to enable actions for your Convai-powered characters.
- [Adding Lip-Sync to your Character](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/adding-lip-sync-to-your-character.md): Learn to add lip sync to your Unity characters using Convai. Improve realism and interactivity.
- [Adding Narrative Design to your Character](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/adding-narrative-design-to-your-character.md): Follow this guide to incorporate Narrative Design into your Convai-powered characters. Follow this step-by-step tutorial, open your project, and let's begin!
- [Narrative Design Keys](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/adding-narrative-design-to-your-character/narrative-design-keys.md): This guide shows how to dynamically pass variables to the Narrative Design section and triggers.
- [Adding NPC to NPC Conversation](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/adding-npc-to-npc-conversation.md): This guide will walk you through setting up the NPC to NPC conversation feature in the Convai SDK.
- [Adding Scene Reference and Point-At Crosshairs](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/adding-scene-reference-and-point-at-crosshairs.md)
- [Utilities](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/utilities.md): Unity Plugin Utilities - Enhance development with Convai's tools and resources.
- [Character Emotion](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/utilities/character-emotion.md): In this guide, we learn about character emotion coming from server
- [Player Data Container](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/utilities/player-data-container.md): All the information that Convai SDK needs from the player to work properly
- [Long Term Memory | Unity](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/utilities/long-term-memory.md): Learn how to enable character retain conversation history across multiple sessions
- [Language Support](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/utilities/language-support.md)
- [Managing sessionID Locally](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/utilities/managing-sessionid-locally.md): Session ID Management - Manage unique session IDs for Convai Unity integration.
- [Transcript UI System](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/utilities/transcript-ui-system.md): Transcript UI System - Integrate transcript UI with Convai's Unity plugin.
- [Pre-built UI Prefabs](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/utilities/convai-ui-prefabs.md): Convai UI Prefabs - Utilize ready-to-use UI elements for Convai integration.
- [Input Management](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/utilities/input-management.md): Input Management - Efficiently handle input for Convai's Unity plugin integration.
- [Notification System](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/utilities/notification-system.md): Notification System - Implement notifications with Convai Unity plugin utilities.
- [Settings Panel](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/utilities/settings-panel.md): Settings Panel - Customize settings using Convai's Unity plugin utilities.
- [Dynamic Information Context](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/utilities/dynamic-config.md)
- [Building For Supported Platforms](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/building-for-supported-platforms.md): With Convai's Unity SDK, you can build your favorite application for several platforms, including Windows, MacOS and Android. Currently, we also support these platforms:
- [Building for iOS/iPadOS](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/building-for-supported-platforms/building-for-ios-ipados.md): This guide will walk you through the process of installing Convai-powered Unity applications on iOS and iPadOS devices.
- [Building for WebGL](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/building-for-supported-platforms/building-for-webgl.md): This guide will help you integrate Convai's WebGL capabilities into your Unity projects, enabling you to bring to life AI characters with human-like conversational abilities.
- [Convai XR](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/building-for-supported-platforms/convai-xr.md)
- [Building for VR](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/building-for-supported-platforms/convai-xr/building-for-vr.md): VR development with Convai
- [VR Automatic Installation](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/building-for-supported-platforms/convai-xr/building-for-vr/vr-automatic-installation.md)
- [VR Manual Installation](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/building-for-supported-platforms/convai-xr/building-for-vr/vr-manual-installation.md)
- [Building for MR](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/building-for-supported-platforms/convai-xr/building-for-mr.md): MR development with Convai
- [MR Automatic Installation](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/building-for-supported-platforms/convai-xr/building-for-mr/mr-automatic-installation.md): Automatic Installation Steps
- [MR Manual Installation](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/building-for-supported-platforms/convai-xr/building-for-mr/mr-manual-installation.md)
- [Building for AR](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/building-for-supported-platforms/convai-xr/building-for-ar.md): Building for AR - Unity Plugin Guide for AR development with Convai.
- [Interacting with XR UI Elements](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/building-for-supported-platforms/convai-xr/interacting-with-xr-ui-elements.md)
- [Building for macOS Universal apps](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/building-for-supported-platforms/microphone-permission-issue-on-intel-macs-with-universal-builds.md)
- [Changelogs](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/changelogs.md): Convai Unity Plugin Changelogs - Stay updated with the latest changes.
- [Tutorials](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/tutorials.md)
- [Narrative Design | Unity](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/tutorials/narrative-design.md)
- [NPC2NPC](https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin/tutorials/npc2npc.md)
- [Unreal Engine](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine.md): Set up the Convai Unreal Engine plugin and add conversational AI to your apps.
- [Supported Platforms](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/supported-platforms.md): Convai Unreal Engine Plugin supports the following platforms.
- [Installation | Unreal Engine](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/installation.md): Install Convai plugin for Unreal Engine. Follow step-by-step instructions for Visual Studio and XCode setup.
- [Guides](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides.md): Here are some Guides to get you started.
- [Dynamic Environment Info](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/dynamic-environment-info.md): Transmit real-time environmental data to characters without requiring a response. Supported from Plugin Version 3.5.1.
- [Change AI Character Movement Speed](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/change-ai-character-movement-speed.md): Change AI Character Movement Speed - Unreal Engine Guide with Convai.
- [Integration with Pixel Streaming](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/integration-with-pixel-streaming.md): This mini-guide provides instructions for setting up Convai with pixel streaming in Unreal Engine
- [Adjust Interaction Radius](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/adjust-interaction-radius.md): Adjust Interaction Radius - Unreal Engine Guide for Convai integration.
- [Creating MetaHuman Characters](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/creating-metahuman-characters.md): This document explains how to create MetaHuman Characters with Convai Plugin.
- [Adding MetaHuman](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/creating-metahuman-characters/adding-metahuman.md): This document explains how to add MetaHuman to your project.
- [Adding LipSync to MetaHuman (From plugin version 3.0.0 or later )](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/creating-metahuman-characters/adding-lipsync-to-metahuman-from-plugin-version-3.0.0-or-later.md): Add lip sync to MetaHuman characters in Unreal Engine with Convai. Enhance realism and engagement.
- [Change the Parent Class for MetaHuman](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/creating-metahuman-characters/change-the-parent-class-for-metahuman.md): This enables AI conversational features to MetaHuman
- [Change the parent class for Player.](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/creating-metahuman-characters/change-the-parent-class-for-player..md): This gives the player the ability for conversation with the chat bot.
- [Adding LipSync to MetaHuman (Deprecated)](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/creating-metahuman-characters/adding-lipsync-to-metahuman.md): Adds lip animation to MetaHuman
- [Creating ReadyPlayerMe Characters](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/creating-metahuman-characters-1.md): This document explains how to create ReadyPlayerMe Characters with Convai Plugin.
- [Download Plugins](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/creating-metahuman-characters-1/adding-metahuman.md): This document explains how to add the Convai ReadyPlayerMe plugin to your project.
- [Adding ReadyPlayerMe Character](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/creating-metahuman-characters-1/adding-lipsync-to-metahuman.md)
- [Change the parent class for Player \[RPM\]](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/creating-metahuman-characters-1/change-the-parent-class-for-player-rpm.md): This gives the player the ability for conversation with the chat bot.
- [Creating Reallusion Characters](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/creating-reallusion-characters.md): This document explains how to create Reallusion Characters with Convai Plugin.
- [Creating a Reallusion Character](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/creating-reallusion-characters/creating-a-reallusion-character.md): This document explains how to create a Reallusion character with Character Creator 4.
- [Importing Reallusion character and setting up the Convai plugin](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/creating-reallusion-characters/importing-reallusion-character-and-setting-up-the-convai-plugin.md): This document explains how a Reallusion Character can be imported and used with the Convai Plugin.
- [Binding objects to Reallusion Character](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/creating-reallusion-characters/binding-objects-to-reallusion-character.md): This document explains how to bind objects to the Reallusion character and perform action with that object.
- [Event-Aware Convai Characters](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/event-aware-convai-characters.md): This document explains how to make characters respond to events happening in their surroundings with a small example.
- [Operations Based on the Presence of Certain Words](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/operations-based-on-the-presence-of-certain-words.md): This document explains how to detect words and perform certain operations based on it.
- [Narrative Design | Unreal Engine](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/narrative-design.md): Narrative Design - Enhance your Unreal Engine projects with Convai.
- [Narrative Design Trigger](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/narrative-design/narrative-design-trigger.md): Use Convai's Narrative Design Triggers in Unreal Engine to enhance your game stories.
- [Narrative Design Keys](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/narrative-design/narrative-design-keys.md): This guide shows how to dynamically pass variables to Narrative Design section and triggers
- [Actions Guide](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/actions-guide.md): This document describes how actions can be used/added to your Convai character, we will go about actions in multiple stages. This written guide is complementary the following tutorial video:
- [Stage 1: Default Actions](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/actions-guide/stage-1-default-actions.md): This stage explains how to use the default actions which come implemented out of the box with Convai.
- [Moves To](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/actions-guide/stage-1-default-actions/moves-to.md): This action enables a character to move to certain objects/characters present in its environment
- [Follows](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/actions-guide/stage-1-default-actions/follows.md): This action enables Convai character  to follow characters/objects/players present in its environment
- [Stage 2: Custom Actions](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/actions-guide/stage-2-custom-actions.md): This stage explains how to add simple custom actions with Convai characters.
- [Simple actions](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/actions-guide/stage-2-custom-actions/simple-actions.md): This document explains how to add simple actions to your Convai characters.
- [Adding Descriptions to Actions](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/actions-guide/stage-2-custom-actions/adding-descriptions-to-actions.md): Add Descriptions to Actions - Custom Actions Guide for Unreal Engine.
- [Stage 3: Custom Actions with Single Parameter](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/actions-guide/stage-3-custom-actions-with-single-parameter.md)
- [Main Character and Attention Object](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/actions-guide/main-character-and-attention-object.md): This page gives an overview of how to use set the Main character the AI is talking to and the Object In Attention
- [Customization](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/customization.md): This guide is for customization of the the blueprints.
- [Push to Talk](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/customization/push-to-talk.md): This document explains how to change the default push to talk key.
- [Alter Character Response Audio Rate](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/customization/alter-character-response-audio-rate.md): This document explains how to alter the character response audio rate.
- [Speech To Text Transcription](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/speech-to-text-transcription.md): In this page we will show a simple example of how to record and transcribe player voice.
- [Enable Multiplayer Support](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/enable-multiplayer-support.md): This guide explains how to enable Convai conversation and actions in multiplayer
- [3D Chat Widget](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/3d-chat-widget.md): This guide explains how to add a 3D chat widget to Convai Character
- [Long Term Memory | Unreal Engine](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/long-term-memory.md): This guide explains how to enable long term memory in Convai Character
- [Saving and Loading Session](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides/saving-and-loading-session.md): Allows NPCs to remember the conversations from a previous session and resume from where you left off, enhancing the continuity of interactions.
- [Blueprints Reference](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/blueprints-reference.md): Blueprints Reference - Comprehensive guide for Convai Unreal Engine integration.
- [Convai Player](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/blueprints-reference/convai-player.md): Actor component for the player
- [Convai Chatbot](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/blueprints-reference/convai-chatbot.md): Actor component for the AI character
- [Convai Environment](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/blueprints-reference/convai-environment.md): The Convai Environment class is used to define what actions are available for the character and what are the objects and other characters in the scene.
- [Convai Object Entry](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/blueprints-reference/convai-object-entry.md): The ConvaiObjectEntry structure parses information about a character or an object in the scene, which is then included in the Environment object.
- [Convai Result Action](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/blueprints-reference/convai-result-action.md): Convai Result Action - Blueprint Reference for Unreal Engine integration.
- [Convai Extra Params](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/blueprints-reference/convai-extra-params.md): Convai Extra Params - Blueprint Reference for Unreal Engine integration.
- [Speech To Text](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/blueprints-reference/speech-to-text.md): Speech-to-Text - Blueprint Reference for Convai Unreal Engine integration.
- [Text To Speech](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/blueprints-reference/text-to-speech.md)
- [Utility Functions](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/blueprints-reference/utility-functions.md): Utility Functions - Blueprint Reference for Convai Unreal Engine integration.
- [Troubleshoot Guide](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/troubleshoot-guide.md): This section focuses on troubleshooting Convai Unreal Engine plugin problems.
- [Missing Unreal Engine Tool Set in Microsoft Visual Studio Toolchain](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/troubleshoot-guide/missing-unreal-engine-tool-set-in-microsoft-visual-studio-toolchain.md): Primary reason for most of the Unreal Engine packaging issue with Convai Unreal Engine SDK.
- [Convai Module Not Found](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/troubleshoot-guide/convai-module-not-found.md): This problem arises when ConvaiOVRLipSync is not added to the project.
- [MetaHuman Plugin Conflict](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/troubleshoot-guide/metahuman-plugin-conflict.md): Conflicts with Convai arise when packaging a project containing the MetaHuman plugin in the editor.
- [Failure to Load Character IDs](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/troubleshoot-guide/failure-to-load-character-ids.md)
- [Microphone Settings](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/microphone-settings.md): This documentation describes how to test micrphone in Ureal Engine.
- [Set Audio Gain](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/microphone-settings/set-audio-gain.md): This document explains how to change the audio gain through blueprints in Unreal Engine.
- [Set Microphone](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/microphone-settings/set-microphone.md): This document explains how to set microphone through blueprints
- [Microphone test](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/microphone-settings/microphone-test.md): This document elucidates the procedures for testing your microphone using the settings widget that comes with the Convai plugin.
- [List Microphone Devices](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/microphone-settings/list-microphone-devices.md): This document explains how to list available microphone devices.
- [Mac Microphone Permission: Required for UE 5.0 and 5.3](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/mac-microphone-permission-required-for-ue-5.0-and-5.3.md): The Convai plugin requires microphone access in Unreal Engine (UE) 5.0 and 5.3 on macOS.
- [Guides V2 (Under Development)](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides-v2-under-development.md): Here are some Guides to get you started with integrating Convai in Unreal Engine.
- [Getting Started](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides-v2-under-development/getting-started.md): The following set of guides will help you make a simple project with Convai.
- [Installation](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides-v2-under-development/getting-started/download-and-setup.md): Easily install the Convai Plugin in Unreal Engine with our step-by-step guide. Set up your API key to add Convai to your Unreal Engine project.
- [Simple Talking Cube](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides-v2-under-development/getting-started/simple-talking-cube.md): A minimal from scratch example to get you familiar with the plugin main components.
- [Adding Premade Chat and Settings UI](https://docs.convai.com/api-docs/plugins-and-integrations/unreal-engine/guides-v2-under-development/getting-started/adding-premade-chat-and-settings-ui.md): Use a premade player blueprint that already contains a Chat and Settings widget.


---

# Agent Instructions: 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:

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

The question should be specific, self-contained, and written in natural language.
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.
