Setup

Configure credentials and choose how you want to test Convai: samples or your own scene.

Introduction

After installation, you’ll configure your Convai API key and then validate the integration using either:

• Convai’s Sample Scenes, or Your own Custom Scene Setup

Overview

• Configure API Key (required)

Configure API Key

• Import & Run Sample Scenes (fastest validation)

Import & Run Sample Scenes

• Custom Scene Setup (integrate into your scene)

Custom Scene Setup

• Add Chat UI (optional, text input + transcript)

Add Chat UI (Transcript UI)

• Add Lip Sync to Your Character (optional, real-time facial animation)

Recommended path

1. Configure API Key
2. Import and run a sample scene
3. (Optional) Set up a custom scene
4. (Optional) Add Chat UI
5. (Optional) Add Lip Sync to Your Character

Conclusion

You’re ready to configure your project and run your first conversation test. Start with Configure API Key.

Need help? For questions, please visit the Convai Developer Forum.