Install via UPM (Recommended)

Install the Convai Unity SDK via the Unity Package Manager using the package name.

Introduction

UPM installation is the recommended approach because it’s easy to maintain, update, and keep consistent across a team.

Prerequisites

• A Unity project opened in the Unity Editor

Step-by-step

1

Open Package Manager

In Unity, go to Window → Package Manager.

2

Add the package from Git URL

• Click the + button (top-left).

• Select Install package by name

• Copy the package name below and paste it into the Package Name field. Then click Install.

  • com.convai.convai-sdk-for-unity

3

Verify the installation

• Wait for Unity to finish importing and compiling.

• Open Console (if needed): Ctrl + Shift + C (Windows) / Cmd + Shift + C (macOS)

• Expected result: No errors in Console, and a Convai menu appears in the top toolbar.

Troubleshooting

• Console errors after install

  • Confirm you are using a supported Unity version.

Conclusion

You’ve installed the Convai Unity SDK via UPM and confirmed the editor compiled successfully. Next, go to Setup → Configure API Key.

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