Getting started

Install the Convai Unreal Engine plugin, configure your API key, and place your first talking character — follow the core path in order for the fastest result.

By the end of this section, your project contains a working Convai character in Unreal Engine. Follow the core path pages in order — each step builds directly on the previous one. Character rig and configuration pages are optional branches you can complete in any order after the first conversation is working.

Before you begin: Confirm your environment meets the requirements on the Prerequisites page — engine version, account, platform, and network access.

Preparation

Prerequisites Verify engine version, account, platform, and network requirements before installing.

Install the Convai plugin Install from Fab or GitHub Releases and enable the plugin in your project.

Core path

Configure your API key Sign in through the Convai editor window and store your API key.

Scene components reference Reference for the Convai Chatbot, Player, Object, and Face Sync components and their fields.

Add your first Convai character Place a Convai character in a level and have a live voice conversation with it.

Character rigs

Add Convai to a specific character type. Complete this after the first conversation is working.

Set up a MetaHuman character Wire Convai lip sync and animation to a MetaHuman character in your project.

Set up a Reallusion (CC) character Export a Reallusion CC4 or CC5 avatar, import it into Unreal, and connect Convai.

Configuration

Tune audio, input, and UI after the first conversation is working. Each page is independent.

Configure the microphone Select a capture device and adjust volume so the player's voice reaches the character.

Configure character audio Adjust speech playback volume, enable spatial audio attenuation, and set the interrupt fade duration.

Configure conversation input Switch between push-to-talk and hands-free mode, tune VAD settings, and send text messages.

Add the chat UI Add the built-in overlay or 3D in-world widget, or wire a custom widget to the transcript delegate.

Validate your setup

Validate your setup Run through a checklist to confirm that every part of your setup is working before adding features.

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 conversation pipeline and component architecture before building further.

Core concepts