> 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/getting-started.md).

# Getting started

By the end of this section, your project contains a responsive AI character that listens, processes speech through Convai, and responds in real time. Follow the pages in order — each step builds directly on the previous one.

{% hint style="info" %}
**Before you begin:** Confirm your environment meets the requirements on the [Prerequisites](/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/prerequisites.md) page — Unity version, required packages, and a Convai account with an API key.
{% endhint %}

### Preparation

<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>Prerequisites</strong><br>Unity version, required packages, and account requirements before installing.</td><td><a href="/pages/9c9a13d2a745ff9a78da0c1790759ba17484a304">/pages/9c9a13d2a745ff9a78da0c1790759ba17484a304</a></td></tr><tr><td><strong>Installation</strong><br>Add the Convai Unity SDK to your project via the Package Manager or Asset Store.</td><td><a href="/pages/f1aef51364acf8a4bf5802a99774c033d9ee6e68">/pages/f1aef51364acf8a4bf5802a99774c033d9ee6e68</a></td></tr></tbody></table>

### Scene setup

<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>Configure API key</strong><br>Connect your project to Convai with your account API key.</td><td><a href="/pages/nLYDmLXfx19u9jY8DiYD">/pages/nLYDmLXfx19u9jY8DiYD</a></td></tr><tr><td><strong>Import and run sample scenes</strong><br>Verify the SDK works before building your own scene.</td><td><a href="/pages/41c4fa4e32b4314bedf2eeac4548c536e758ce3f">/pages/41c4fa4e32b4314bedf2eeac4548c536e758ce3f</a></td></tr><tr><td><strong>Scene components reference</strong><br>Learn what ConvaiManager, ConvaiCharacter, and ConvaiPlayer do and how they depend on each other.</td><td><a href="/pages/0ovsiZNbY51a9fHPtneG">/pages/0ovsiZNbY51a9fHPtneG</a></td></tr><tr><td><strong>Build a custom scene</strong><br>Build a Convai scene from scratch using the Setup Required Components command.</td><td><a href="/pages/KM3jUMFCMu4M0nS1MSJH">/pages/KM3jUMFCMu4M0nS1MSJH</a></td></tr><tr><td><strong>Validate your setup</strong><br>Run the scene validator to confirm required components are present before adding features.</td><td><a href="/pages/35a808a76b0d30cee351c5b850b110058a2eb840">/pages/35a808a76b0d30cee351c5b850b110058a2eb840</a></td></tr><tr><td><strong>Configure conversation input mode</strong><br>Choose between hands-free and push-to-talk input.</td><td><a href="/pages/2532db82ab7e792207320a0655ef32ccfd5f99e4">/pages/2532db82ab7e792207320a0655ef32ccfd5f99e4</a></td></tr><tr><td><strong>Configure character audio</strong><br>Tune NPC voice volume, spatial audio, and mute controls.</td><td><a href="/pages/MGgUuRj5tRGxy8aDaXHd">/pages/MGgUuRj5tRGxy8aDaXHd</a></td></tr><tr><td><strong>Configure microphone</strong><br>Select the active microphone device and set up platform permissions for Android, iOS, and WebGL.</td><td><a href="/pages/vzAH1RAH4ciuh2ypEwaO">/pages/vzAH1RAH4ciuh2ypEwaO</a></td></tr><tr><td><strong>Add chat UI</strong><br>Display conversation transcripts in your scene.</td><td><a href="/pages/3b61dcb812f9a6f38643f1fce0883e718828e8d1">/pages/3b61dcb812f9a6f38643f1fce0883e718828e8d1</a></td></tr><tr><td><strong>Add lip sync</strong><br>Drive character blendshapes in sync with voice audio.</td><td><a href="/pages/96d3c58b6fd5623574443837c77ebcb98c1071e6">/pages/96d3c58b6fd5623574443837c77ebcb98c1071e6</a></td></tr></tbody></table>

### Next steps

Once you have validated your setup, explore the Features section to add Actions, Emotion, Long-Term Memory, or Vision to your characters.

{% content-ref url="/pages/d5302389270319f4ca9bf82b6b3081d22b81bd8f" %}
[Features](/api-docs/plugins-and-integrations/convai-unity-sdk/features.md)
{% endcontent-ref %}

Review Core Concepts for a deeper understanding of the session lifecycle and event system before building further.

{% content-ref url="/pages/e324eb9293dfc478fb2c227def03dca5d44cc512" %}
[Core concepts](/api-docs/plugins-and-integrations/convai-unity-sdk/core-concepts.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:

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

The question should be specific, self-contained, and written in natural language.
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.