Configure API Key

Add your Convai API key in Unity to enable the SDK.

Introduction

The SDK needs your Convai API key to authenticate requests and enable character conversations.

Prerequisites

• A Convai account

• API key from your Convai dashboard. (Where to find your API key)

Step-by-step

1

Open the Convai Account window in Unity

In the Unity top menu, go to Convai → Account.

2

Copy your API Key from Convai

• Open Convai in your browser and sign in.

• Locate your API Key in the dashboard/profile settings.

• Copy the API key.

3

Paste and update the key in Unity

• Paste the key into the API Key field.

• Click Update API Key.

• Expected result: Account details and usage information refresh successfully.

Troubleshooting

• Account info doesn’t update

  • Confirm the API key is correct (no extra spaces).

  • Check internet connection and retry.

• You can’t find your API key

  • Use the linked dashboard/profile documentation section.

Conclusion

Your project is now authenticated with Convai. Next, validate the integration using Sample Scenes or continue with Custom Scene Setup.

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