Install the Convai Unity SDK

Install the Convai Unity SDK into a Unity project using Package Manager or Asset Store so the SDK and its dependencies resolve correctly.

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 require Unity 6000.0.80f1 or later and install SDK version 4.6.0 and the same four 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. Four dependencies install automatically:

Package	Version
com.unity.ai.inference	2.2.1
com.unity.nuget.newtonsoft-json	3.2.2
com.unity.ugui	2.0.0
com.unity.inputsystem	1.19.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 any of these four packages 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.6.0. You will also see a new Convai menu item in the Unity menu bar.

Asset Store

1

Add the SDK to your Asset Store account

Open the Unity Asset Store in your browser. Search for Convai SDK for Unity and open the listing. Click Add to My Assets, signing in with your Unity ID if prompted.

The button changes to Open in Unity when the asset has been added to your account.

2

Open Package Manager

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

3

Switch to My Assets

In the Package Manager window, click the packages source dropdown in the top-left (it shows Packages: In Project or similar) and select My Assets.

Your Asset Store library loads. Locate Convai SDK for Unity in the list.

4

Download and import

Select Convai SDK for Unity in the list. Click Download, then click Import once the download completes.

Unity imports the package and installs four dependencies automatically:

Package	Version
com.unity.ai.inference	2.2.1
com.unity.nuget.newtonsoft-json	3.2.2
com.unity.ugui	2.0.0
com.unity.inputsystem	1.19.0

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

To update the SDK to a newer version later, return to My Assets in the Package Manager, select the SDK, and click Update.

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

Next steps

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

Configure the API key