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 Keychevron-right
  • Import & Run Sample Scenes (fastest validation)

Import & Run Sample Sceneschevron-right
  • Custom Scene Setup (integrate into your scene)

Custom Scene Setupchevron-right
  • Add Chat UI (optional, text input + transcript)

Add Chat UI (Transcript UI)chevron-right
  1. Configure API Key

  2. Import and run a sample scene

  3. (Optional) Set up a custom scene

  4. (Optional) Add Chat UI

Conclusion

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

circle-info

Need help? For questions, please visit the Convai Developer Forumarrow-up-right.

Last updated

Was this helpful?