{"version":1,"pages":[{"id":"pFMIlVh3aGhHqpINgQIU","title":"Welcome","pathname":"/api-docs","siteSpaceId":"sitesp_wqN6M","description":"Start here to create, customize, test, and share interactive AI characters with Convai, covering Playground, no-code experiences, plugins and integrations, and API reference."},{"id":"41Q0qvQwmIZYFETUyYIc","title":"Get Started","pathname":"/api-docs/convai-playground/get-started","siteSpaceId":"sitesp_wqN6M","description":"A guided overview of the first steps in Convai Playground, including navigation, character creation, testing, and essential global controls.","breadcrumbs":[{"label":"Convai Playground"}]},{"id":"pyJBFrVIlYqmEzXGRG74","title":"Dashboard Overview","pathname":"/api-docs/convai-playground/get-started/dashboard-overview","siteSpaceId":"sitesp_wqN6M","description":"Learn how to navigate and use the Convai Playground Dashboard to manage characters, experiences, and simulations efficiently.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"1agb1T1gwGFVdO5CH1P5","title":"Creating a New Character","pathname":"/api-docs/convai-playground/get-started/creating-a-new-character","siteSpaceId":"sitesp_wqN6M","description":"Learn how to create and customize a new AI character in Convai Playground, including description, avatar, voice, and language settings.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"DVUL91wEFtZZ6jBkbHTt","title":"Testing a Character","pathname":"/api-docs/convai-playground/get-started/testing-a-character","siteSpaceId":"sitesp_wqN6M","description":"Learn the different ways to test your AI character in Convai Playground, including text chat, voice input, and video call with an avatar.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"QC1r2g57kZyPjFX2SZzP","title":"Global Character Controls","pathname":"/api-docs/convai-playground/get-started/global-character-controls","siteSpaceId":"sitesp_wqN6M","description":"A single reference for the shared toolbar controls available across all character pages in Convai Playground, including Versioning, Update, and Character Settings.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"x0BSOwHlqiBM9Qw49zui","title":"Character Versioning","pathname":"/api-docs/convai-playground/get-started/character-versioning","siteSpaceId":"sitesp_wqN6M","description":"Manage multiple versions of character and switch between them as required.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"A7G2tHGNEZICB8Hu5zNr","title":"Interact in Voice Mode (Beta)","pathname":"/api-docs/convai-playground/get-started/interact-in-voice-mode-beta","siteSpaceId":"sitesp_wqN6M","description":"Enable real-time, low-latency voice conversations with your Convai character using Voice Mode for natural, hands-free interactions.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Get Started"}]},{"id":"j4sTdssjBd3tQtEEshBg","title":"Character Customization","pathname":"/api-docs/convai-playground/character-customization","siteSpaceId":"sitesp_wqN6M","description":"Learn how to refine your AI character’s personality, appearance, knowledge, and behavior to create consistent and engaging interactions.","breadcrumbs":[{"label":"Convai Playground"}]},{"id":"izmhrnoQkFUEhckJYF5w","title":"Character Description","pathname":"/api-docs/convai-playground/character-customization/character-description","siteSpaceId":"sitesp_wqN6M","description":"Learn how to use the Character Description page in Convai Playground to define your character’s identity, speaking style, and unique traits.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"xYNqL3nGQ6Yzl0agxI8q","title":"Avatar Studio","pathname":"/api-docs/convai-playground/character-customization/avatar-studio","siteSpaceId":"sitesp_wqN6M","description":"Learn how to access and customize your character’s avatar in Convai Playground using Avatar Studio.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"WEKrAcz1SyYUo9EnGJtq","title":"Language And Speech","pathname":"/api-docs/convai-playground/character-customization/language-and-speech","siteSpaceId":"sitesp_wqN6M","description":"Learn how to configure languages, voices, custom pronunciations, and word recognition for your AI character in Convai Playground.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"hoKnTfp2FxSbDLPI6C4k","title":"Knowledge Bank","pathname":"/api-docs/convai-playground/character-customization/knowledge-bank","siteSpaceId":"sitesp_wqN6M","description":"Learn how to upload, manage, and connect knowledge files to your AI character using Knowledge Bank.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"7NqGRdXVakURpzyxcX0S","title":"Personality Traits","pathname":"/api-docs/convai-playground/character-customization/personality-traits","siteSpaceId":"sitesp_wqN6M","description":"Learn how to customize your AI character’s personality using presets or manual trait adjustments.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"zaMRHpXnaDARX9ZGZgO6","title":"Core AI Settings","pathname":"/api-docs/convai-playground/character-customization/core-ai-settings","siteSpaceId":"sitesp_wqN6M","description":"Learn how to configure moderation, foundation model selection, and temperature for your AI character","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"mdYVNsUXIZrtJGq4CcEt","title":"Guardrails","pathname":"/api-docs/convai-playground/character-customization/guardrails","siteSpaceId":"sitesp_wqN6M","description":"The Guardrails tab is a safety and control interface designed to restrict and guide a character's AI behavior. It allows creators to define the ethical and topical boundaries of the conversation.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"euTj9gaXMcDOcoEvKr26","title":"State Of Mind","pathname":"/api-docs/convai-playground/character-customization/state-of-mind","siteSpaceId":"sitesp_wqN6M","description":"Learn how the State of Mind feature visualizes your AI character’s emotional state in real time during conversations.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"aAGm9eZJV0AVSVTsPaov","title":"Memory","pathname":"/api-docs/convai-playground/character-customization/memory","siteSpaceId":"sitesp_wqN6M","description":"Learn how to use the Memory feature to review past sessions, manage conversation history, and enable long-term memory for your character.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"eKYhbAZMbPHYOBWvFWhT","title":"Mindview","pathname":"/api-docs/convai-playground/character-customization/mindview","siteSpaceId":"sitesp_wqN6M","description":"Learn how to use the Mindview feature to review the actual prompts to the LLM for your current or previous sessions and interactions.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"bHvht3CwA8bDmCDcwdcd","title":"Narrative Design | Playground","pathname":"/api-docs/convai-playground/character-customization/narrative-design","siteSpaceId":"sitesp_wqN6M","description":"Build goal‑oriented conversation flows using sections, decisions, and triggers that move the story forward without rigid dialogue trees.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"qf4NbtXNuBVaWaCGbchz","title":"External API","pathname":"/api-docs/convai-playground/character-customization/external-api","siteSpaceId":"sitesp_wqN6M","description":"Learn how to integrate and configure the External API feature to enable your characters to access real-time information, create tasks, and interact with third-party platforms.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"bp1e8yWNdIT26u2PSgBU","title":"Publish","pathname":"/api-docs/convai-playground/character-customization/publish","siteSpaceId":"sitesp_wqN6M","description":"Learn how to publish and share your Convai Experience with the public, selected users, or embed it on your own website.","breadcrumbs":[{"label":"Convai Playground"},{"label":"Character Customization"}]},{"id":"TieBWynAKx8Ei5oExSzd","title":"Avatar Studio Experiences","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences","siteSpaceId":"sitesp_wqN6M","description":"Create intelligent 3D AI avatars directly in your browser — no downloads, no code, fully customizable.","breadcrumbs":[{"label":"No Code Experiences"}]},{"id":"r9B8q8s3zXPBKq65TeZ9","title":"Customizing Your Avatar","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar","siteSpaceId":"sitesp_wqN6M","description":"Learn how to visually and behaviorally personalize your Convai avatar using the Avatar Studio configurator.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"}]},{"id":"rnoxZ2yBz6tBkvMluZUT","title":"Configure Avatar","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/configure-avatar","siteSpaceId":"sitesp_wqN6M","description":"Learn how to choose, customize, or upload avatars in Avatar Studio.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"3gF4TWlNAR7gdcrwFIfb","title":"Uploading Avatars","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/configure-avatar/uploading-avatars","siteSpaceId":"sitesp_wqN6M","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"},{"label":"Configure Avatar"}]},{"id":"7RiOQDqXiSshcIxvesJU","title":"Metahuman Avatars","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/configure-avatar/uploading-avatars/metahuman-avatars","siteSpaceId":"sitesp_wqN6M","description":"Upload custom Metahuman characters from Unreal Engine to Avatar Studio using the Convai Asset Uploader.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"},{"label":"Configure Avatar"},{"label":"Uploading Avatars"}]},{"id":"KaEFOuvtwU0O5irCjn9v","title":"Reallusion Avatars","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/configure-avatar/uploading-avatars/reallusion-avatars","siteSpaceId":"sitesp_wqN6M","description":"Upload custom Reallusion characters from Unreal Engine to Avatar Studio using the Convai Asset Uploader.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"},{"label":"Configure Avatar"},{"label":"Uploading Avatars"}]},{"id":"6wQK6C3Tz1gDZ2X7t7gb","title":"Face Filter","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/face-filter","siteSpaceId":"sitesp_wqN6M","description":"Use the Face Filter feature to make your avatar resemble a specific person based on a photo.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"Fu7cIEYNH9oHgjdi8qkw","title":"Environment","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/environment","siteSpaceId":"sitesp_wqN6M","description":"Choose from immersive 3D and Solid environments to place your avatar in the right setting.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"ja8N9ZC28t5Vc0qixai9","title":"Lighting Adjustments","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/lighting-adjustments","siteSpaceId":"sitesp_wqN6M","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"zN3Zw1qIulaXUdhKi0en","title":"Animation & Expression Settings","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/animation-and-expression-settings","siteSpaceId":"sitesp_wqN6M","description":"Customize your avatar’s expressiveness with facial and body animations, emotions, and intelligent actions.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"Ib0U6R37C7GVmnADnE6t","title":"Interface Configuration","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/interface-configuration","siteSpaceId":"sitesp_wqN6M","description":"Tailor the visual and functional interface of your avatar experience to match your device, context, and brand needs.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"Bbyq4c05QHG0Lk9HZwGg","title":"Experience Settings","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/experience-settings","siteSpaceId":"sitesp_wqN6M","description":"Control idle session handling, welcome interactions, microphone behavior, and input processing timing to fine-tune your avatar experience.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"nqOkXUfzdX6wS0YC2mDI","title":"Publishing an Avatar Studio Experience","pathname":"/api-docs/no-code-experiences/avatar-studio-experiences/customizing-your-avatar/publishing-an-experience","siteSpaceId":"sitesp_wqN6M","description":"Learn how to publish and share your customized avatar experience for use across web, kiosks, apps, and more.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Avatar Studio Experiences"},{"label":"Customizing Your Avatar"}]},{"id":"roLZWRjRZyiRdKUtZIYo","title":"Convai Sim Experiences","pathname":"/api-docs/no-code-experiences/convai-sim-experiences","siteSpaceId":"sitesp_wqN6M","description":"Create AI-powered avatars and deploy them in interactive 3D environments—directly from your browser.","breadcrumbs":[{"label":"No Code Experiences"}]},{"id":"wKIgxvLa1ZFp5chDyXOA","title":"Creating Your AI Simulation with Convai Sim","pathname":"/api-docs/no-code-experiences/convai-sim-experiences/creating-your-ai-simulation-with-convai-sim","siteSpaceId":"sitesp_wqN6M","description":"Bring your Convai characters to life by placing them into 3D interactive environments using Convai Sim","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai Sim Experiences"}]},{"id":"lJ3ep46Kfwn6q0IGsBdC","title":"Avatar Customization","pathname":"/api-docs/no-code-experiences/convai-sim-experiences/avatar-customization","siteSpaceId":"sitesp_wqN6M","description":"Fine-tune your deployed avatar’s appearance, size, and position within your 3D simulation scene","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai Sim Experiences"}]},{"id":"HYwgAOEKclTWyqt7Arh5","title":"Tour Guide","pathname":"/api-docs/no-code-experiences/convai-sim-experiences/tour-guide","siteSpaceId":"sitesp_wqN6M","description":"Turn your AI avatar into an interactive tour guide using Convai Sim’s built-in tour planning tools","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai Sim Experiences"}]},{"id":"Fn1T9S7vnt8W0i6QMnLu","title":"Publishing a Convai Sim Experience","pathname":"/api-docs/no-code-experiences/convai-sim-experiences/publishing-an-experience","siteSpaceId":"sitesp_wqN6M","description":"Learn how to finalize and publish your AI simulation or tour guide experience created with Convai Sim","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai Sim Experiences"}]},{"id":"xT1TtWs3Nou8Xf4lE1wL","title":"Convai XR Animation Capture App","pathname":"/api-docs/no-code-experiences/convai-xr-animation-capture-app","siteSpaceId":"sitesp_wqN6M","description":"Capture animations in VR using your Meta Quest and animate AI avatars—no mocap suit required.","breadcrumbs":[{"label":"No Code Experiences"}]},{"id":"QVolyrxHNbjPVss42fT3","title":"Convai XR Animation Capture App Setup","pathname":"/api-docs/no-code-experiences/convai-xr-animation-capture-app/convai-xr-animation-capture-app-setup","siteSpaceId":"sitesp_wqN6M","description":"Learn how to install and connect the Convai XR Animation Capture App on your Meta Quest headset to start recording avatar animations in VR.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai XR Animation Capture App"}]},{"id":"AMu3Ygl07F5ShmmygPKG","title":"Creating Animations for AI Avatars","pathname":"/api-docs/no-code-experiences/convai-xr-animation-capture-app/creating-animations-for-ai-avatars","siteSpaceId":"sitesp_wqN6M","description":"Capture lifelike animations using your Meta Quest headset to bring your AI avatars to life—no mocap suit required.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai XR Animation Capture App"}]},{"id":"vZgEAxvS8fiQVnhs8mbC","title":"Adding Your Recorded Animations to AI Avatars Inside Unity","pathname":"/api-docs/no-code-experiences/convai-xr-animation-capture-app/adding-your-recorded-animations-to-ai-avatars-inside-unity","siteSpaceId":"sitesp_wqN6M","description":"Learn how to import animations recorded in VR and apply them to your AI avatars in Unity.","breadcrumbs":[{"label":"No Code Experiences"},{"label":"Convai XR Animation Capture App"}]},{"id":"XTPNxcugwy3CRWB1Ghpb","title":"Introduction","pathname":"/api-docs/plugins-and-integrations/introduction","siteSpaceId":"sitesp_wqN6M","description":"Introduction to Convai's plugins and integrations. Learn how to enhance your projects with AI.","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"MRNZGoXU1eGCPkzIyHxB","title":"Unity Plugin (Beta) Overview","pathname":"/api-docs/plugins-and-integrations/unity-plugin-beta-overview","siteSpaceId":"sitesp_wqN6M","description":"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.","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"rElXpswxaCEdMuNfeUDx","title":"Compatibility & Requirements","pathname":"/api-docs/plugins-and-integrations/unity-plugin-beta-overview/compatibility-and-requirements","siteSpaceId":"sitesp_wqN6M","description":"Supported Unity versions, render pipelines, and target platforms for the Convai Unity SDK.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unity Plugin (Beta) Overview"}]},{"id":"anLGHXJeSYOtxQp7uqeB","title":"Getting Started with Unity Plugin","pathname":"/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started","siteSpaceId":"sitesp_wqN6M","description":"Get the Convai Unity SDK installed, configured, and verified with a quick conversation test.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unity Plugin (Beta) Overview"}]},{"id":"aSxOk6zRjt31YsGFCtQs","title":"Installation","pathname":"/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/installation","siteSpaceId":"sitesp_wqN6M","description":"Choose an installation method and add the Convai Unity SDK to your project.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unity Plugin (Beta) Overview"},{"label":"Getting Started with Unity Plugin"}]},{"id":"JZScVGdQzSP4Xppo0rKT","title":"Install via UPM","pathname":"/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/installation/install-via-upm","siteSpaceId":"sitesp_wqN6M","description":"Install the Convai Unity SDK via the Unity Package Manager using the package name.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unity Plugin (Beta) Overview"},{"label":"Getting Started with Unity Plugin"},{"label":"Installation"}]},{"id":"j068suMLoxr4mGTv8tId","title":"Install via Unity Asset Store","pathname":"/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/installation/install-via-unity-asset-store","siteSpaceId":"sitesp_wqN6M","description":"Install the Convai Unity SDK from the Unity Asset Store.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unity Plugin (Beta) Overview"},{"label":"Getting Started with Unity Plugin"},{"label":"Installation"}]},{"id":"WoUgSXWcd5ICqC0gbxey","title":"Setup","pathname":"/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup","siteSpaceId":"sitesp_wqN6M","description":"Configure credentials and choose how you want to test Convai: samples or your own scene.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unity Plugin (Beta) Overview"},{"label":"Getting Started with Unity Plugin"}]},{"id":"ech6xFERj6ZiG6jgzdbi","title":"Configure API Key","pathname":"/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/configure-api-key","siteSpaceId":"sitesp_wqN6M","description":"Add your Convai API key in Unity to enable the SDK.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unity Plugin (Beta) Overview"},{"label":"Getting Started with Unity Plugin"},{"label":"Setup"}]},{"id":"W0Tbd48Kq4DJDFDHWlug","title":"Import & Run Sample Scenes","pathname":"/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/import-and-run-sample-scenes","siteSpaceId":"sitesp_wqN6M","description":"Import Convai sample content and run a scene to test a conversation immediately.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unity Plugin (Beta) Overview"},{"label":"Getting Started with Unity Plugin"},{"label":"Setup"}]},{"id":"iB3djtAzpp1zDO09QJEp","title":"Custom Scene Setup","pathname":"/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/custom-scene-setup","siteSpaceId":"sitesp_wqN6M","description":"Add the Convai Manager, set up a player, and connect characters to Convai.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unity Plugin (Beta) Overview"},{"label":"Getting Started with Unity Plugin"},{"label":"Setup"}]},{"id":"gS9VFYqJTGsrKsnpALQ1","title":"Add Chat UI (Transcript UI)","pathname":"/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/add-chat-ui-transcript-ui","siteSpaceId":"sitesp_wqN6M","description":"Add a ready-made chat UI prefab to enable text input and conversation transcripts.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unity Plugin (Beta) Overview"},{"label":"Getting Started with Unity Plugin"},{"label":"Setup"}]},{"id":"F7UIcySTyyiU4vIt37St","title":"Add Lip Sync to Your Character","pathname":"/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/add-lip-sync-to-your-character","siteSpaceId":"sitesp_wqN6M","description":"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.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unity Plugin (Beta) Overview"},{"label":"Getting Started with Unity Plugin"},{"label":"Setup"}]},{"id":"fCNdZOFgWiBswi27V6YH","title":"Lip Sync Profiles and Mappings","pathname":"/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/add-lip-sync-to-your-character/lip-sync-profiles-and-mappings","siteSpaceId":"sitesp_wqN6M","description":"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.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unity Plugin (Beta) Overview"},{"label":"Getting Started with Unity Plugin"},{"label":"Setup"},{"label":"Add Lip Sync to Your Character"}]},{"id":"3WxPETwWpx1haCPryteW","title":"Creating a Profile","pathname":"/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","siteSpaceId":"sitesp_wqN6M","description":"Create and register a custom Lip Sync profile in Unity, understand profile fields, and configure supported transport formats for your project.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unity Plugin (Beta) Overview"},{"label":"Getting Started with Unity Plugin"},{"label":"Setup"},{"label":"Add Lip Sync to Your Character"},{"label":"Lip Sync Profiles and Mappings"}]},{"id":"OElSP2y6XsrnEmTwJaL2","title":"Creating a Custom Map","pathname":"/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","siteSpaceId":"sitesp_wqN6M","description":"Create a custom Lip Sync map, understand the Map Inspector, and connect supported profile channels to your character's blendshapes in Unity.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unity Plugin (Beta) Overview"},{"label":"Getting Started with Unity Plugin"},{"label":"Setup"},{"label":"Add Lip Sync to Your Character"},{"label":"Lip Sync Profiles and Mappings"}]},{"id":"97df66441788eb275ec7113db8cf079018fd5420","title":"Migration Guide","pathname":"/api-docs/plugins-and-integrations/unity-plugin-beta-overview/migration-guide","siteSpaceId":"sitesp_wqN6M","description":"Convai Plugin 3.3.4 to 4.0.0","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unity Plugin (Beta) Overview"}]},{"id":"3d87eca937c2eda06a092226221a2a309c91cca0","title":"Additional Feature Migration","pathname":"/api-docs/plugins-and-integrations/unity-plugin-beta-overview/migration-guide/additional-feature-migration","siteSpaceId":"sitesp_wqN6M","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unity Plugin (Beta) Overview"},{"label":"Migration Guide"}]},{"id":"Ds9JmpEwStkRL6JTRGWB","title":"Unreal Engine Plugin (Beta) Overview","pathname":"/api-docs/plugins-and-integrations/unreal-engine-plugin-beta-overview","siteSpaceId":"sitesp_wqN6M","description":"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.","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"KjMgcEXOcCnHnZrfEWG6","title":"Installation and Setup | Unreal Engine","pathname":"/api-docs/plugins-and-integrations/unreal-engine-plugin-beta-overview/installation-and-setup","siteSpaceId":"sitesp_wqN6M","description":"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.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unreal Engine Plugin (Beta) Overview"}]},{"id":"gBASbJyhSlESZHEuKivR","title":"Dynamic Context inside Unreal Engine","pathname":"/api-docs/plugins-and-integrations/unreal-engine-plugin-beta-overview/dynamic-context-inside-unreal-engine","siteSpaceId":"sitesp_wqN6M","description":"Give AI characters real-time awareness of game state, player actions, and environment using Dynamic Context.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unreal Engine Plugin (Beta) Overview"}]},{"id":"EWcymbWi4iUfb7YZCfiK","title":"Convai Actions","pathname":"/api-docs/plugins-and-integrations/unreal-engine-plugin-beta-overview/convai-actions","siteSpaceId":"sitesp_wqN6M","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unreal Engine Plugin (Beta) Overview"}]},{"id":"npfHe64iWYu95LG93kvK","title":"Phase 1: Default Actions","pathname":"/api-docs/plugins-and-integrations/unreal-engine-plugin-beta-overview/convai-actions/phase-1-default-actions","siteSpaceId":"sitesp_wqN6M","description":"","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unreal Engine Plugin (Beta) Overview"},{"label":"Convai Actions"}]},{"id":"wGGlXPpxC3ZNOYHAi3XM","title":"Phase 2: Custom Actions","pathname":"/api-docs/plugins-and-integrations/unreal-engine-plugin-beta-overview/convai-actions/phase-2-custom-actions","siteSpaceId":"sitesp_wqN6M","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unreal Engine Plugin (Beta) Overview"},{"label":"Convai Actions"}]},{"id":"2u4KZDKI6LzuCtFHEZrd","title":"Phase 3: Parameterized Actions","pathname":"/api-docs/plugins-and-integrations/unreal-engine-plugin-beta-overview/convai-actions/phase-3-parameterized-actions","siteSpaceId":"sitesp_wqN6M","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Unreal Engine Plugin (Beta) Overview"},{"label":"Convai Actions"}]},{"id":"Ufgfxad0qAjE4Lb97w0c","title":"Web Plugins","pathname":"/api-docs/plugins-and-integrations/web-plugins","siteSpaceId":"sitesp_wqN6M","description":"Integrate Convai AI with your website. Follow our Web plugin documentation for seamless setup.","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"bg0KbmaczTTieGzr3iU7","title":"Convai Web SDK","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk","siteSpaceId":"sitesp_wqN6M","description":"Explore the Convai Web SDK — Fast, low-latency, voice-first AI character interaction for the browser","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"}]},{"id":"QARm23s6FuiamQWrYu2J","title":"React","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react","siteSpaceId":"sitesp_wqN6M","icon":"react","description":"Learn how to install, configure, and integrate the Convai Web SDK (@convai/web-sdk) to bring low-latency conversational AI, voice interaction, and optional video into your web applications.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"GQ2YU7yGQqbMXjFYj2Pd","title":"useConvaiClient Hook","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/useconvaiclient-hook","siteSpaceId":"sitesp_wqN6M","description":"useConvaiClient manages all Convai connection logic, audio/video pipelines, and message flows.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"VVA0bI3FaMJjHAXp7Ce4","title":"ConvaiWidget","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/convaiwidget","siteSpaceId":"sitesp_wqN6M","description":"ConvaiWidget is an all-in-one interface for voice, text, video, and screen sharing.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"BsYjAXPL7ouWHomF7333","title":"Real-time Lipsync","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/real-time-lipsync","siteSpaceId":"sitesp_wqN6M","description":"Integrate real-time facial animation in your React applications.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"pnBdTq1ZprIrW02nBrkE","title":"Custom UI & Advanced Usage","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/custom-ui-and-advanced-usage","siteSpaceId":"sitesp_wqN6M","description":"Build your own UI while using Convai’s audio pipelines and message system.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"69dkBZG1to4kDHLmJYeP","title":"Audio Visualizer (Optional)","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/react/audio-visualizer-optional","siteSpaceId":"sitesp_wqN6M","description":"You can create real-time visualizations from the bot’s audio using Web Audio + the WebRTC room.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"React","icon":"react"}]},{"id":"mskfPzpQqd1cn7uDGJGm","title":"Vanilla Typescript","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript","siteSpaceId":"sitesp_wqN6M","icon":"js","description":"Complete guide for using @convai/web-sdk with vanilla TypeScript applications (no React or framework required). Use the ConvaiClient class directly, wire up events, and build your own UI.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"}]},{"id":"hoQvlTU9Xdyx4zRfPNAo","title":"ConvaiClient (Core API)","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/convaiclient-core-api","siteSpaceId":"sitesp_wqN6M","description":"ConvaiClient is the main class for managing Convai in vanilla TypeScript.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"MXjYUMCl5Jq7hr0wdRLg","title":"Events & Message Handling","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/events-and-message-handling","siteSpaceId":"sitesp_wqN6M","description":"ConvaiClient provides a strongly typed event system. Use client.on(event, handler) to subscribe.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"skNItzZaOkTbepJMsmUF","title":"Real-time Lipsync","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/real-time-lipsync","siteSpaceId":"sitesp_wqN6M","description":"Integrate real-time facial animation in vanilla JavaScript/TypeScript applications.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"XcLdxS5Xkd0vnutCN9a5","title":"Building a Custom UI (TypeScript)","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/building-a-custom-ui-typescript","siteSpaceId":"sitesp_wqN6M","description":"This page shows how to wire up a simple DOM-based chat UI using vanilla TypeScript.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"Ao6AKyD9m1Dhix32kGFx","title":"Best Practices & Type Definitions","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/best-practices-and-type-definitions","siteSpaceId":"sitesp_wqN6M","description":"A summary of recommended patterns and the main TypeScript types for quick reference.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"zryHbFTZ6NP3reRcdOj3","title":"Mappings Reference","pathname":"/api-docs/plugins-and-integrations/web-plugins/convai-web-sdk/vanilla-typescript/mappings-reference","siteSpaceId":"sitesp_wqN6M","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Convai Web SDK"},{"label":"Vanilla Typescript","icon":"js"}]},{"id":"n9v4tFFO4pRJ6O541ZRa","title":"PlayCanvas Plugin","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin","siteSpaceId":"sitesp_wqN6M","description":"PlayCanvas template for Convai integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"}]},{"id":"QgtCmdlCRV50DHC1iEtC","title":"Adding External Script","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/adding-external-script","siteSpaceId":"sitesp_wqN6M","description":"Adding External Script - PlayCanvas Plugin Guide for Convai integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"Fk34BucslC2wJcI0XFFW","title":"First Person View","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/first-person-view","siteSpaceId":"sitesp_wqN6M","description":"First Person View - PlayCanvas Plugin Guide for Convai integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"QpyJz01hLP2wvlL4upOz","title":"Adding characters to scene","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/adding-characters-to-scene","siteSpaceId":"sitesp_wqN6M","description":"Adding Characters to Scene - PlayCanvas Plugin Guide for Convai integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"cE5ZZSi57PuSNgUL4Xpu","title":"Character Animations","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/character-animations","siteSpaceId":"sitesp_wqN6M","description":"Add character animations in PlayCanvas with Convai. Enhance your web projects with interactive AI.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"cxJUrJf4fgW8f1YGTzYv","title":"Convai Integration","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/convai-integration","siteSpaceId":"sitesp_wqN6M","description":"Convai Integration - PlayCanvas Plugin Guide for seamless integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"Ep4ijjZn9V9P2RKuPGF0","title":"Chat Overlay","pathname":"/api-docs/plugins-and-integrations/web-plugins/playcanvas-plugin/chat-overlay","siteSpaceId":"sitesp_wqN6M","description":"Chat Overlay - PlayCanvas Plugin Guide for Convai integration.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"PlayCanvas Plugin"}]},{"id":"Kc2Von4OI1yH7YuY9OIh","title":"Narrative Design Guide","pathname":"/api-docs/plugins-and-integrations/web-plugins/narrative-design-guide","siteSpaceId":"sitesp_wqN6M","description":"Narrative Design - Narrative based NPCs with convai on web.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"}]},{"id":"D6uP7zLp4pbknqrkdSsa","title":"Narrative Design Triggers","pathname":"/api-docs/plugins-and-integrations/web-plugins/narrative-design-guide/narrative-design-triggers","siteSpaceId":"sitesp_wqN6M","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Narrative Design Guide"}]},{"id":"Qkt6MfVHhjdzZdrdSr9X","title":"Narrative Design Keys","pathname":"/api-docs/plugins-and-integrations/web-plugins/narrative-design-guide/narrative-design-keys","siteSpaceId":"sitesp_wqN6M","description":"This guide shows how to dynamically pass variables to Narrative Design section and triggers","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"},{"label":"Narrative Design Guide"}]},{"id":"xSv83YrJNeitsFOaOxgm","title":"GLB/FBX animations for Convai","pathname":"/api-docs/plugins-and-integrations/web-plugins/glb-fbx-animations-for-convai","siteSpaceId":"sitesp_wqN6M","description":"Learn to integrate GLB and FBX animations into Convai's web plugin for dynamic character actions.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Web Plugins"}]},{"id":"WOPfcFOkzv1ZgtzuZceM","title":"Modding Framework","pathname":"/api-docs/plugins-and-integrations/modding-framework","siteSpaceId":"sitesp_wqN6M","description":"Convai introduces a Modding Framework, enabling easy integration of AI-driven NPCs into games across engines like Unreal, Unity, and more.","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"GH02p9AZOVvnhbp1Sb4E","title":"Modding Cyberpunk 2077","pathname":"/api-docs/plugins-and-integrations/modding-framework/modding-cyberpunk-2077","siteSpaceId":"sitesp_wqN6M","description":"This guide will show you how to make Mods that add Convai's features to Cyberpunk 2077","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Modding Framework"}]},{"id":"UISZJcESbADnVXDFGLET","title":"Other Integrations","pathname":"/api-docs/plugins-and-integrations/other-integrations","siteSpaceId":"sitesp_wqN6M","description":"","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"GqV13lmDXJ8bTbW3cmZV","title":"Third-Party API Integrations","pathname":"/api-docs/plugins-and-integrations/other-integrations/third-party-api-integrations","siteSpaceId":"sitesp_wqN6M","description":"Integrate external APIs like ElevenLabs to enhance your applications with advanced features.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Other Integrations"}]},{"id":"8dkGWxai0jzPFeE7OVza","title":"ElevenLabs API Integration","pathname":"/api-docs/plugins-and-integrations/other-integrations/third-party-api-integrations/elevenlabs-api-integration","siteSpaceId":"sitesp_wqN6M","description":"This is a guide on how to integrate your ElevenLabs voices with Convai characters","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Other Integrations"},{"label":"Third-Party API Integrations"}]},{"id":"mCC3cioDPzGqMj6BUUat","title":"Convai Pixel Streaming Embed","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed","siteSpaceId":"sitesp_wqN6M","breadcrumbs":[{"label":"Plugins & Integrations"}]},{"id":"Iwsgfz11iH7bumaekCAn","title":"Whitelisting & Publishing an Experience","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/whitelisting-and-publishing-an-experience","siteSpaceId":"sitesp_wqN6M","icon":"chalkboard","description":"Learn how to publish your scene and whitelist domains to embed Convai experiences securely in your web application.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"HYyLcups49ZlTYkAC5N6","title":"React Typescript","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/react-typescript","siteSpaceId":"sitesp_wqN6M","icon":"react","description":"Set up and integrate Convai's Pixel Streaming component in your React TypeScript app using @convai/experience-embed.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"l8vv3zd6ARamfWWoZHLp","title":"ReactJS (JavaScript)","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/reactjs-javascript","siteSpaceId":"sitesp_wqN6M","icon":"react","description":"Integrate Convai's Pixel Streaming into your React JavaScript app using the @convai/experience-embed component.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"Bl1WM6LpsANKMtp0LQOW","title":"Vanilla JavaScript (ES Modules)","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/vanilla-javascript-es-modules","siteSpaceId":"sitesp_wqN6M","icon":"js","description":"Use Convai's Pixel Streaming client directly in browser-based JavaScript apps with native ES module support.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"MhibeeodX75C0pjpQiDH","title":"CDN (UMD Script)","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/cdn-umd-script","siteSpaceId":"sitesp_wqN6M","icon":"js","description":"Integrate Convai's Pixel Streaming into your web app using the UMD build directly from a CDN","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"SKht31jhLhAvwhNt1BBj","title":"On Premise Deployment","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/on-premise-deployment","siteSpaceId":"sitesp_wqN6M","icon":"building","description":"Configure Convai’s Pixel Streaming client to connect with your own backend and streaming servers for on-premise or self-hosted deployments.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"MWe8NjQDMtLGGeNG14mq","title":"API Reference","pathname":"/api-docs/plugins-and-integrations/convai-pixel-streaming-embed/api-reference","siteSpaceId":"sitesp_wqN6M","icon":"webhook","description":"Explore the available props, options, and methods for using Convai's Pixel Streaming client across React, Vanilla JS, TypeScript, and CDN setups.","breadcrumbs":[{"label":"Plugins & Integrations"},{"label":"Convai Pixel Streaming Embed"}]},{"id":"aHV8dG6zd7DRJsjbazzV","title":"Asset Uploader","pathname":"/api-docs/asset-uploader","siteSpaceId":"sitesp_wqN6M","description":"Upload Metahumans, Reallusion characters, and Scenes from Unreal Engine to Convai Sim and Avatar Studio with ease."},{"id":"s3lrIqucxPSGo95OOgM0","title":"Core API Reference","pathname":"/api-docs/api-reference/core-api-reference","siteSpaceId":"sitesp_wqN6M","description":"Explore Convai’s Core APIs, divided into Character Crafting and Interaction APIs, to create, customize, and interact with intelligent AI characters.","breadcrumbs":[{"label":"API Reference"}]},{"id":"gsTUYbL4ZFKCtOINokQj","title":"Character Crafting APIs","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis","siteSpaceId":"sitesp_wqN6M","description":"Create and configure AI characters with Convai’s Character Crafting APIs to define their personality, behavior, knowledge and more.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"}]},{"id":"XWE3BRSoU4D0tOAIAYF9","title":"Character Base API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/character-api","siteSpaceId":"sitesp_wqN6M","description":"All the relevant APIs needed to create your own intelligent AI characters with Convai.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"FFi1yUiXmETgoUw75AHX","title":"Backstory API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/backstory-api","siteSpaceId":"sitesp_wqN6M","description":"Learn how to use the Backstory API to create and manage character backstories, adding depth and personality to your NPCs.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"UOtHPa6ISx9iKUY1oY8f","title":"Mindview API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/mindview-api","siteSpaceId":"sitesp_wqN6M","description":"Learn how to use the Backstory API to create and manage character backstories, adding depth and personality to your NPCs.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"G8p6SIjsyhuaiIN7rkWz","title":"Core AI Settings API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/core-ai-settings-api","siteSpaceId":"sitesp_wqN6M","description":"All the relevant APIs needed to modify Core AI setting of your Convai Character.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"oCIidcCW4TDhTMwOM7W8","title":"Narrative Design API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/narrative-design-api","siteSpaceId":"sitesp_wqN6M","description":"The page list all the APIs needed to interact Narrative Design","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"3ggYWwe3Bv6K0A4KMVjn","title":"Knowledge Bank API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/knowledge-bank-api","siteSpaceId":"sitesp_wqN6M","description":"All the relevant APIs needed to interact with Knowledge Bank for you AI characters with Convai.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"w9NkMyt9Xl0jW2J3XPzO","title":"Action API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/action-api","siteSpaceId":"sitesp_wqN6M","description":"This page describes the Action API and how to use it.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"5Wcbc7O4hgMexjJCzSIt","title":"Chat History API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/chat-history-api","siteSpaceId":"sitesp_wqN6M","description":"All the relevant APIs needed to interact with Chat History of a session or character.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"XWKGoRyiqLL5CSNGM93v","title":"Evaluation API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/evaluation-api","siteSpaceId":"sitesp_wqN6M","description":"API to evaluate a conversation transcript based on user defined attributes (e.g. clarity of responses, courtesy, listening skills, and more).","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"MteKvBX7fweeVkU90Ry4","title":"Language List API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/language-list-api","siteSpaceId":"sitesp_wqN6M","description":"API to retrieve the full list of languages, both public and private, available to a user.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"PfsvJRo5OzlyGVrnZG06","title":"Voice List API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/voice-list-api","siteSpaceId":"sitesp_wqN6M","description":"API to retrieve the full list of voices, both public and private, available to a user.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"oO9thYF55EFX4iuE7zxC","title":"Character List API","pathname":"/api-docs/api-reference/core-api-reference/character-crafting-apis/character-list-api","siteSpaceId":"sitesp_wqN6M","description":"API to retrieve the list of characters, created by a user.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Character Crafting APIs"}]},{"id":"fne9do28bEO2Kg1iO5GS","title":"Live APIs (Beta)","pathname":"/api-docs/api-reference/core-api-reference/live-apis-beta","siteSpaceId":"sitesp_wqN6M","description":"Enable real-time, low-latency interaction with Convai AI characters through WebRTC-based Live APIs that support text, audio, and dynamic contextual communication.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"}]},{"id":"KRZRHxk7U8Q3yHwi9YFj","title":"Connect API","pathname":"/api-docs/api-reference/core-api-reference/live-apis-beta/connect-api","siteSpaceId":"sitesp_wqN6M","description":"Establish a live chatbot session for your Convai character, enabling users to connect via audio or video and maintain conversational context.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Live APIs (Beta)"}]},{"id":"8d9VYXokFuzhWLEylqwu","title":"Metrics","pathname":"/api-docs/api-reference/core-api-reference/live-apis-beta/metrics","siteSpaceId":"sitesp_wqN6M","description":"This page explains the metrics sent to clients over the WebRTC data channel.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Live APIs (Beta)"}]},{"id":"hIPRKZO2HDe3YYFi3g7J","title":"Interaction APIs","pathname":"/api-docs/api-reference/core-api-reference/interaction-apis","siteSpaceId":"sitesp_wqN6M","description":"Enable real-time interaction with AI characters using Convai’s Interaction APIs for natural text and voice-based communication.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"}]},{"id":"NOI4Ph3RXtXVmdFcNVoU","title":"Interaction API","pathname":"/api-docs/api-reference/core-api-reference/interaction-apis/interaction-api","siteSpaceId":"sitesp_wqN6M","description":"This page details on how you can interact with Character.","breadcrumbs":[{"label":"API Reference"},{"label":"Core API Reference"},{"label":"Interaction APIs"}]}]}