Install the Convai Unity SDK

Add the Convai Unity SDK to your Unity 2023.1+ project via the Package Manager or Asset Store. Both methods install the identical package.

The Convai Unity SDK is available through two channels. Use Package Manager for new projects or when you prefer not to manage Asset Store downloads — the package resolves directly from the Convai registry with no manual download. Use Asset Store if your project already sources packages from your Asset Store library or if your studio manages package versions through My Assets.

Both methods install SDK version 4.2.0 and the same three required dependencies.

Package Manager

1

Open Package Manager

In the Unity Editor menu bar, select Window > Package Manager.

The Package Manager window opens. Confirm you are connected to the internet before proceeding.

2

Add package by name

Click the + button in the top-left corner of the Package Manager window. Select Add package by name from the dropdown.

A text field appears prompting for the package name.

3

Enter the package name

Type or paste the following identifier into the Name field, then click Add:

com.convai.convai-sdk-for-unity

Unity contacts the registry, resolves the package, and begins downloading. Three dependencies install automatically:

Package	Version
com.unity.nuget.newtonsoft-json	3.2.2
com.unity.ugui	2.0.0
com.unity.inputsystem	1.18.0

Wait for the progress bar in the bottom-right of the Unity Editor to complete before continuing.

Dependency conflict: If your project already pins com.unity.inputsystem or com.unity.ugui to an older version in Packages/manifest.json, the install will fail or produce a version mismatch. Open Packages/manifest.json, remove or update the conflicting version entries, then retry.

Installation complete when the Convai SDK for Unity entry appears in the Package Manager list with a green checkmark and version 4.2.0. You will also see a new Convai menu item in the Unity menu bar.

Asset Store

Next steps

With the SDK installed, connect your project to Convai by entering your API key.

Configure the API key