Feature map

Find the right Convai Unity SDK feature, module, guide, or reference page for any development goal, indexed by use case.

Use this table when you know the outcome you want but are not sure which SDK feature, module, or guide covers it.

Getting started

I want to...	Feature / Tool	Documentation
Install the SDK into my project	Installation	Installation
Configure my Convai API key	API key setup	Configure API key
Add my first conversational character to a scene	Scene setup	Build a custom scene
Run a working example without building from scratch	Sample scenes	Import and run sample scenes
Run a working example with several characters in one session	Multi-Character Sample	Multi-Character Sample
Understand what each component in the scene does	Component reference	Scene components reference
Choose between push-to-talk and hands-free input	Input mode	Configure conversation input mode
Configure character audio output	Audio setup	Configure character audio
Configure microphone device and platform permissions	Audio setup	Configure microphone
Add a chat or subtitle transcript display	Transcript UI	Add chat UI
Add real-time lip sync to my character	Lip sync	Add lip sync
Verify my scene is set up correctly before shipping	Scene Validator	Validate your setup

Authentication

I want to...	Feature	Documentation
Compare API Key and Auth Token authentication modes	Authentication	Authentication
Understand how a ConvaiManager resolves credentials	Authentication concept	How authentication works
Switch a project between API Key and Auth Token mode	Auth mode setup	Configure auth token mode
Connect a room session using a short-lived Auth Token	Auth Token connect	Connect with Auth Token
Supply my own Auth Token minting logic	Custom token provider	Custom token provider
Ship a player build without exposing my account API key	Secure build	Ship a secure build
Call the authentication API from C#	Scripting reference	Authentication scripting reference

Features

I want to...	Feature	Documentation
Let my character execute in-scene commands (trigger animations, open doors, move objects)	Actions	Actions
Inject runtime state or events into the character's knowledge	Dynamic Context	Dynamic Context
Let the character automatically read information about scene objects	Scene Metadata	Scene Metadata
Show facial emotion on my character driven by the AI response	Emotion	Emotion
Make the character remember players between sessions	Long-Term Memory	Long-Term Memory
Build branching story sections triggered by conversation	Narrative Design	Narrative Design
Give my character vision through a camera or webcam	Vision	Vision
Decide which character the player is talking to	Conversation Targeting	Conversation Targeting
Know whether the player can talk right now, and gate my UI on it	Conversation Availability	Conversation Availability

Embodiment

I want to...	Module	Documentation
Make my character look at the player, at objects, or around the scene	Gaze	Gaze
Time a character's behavior to the phase of the conversation	Conversation Flow	Conversation flow
Share one set of behavior settings across several characters	Presets	Embodiment presets
Decide how much of the face emotion and lip sync each control while speaking	Facial composition	Facial composition
Drive idle, talk, locomotion, and gesture animation from code	Body Animation	Body Animation
Direct conversational nonverbal behavior — posture, breathing, listening	Body Language	Body Language

UI and presentation

I want to...	Component	Documentation
Display a live conversation transcript in my UI	Transcript UI	Transcript UI
Switch between chat and subtitle display modes	Presentation modes	Chat and subtitle modes
Query transcript history or react to transcript changes from code	Transcript history	Transcript history and queries
Show in-world notification popups	Notification system	Notification system
Add a runtime settings panel (mic, transcript, notifications, input)	Settings panel	Settings panel
Read or apply runtime settings from code	Runtime settings	Runtime settings API
Customize the look and layout of UI components	UI customization	Customizing UI components

Core concepts

I want to...	Concept	Documentation
Understand the system architecture end-to-end	Architecture	Convai Unity SDK architecture
Understand session states, reconnection, and persistence	Session lifecycle	Session lifecycle
Compare hands-free, push-to-talk turn-taking	Turn-taking modes	Turn-taking modes
Subscribe to conversation events from C# or Inspector	Event system	Event System

Scripting reference

I want to...	API	Documentation
Subscribe to session connected / disconnected / error events	Session events	Session Events
Subscribe to transcript, emotion, and turn events	Character events	Character Events
Read and clear transcript history at runtime	Transcript API	Transcript API
Use the ConvaiSDK and ConvaiAudio static facades	Conversation facades	ConvaiManager API
Understand IConvaiOperation<T> and async patterns	Async patterns	Async Patterns
Use the ConvaiCharacter and ConvaiPlayer API surface	Character and player API	Character and Player API
Understand IConvaiOperation<T> and stream result types	Operation and stream types	Operation & Stream Types

Compatibility and requirements

I want to...	Requirement	Documentation
Check the Unity version, render pipeline, and package requirements	Compatibility overview	Compatibility and requirements
Confirm which Unity versions and render pipelines are supported	Unity and render pipeline support	Unity versions and render pipelines
Confirm domains, ports, and firewall rules the SDK needs	Network requirements	Network and API requirements

Troubleshooting

I want to...	Tool	Documentation
Find why a character is not working, with a fix beside each finding	Convai Troubleshooter	Troubleshooting

Platform guides

I want to...	Platform	Documentation
Ship to a browser with WebGL	WebGL	WebGL
Ship to Android or iOS	Mobile	Mobile — iOS and Android
Ship to Windows, macOS, or Linux	Desktop	Windows, macOS, and Linux
Ship to Meta Quest with passthrough vision	Meta Quest / XR	Meta Quest and XR
Stream the Meta Quest passthrough camera to a character	Meta Quest / XR	Meta Quest Vision setup

Advanced topics

I want to...	Topic	Documentation
Replace the API credential provider	Custom providers	Custom Credential Provider
Replace the end-user identity provider	Custom providers	Custom Identity Provider
Replace the session persistence provider	Custom providers	Custom Persistence Provider
Measure latency and interpret session metrics	Performance	Performance and Optimization
Extend the SDK with a custom module or replace internal services	Extension points	Extending the SDK

Next steps

Start with installation if you have not set up the SDK yet.

Getting started