> For the complete documentation index, see [llms.txt](https://docs.convai.com/api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk.md).

# Convai Unity SDK

The Convai Unity SDK connects Unity projects to Convai, bringing conversational AI into training simulations, interactive experiences, and games. Characters process speech in real time, respond with natural language, and synchronize lip movement, facial emotion, and body animation — all configurable per project. Each feature is a self-contained module: add only what your project needs, in the order that fits your workflow.

{% hint style="info" %}
**New to the SDK?** Follow [Getting started](/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started.md) to install the package, configure your API key, and run your first AI character.
{% endhint %}

### Learn the SDK

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Overview</strong><br>What the SDK is, how it is structured, and when to use each module.</td><td><a href="/pages/a3d7afb80b74f02afa29c790d79751f4f29227c8">/pages/a3d7afb80b74f02afa29c790d79751f4f29227c8</a></td></tr><tr><td><strong>Compatibility and requirements</strong><br>Unity versions, render pipelines, platform support, and network requirements.</td><td><a href="/pages/ijdGXp5AdxHr05KBoBHM">/pages/ijdGXp5AdxHr05KBoBHM</a></td></tr><tr><td><strong>Core concepts</strong><br>Session lifecycle, turn-taking modes, and the SDK event system.</td><td><a href="/pages/e324eb9293dfc478fb2c227def03dca5d44cc512">/pages/e324eb9293dfc478fb2c227def03dca5d44cc512</a></td></tr><tr><td><strong>Embodiment</strong><br>Gaze, body animation, body language, conversation flow, and emotion modules for character behavior.</td><td><a href="/pages/5RuK3poQnrGRdFg2G84l">/pages/5RuK3poQnrGRdFg2G84l</a></td></tr><tr><td><strong>AI coding assistant</strong><br>Unity MCP integration that lets AI coding agents build Convai scenes from prompts.</td><td><a href="/pages/oXL608mEMdrEEudHoaSJ">/pages/oXL608mEMdrEEudHoaSJ</a></td></tr></tbody></table>

### Features

Each feature is a self-contained module you opt into.

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Actions</strong><br>Characters execute structured in-scene commands dispatched by Convai.</td><td><a href="/pages/8e2d39906eb40512aa9c4c6b05ffc3352eb87e51">/pages/8e2d39906eb40512aa9c4c6b05ffc3352eb87e51</a></td></tr><tr><td><strong>Emotion</strong><br>Map Convai emotion signals to facial blendshapes or Animator parameters.</td><td><a href="/pages/pzyAnwgRmeSToQBXFJYu">/pages/pzyAnwgRmeSToQBXFJYu</a></td></tr><tr><td><strong>Long-term memory</strong><br>Characters remember each player across separate sessions.</td><td><a href="/pages/Yg6rMK5Mnh9zStBOwoca">/pages/Yg6rMK5Mnh9zStBOwoca</a></td></tr><tr><td><strong>Vision</strong><br>Characters see through a Unity camera, webcam, or Meta Quest passthrough.</td><td><a href="/pages/c776d88f01e63c32eee310e37d0ed10bc12eb355">/pages/c776d88f01e63c32eee310e37d0ed10bc12eb355</a></td></tr><tr><td><strong>Dynamic context</strong><br>Inject runtime state and events into character knowledge at any time.</td><td><a href="/pages/HLRHVibG6Nqvot1DGfvc">/pages/HLRHVibG6Nqvot1DGfvc</a></td></tr><tr><td><strong>Narrative design</strong><br>Trigger-based story section progression tied to conversation flow.</td><td><a href="/pages/vN4t84KHA949ufTTNaVd">/pages/vN4t84KHA949ufTTNaVd</a></td></tr><tr><td><strong>Scene metadata</strong><br>Characters automatically read contextual information about scene objects.</td><td><a href="/pages/a62866eb2b9826eb452e50eb8875192eb2464f3c">/pages/a62866eb2b9826eb452e50eb8875192eb2464f3c</a></td></tr></tbody></table>

### Reference and guides

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>UI and presentation</strong><br>Transcript UI, subtitle modes, notification system, and settings panel.</td><td><a href="/pages/26837dafaf3d20063e1664f52a690823bbbb0eb7">/pages/26837dafaf3d20063e1664f52a690823bbbb0eb7</a></td></tr><tr><td><strong>Scripting reference</strong><br>Full API reference for session events, character events, and the transcript system.</td><td><a href="/pages/cd1efd3a5ca8009cafe359f0b008bc9d6038de38">/pages/cd1efd3a5ca8009cafe359f0b008bc9d6038de38</a></td></tr><tr><td><strong>Platform guides</strong><br>WebGL, Android, iOS, and Meta Quest deployment guides.</td><td><a href="/pages/d375c5c4e58f4a666f3cb8c940558eb222674e75">/pages/d375c5c4e58f4a666f3cb8c940558eb222674e75</a></td></tr><tr><td><strong>Advanced topics</strong><br>Custom providers, performance, and SDK extension points.</td><td><a href="/pages/50715c11049002775f940f15ab236a3bc207395c">/pages/50715c11049002775f940f15ab236a3bc207395c</a></td></tr><tr><td><strong>Troubleshooting</strong><br>Common failure modes, diagnostic steps, and known issues.</td><td><a href="/pages/d5350da7bd6402bba0c66f41fe2dadd0116fb2da">/pages/d5350da7bd6402bba0c66f41fe2dadd0116fb2da</a></td></tr></tbody></table>

### Latest release

v<code class="expression">space.vars.unity\_sdk\_version</code> introduces the embodiment family of character-behavior modules: Gaze, Body Animation, Body Language, Conversation Flow, and Emotion. The five modules share one per-character setup and read the same dialogue state, so a character looks, moves, and reacts as one behavior rather than five independent ones. This release also adds an Auth Token authentication mode that resolves a short-lived credential before each connection, so a player build ships without an account API key. The Actions Editor is rebuilt around a curated catalog of 21 built-in actions and provisions an action's executor and its character-side components in a single undoable operation. A new `Convai > Troubleshooter` window reports setup problems per module. The SDK requires Unity <code class="expression">space.vars.unity\_min\_version</code>. See [Release notes](/api-docs/plugins-and-integrations/convai-unity-sdk/overview/release-notes.md) for the complete changelog.

### Next steps

Install the Convai Unity SDK and connect your first AI character using the Getting started section. If you are evaluating the SDK before installing, review [Compatibility and requirements](/api-docs/plugins-and-integrations/convai-unity-sdk/compatibility-and-requirements.md) to confirm platform and Unity version support.

{% content-ref url="/pages/1d9fa274483952ca377014dd2a4fb49c2f3e80a1" %}
[Getting started](/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.convai.com/api-docs/plugins-and-integrations/convai-unity-sdk.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.