Troubleshooting

Find the Convai Troubleshooter window plus troubleshooting guides for installation, API, audio, and debug tools in the Unity SDK.

This section covers problems that occur at the SDK level — before or during the connection to Convai — regardless of which features you are using. Start with the Convai Troubleshooter window: it lists what is stopping a ConvaiCharacter from working, with a fix beside each finding, before you read a single Console line. If the SDK connects successfully but a specific feature like Actions, Emotion, or Vision is not working as expected, start with the troubleshooting page inside that feature's section instead. The pages here also address three categories of general issues: package installation and import, API key and connection failures, audio and microphone problems, and the full suite of built-in diagnostic tools.

Not sure where to start? Open Convai → Troubleshooter, select the character, and read what it reports — most setup mistakes surface there with a one-click fix. If the character is not the problem, open the Unity Console and look for the first error or warning tagged with [Convai]. If the message contains an error code in dot-notation format — for example connection.connect_invalid_api_key or audio.mic_permission_denied — go directly to the page that matches its prefix. If you see a plain English message from Convai Bootstrapper, start with Installation & Package Issues.

Troubleshooting categories

Convai Troubleshooter The Editor window that reports what is stopping a character from working, module by module, with a fix beside each finding.

Installation and package issues Package import failures, missing dependencies, ConvaiSettings not found, and API key warnings at startup.

Connection and API issues API key rejections, character not found, timeout, rate limiting, transport errors, retry behavior, and runtime diagnostics.

Audio and microphone issues Microphone permission failures, unavailable devices, audio publish errors, and platform-specific setup for Android, iOS, and WebGL.

Debug tools reference Logging configuration, log categories, per-module editor windows, session diagnostics, latency metrics, and custom log sinks.

Feature-specific troubleshooting

Problems that occur after a successful connection — where the SDK is running but a specific feature behaves incorrectly — are documented inside each feature's own section.

Feature	Troubleshooting page
Actions	features/character-actions/debugging-and-troubleshooting.md
Emotion	embodiment/emotion/troubleshooting-and-diagnostics.md
Long-Term Memory	features/long-term-memory/troubleshooting-and-diagnostics.md
Dynamic Context	features/dynamic-context/troubleshoot-dynamic-context.md
Narrative Design	features/narrative-design/troubleshooting-and-diagnostics.md
Vision	features/vision/troubleshooting-and-diagnostics.md
Scene Metadata	features/scene-metadata/troubleshooting-and-diagnostics.md
Embodiment	embodiment/troubleshooting.md
Gaze	embodiment/gaze/troubleshooting.md
Body Animation	embodiment/body-animation/troubleshooting.md
Body Language	embodiment/body-language/troubleshooting.md
Conversation Flow	embodiment/conversation-flow/troubleshooting.md

Next steps

When the Troubleshooter does not explain what you are seeing, move to the debug tools. Enabling verbose logging for a specific category and reading the ConvaiRoomManager runtime state narrows down most remaining issues.

Convai TroubleshooterDebug tools reference