> 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.md).

# Getting Started with Unity Plugin

Get the Convai Unity SDK installed, configured, and verified with a quick conversation test.

## Introduction

The Convai Unity SDK lets you bring real-time conversational AI into your Unity projects—ideal for NPC dialogue, voice interactions, and interactive character experiences.

This Getting Started section is designed to guide you from a fresh Unity project to a successful “first conversation” using either a sample scene or your own custom scene.

{% embed url="<https://youtu.be/bxjGnOvNL4E>" %}
Create Conversational AI Avatars wth Real Time Lip Sync and HQ Facial Animations in Unity
{% endembed %}

## Overview

Use these pages depending on where you are in the process:

* **Installation**
  * **UPM** — easiest updates and dependency management
  * **Unity Asset Store** — Asset Store based distribution workflow
* **Setup**
  * **Configure API Key**
  * **Import & Run Sample Scenes**
  * **Custom Scene Setup**
  * **Add Chat UI (Transcript UI)**
  * **Add Lip Sync to Your Character**

## What’s next

If this is your first time installing Convai in Unity:

1. Start with **Install via UPM**
2. Continue to **Configure API Key**
3. Validate with **Sample Scenes** or **Custom Scene Setup**
4. Optionally add **Chat UI**
5. Optionally add **Lip Sync** for real-time facial animation

## Conclusion

You now have a clear path to install and validate the Convai Unity SDK. Start with **Installation**, then move to **Setup**, and finish with a quick test conversation.

{% 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.convai.com/api-docs/plugins-and-integrations/unity-plugin-beta-overview/getting-started.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.