# 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. - [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. - [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) - [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. - [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) - [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/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) - [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. --- # 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= ``` 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.