> 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/unity-plugin-beta-overview/getting-started/setup.md).

# Setup

## Introduction

After installation, you’ll configure your Convai API key and then validate the integration using either:

* Convai’s **Sample Scenes**, or Your own **Custom Scene Setup**

## Overview

* **Configure API Key** *(required)*

{% content-ref url="/pages/ech6xFERj6ZiG6jgzdbi" %}
[Configure API Key](/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/configure-api-key.md)
{% endcontent-ref %}

* **Import & Run Sample Scenes** *(fastest validation)*

{% content-ref url="/pages/W0Tbd48Kq4DJDFDHWlug" %}
[Import & Run Sample Scenes](/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/import-and-run-sample-scenes.md)
{% endcontent-ref %}

* **Custom Scene Setup** *(integrate into your scene)*

{% content-ref url="/pages/iB3djtAzpp1zDO09QJEp" %}
[Custom Scene Setup](/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/custom-scene-setup.md)
{% endcontent-ref %}

* **Add Chat UI** *(optional, text input + transcript)*

{% content-ref url="/pages/gS9VFYqJTGsrKsnpALQ1" %}
[Add Chat UI (Transcript UI)](/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started/setup/add-chat-ui-transcript-ui.md)
{% endcontent-ref %}

* **Add Lip Sync to Your Character** *(optional, real-time facial animation)*

## Recommended path

1. Configure API Key
2. Import and run a sample scene
3. (Optional) Set up a custom scene
4. (Optional) Add Chat UI
5. (Optional) Add Lip Sync to Your Character

### Conclusion

You’re ready to configure your project and run your first conversation test. Start with **Configure API Key**.

{% hint style="info" %}
**Need help?** For questions, please visit the [**Convai Developer Forum**](https://forum.convai.com/).
{% endhint %}


---

# 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/unity-plugin-beta-overview/getting-started/setup.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.