Getting started

Step-by-step path from installing the Convai Unity SDK to a validated, working conversational AI character in your scene.

By the end of this section, your project contains a responsive AI character that listens, processes speech through Convai, and responds in real time. Follow the pages in order — each step builds directly on the previous one.

Before you begin: Confirm your environment meets the requirements on the Prerequisites page — Unity version, required packages, and a Convai account with an API key.

Preparation

Prerequisites Unity version, required packages, and account requirements before installing.

Installation Add the Convai Unity SDK to your project via the Package Manager or Asset Store.

Scene setup

Configure API key Connect your project to Convai with your account API key.

Import and run sample scenes Verify the SDK works before building your own scene.

Scene components reference Learn what ConvaiManager, ConvaiCharacter, and ConvaiPlayer do and how they depend on each other.

Build a custom scene Build a Convai scene from scratch using the Setup Required Components command.

Validate your setup Run the scene validator to confirm required components are present before adding features.

Configure conversation input mode Choose between hands-free and push-to-talk input.

Configure character audio Tune NPC voice volume, spatial audio, and mute controls.

Configure microphone Select the active microphone device and set up platform permissions for Android, iOS, and WebGL.

Add chat UI Display conversation transcripts in your scene.

Add lip sync Drive character blendshapes in sync with voice audio.

Next steps

Once you have validated your setup, explore the Features section to add Actions, Emotion, Long-Term Memory, or Vision to your characters.

Features

Review Core Concepts for a deeper understanding of the session lifecycle and event system before building further.

Core concepts