> 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/installation/install-via-upm.md).

# Install via UPM

Install the Convai Unity SDK via the Unity Package Manager using the package name.

## Introduction

UPM installation is the recommended approach because it’s easy to maintain, update, and keep consistent across a team.

## Prerequisites

* A Unity project opened in the Unity Editor

## Step-by-step

{% stepper %}
{% step %}
**Open Package Manager**

In Unity, go to **Window → Package Manager**.
{% endstep %}

{% step %}
**Add the package from Git URL**

* Click the **+** button (top-left).
* Select **Install package by name**
* Copy the package name below and paste it into the Package Name field. Then click **Install**.
  * `com.convai.convai-sdk-for-unity`

<figure><img src="https://413558230-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEtUJA212Zc1S9ACc8T4l%2Fuploads%2F2vazLeCME6OCutgept2d%2Fimage.png?alt=media&amp;token=fb3fcabd-6e45-4245-a3b6-fbb67fcee3e6" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Verify the installation**

* Wait for Unity to finish importing and compiling.
* Open **Console** (if needed): **Ctrl + Shift + C** (Windows) / **Cmd + Shift + C** (macOS)
* **Expected result:** No errors in Console, and a **Convai** menu appears in the top toolbar.
  {% endstep %}
  {% endstepper %}

## Troubleshooting

* **Console errors after install**
  * Confirm you are using a supported Unity version.

## Conclusion

You’ve installed the Convai Unity SDK via UPM and confirmed the editor compiled successfully. Next, go to **Setup → 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 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/installation/install-via-upm.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.