System requirements, Unity version, required packages, and account prerequisites for the Convai Unity SDK.
Before installing the Convai Unity SDK, confirm that your environment meets the requirements below. Missing any of these will cause installation errors or runtime failures that are harder to diagnose after the fact.
Unity version
2023.1 or later
Scripting backend
Mono or IL2CPP
Internet connection
Required at editor time and runtime
The Convai Unity SDK requires Unity 2023.1 or later. If your project is on an older LTS release, upgrade before proceeding.
The SDK depends on three Unity packages. Both installation methods (Package Manager and Asset Store) install these automatically — you do not need to add them manually unless you encounter a version conflict.
com.unity.nuget.newtonsoft-json
3.2.2
com.unity.ugui
2.0.0
com.unity.inputsystem
1.18.0
If your project already pins com.unity.inputsystem or com.unity.ugui to an older version in Packages/manifest.json, the automatic install will fail silently or produce a version conflict. Remove or update the existing version pins before installing the SDK.
Built-in Render Pipeline
✓
Universal Render Pipeline (URP)
✓
High Definition Render Pipeline (HDRP)
✓
For detailed platform and render pipeline compatibility, see Compatibility & Requirements.
You need an active Convai account and an API key to connect your project to Convai.
Create an account at convai.com if you do not have one.
Retrieve your API key from the API Keys section of the Convai dashboard.
Create at least one character in the Convai dashboard and note its Character ID — you will need it during scene setup.
Your API key is stored in Assets/Resources/ConvaiSettings.asset. If your project uses source control, decide whether to commit this file based on your team's security policy. See Configure the API key for full setup steps and secure-deployment options.
Once your environment meets all requirements above, install the SDK.
Install the Convai Unity SDKLast updated
Was this helpful?
Was this helpful?
