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

# Prerequisites

Confirm the Unity version, package dependencies, and Convai account the Convai Unity SDK requires before you begin installation.

Before installing the Convai Unity SDK, confirm that your environment meets the requirements below. Missing any of these causes installation errors or runtime failures that are harder to diagnose after the fact.

### System requirements

| Requirement         | Minimum                                                        |
| ------------------- | -------------------------------------------------------------- |
| Unity version       | <code class="expression">space.vars.unity\_min\_version</code> |
| Scripting backend   | Mono or IL2CPP                                                 |
| Internet connection | Required at editor time and runtime                            |

{% hint style="warning" %}
Unity <code class="expression">space.vars.unity\_min\_version</code> is a hard floor — there is no supported configuration on an earlier release, including older LTS versions such as Unity 2022 or Unity 2023. If your project targets an older release, upgrade the project to Unity 6 before installing the SDK. There is no workaround.
{% endhint %}

### Required Unity packages

The SDK depends on four Unity packages. Both installation methods (Package Manager and Asset Store) install these automatically — you do not need to add them manually unless you encounter a version conflict.

| Package                           | Minimum version                                                           |
| --------------------------------- | ------------------------------------------------------------------------- |
| `com.unity.ai.inference`          | <code class="expression">space.vars.dep\_ai\_inference\_version</code>    |
| `com.unity.nuget.newtonsoft-json` | <code class="expression">space.vars.dep\_newtonsoft\_json\_version</code> |
| `com.unity.ugui`                  | <code class="expression">space.vars.dep\_ugui\_version</code>             |
| `com.unity.inputsystem`           | <code class="expression">space.vars.dep\_inputsystem\_version</code>      |

If your project already pins any of these packages to an older version in `Packages/manifest.json`, the automatic install fails silently or produces a version conflict. Remove or update the existing version pins before installing the SDK.

### Supported render pipelines

| Render Pipeline                        | Supported |
| -------------------------------------- | --------- |
| Built-in Render Pipeline               | ✓         |
| Universal Render Pipeline (URP)        | ✓         |
| High Definition Render Pipeline (HDRP) | ✓         |

For detailed platform and render pipeline compatibility, see [Compatibility & Requirements](/api-docs/plugins-and-integrations/convai-unity-sdk/compatibility-and-requirements.md).

### Account requirements

You need an active Convai account and an API key to connect your project to Convai during local development.

1. Create an account at [convai.com](https://convai.com) if you do not have one.
2. Retrieve your API key from the **API Keys** section of the Convai dashboard.
3. Create at least one character in the Convai dashboard and note its **Character ID** — you need it during scene setup.

Your API key is stored in `Assets/Resources/ConvaiSettings.asset`. This is the **API Key** authentication mode, intended for local development in the Unity Editor rather than for a build you distribute. See [Configure the API key](/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/configure-api-key.md) for full setup steps.

If your project ships to testers or players, the SDK also supports **Auth Token** mode, which resolves a short-lived credential per connection instead of shipping your account API key in the build. Review the two modes and decide which one your project needs before you reach scene setup.

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

### Next steps

Once your environment meets all requirements above, install the SDK.

{% content-ref url="/pages/f1aef51364acf8a4bf5802a99774c033d9ee6e68" %}
[Install the Convai Unity SDK](/api-docs/plugins-and-integrations/convai-unity-sdk/getting-started/installation.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 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/convai-unity-sdk/getting-started/prerequisites.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.