Getting Started

Get the Convai Unity SDK installed, configured, and verified with a quick conversation test.

Introduction

The Convai Unity SDK lets you bring real-time conversational AI into your Unity projects—ideal for NPC dialogue, voice interactions, and interactive character experiences.

This Getting Started section is designed to guide you from a fresh Unity project to a successful “first conversation” using either a sample scene or your own custom scene.

Overview

Use these pages depending on where you are in the process:

  • Installation

    • UPM (Recommended) — easiest updates and dependency management

    • Unity Package — manual install (useful for offline or pinned builds) (Coming soon)

    • Unity Asset Store — Asset Store based distribution workflow (Coming soon)

  • Setup

    • Configure API Key

    • Import & Run Sample Scenes

    • Custom Scene Setup

    • Add Chat UI (Transcript UI)

What’s next

If this is your first time installing Convai in Unity:

  1. Start with Install via UPM

  2. Continue to Configure API Key

  3. Validate with Sample Scenes or Custom Scene Setup

  4. Optionally add Chat UI

Conclusion

You now have a clear path to install and validate the Convai Unity SDK. Start with Installation, then move to Setup, and finish with a quick test conversation.

circle-info

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

Last updated

Was this helpful?