> 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/zh/cha-jian-yu-ji-cheng/unity-plugin-beta-overview/getting-started/setup.md).

# 设置

## 简介

安装完成后，您将配置您的 Convai API 密钥，然后通过以下任一方式验证集成：

* Convai 的 **示例场景**，或者您自己的 **自定义场景设置**

## 概述

* **配置 API 密钥** *（必填）*

{% content-ref url="/pages/d2850f9a80d2e4d01e73f7443606f1a372fc0a29" %}
[配置 API 密钥](/api-docs/zh/cha-jian-yu-ji-cheng/unity-plugin-beta-overview/getting-started/setup/configure-api-key.md)
{% endcontent-ref %}

* **导入并运行示例场景** *（最快的验证方式）*

{% content-ref url="/pages/879353f362c48bb5bba26c156ac1adad76b9a361" %}
[导入并运行示例场景](/api-docs/zh/cha-jian-yu-ji-cheng/unity-plugin-beta-overview/getting-started/setup/import-and-run-sample-scenes.md)
{% endcontent-ref %}

* **自定义场景设置** *（集成到您的场景中）*

{% content-ref url="/pages/e0ad75ed70b30998d9aad999e815e78edb79416d" %}
[自定义场景设置](/api-docs/zh/cha-jian-yu-ji-cheng/unity-plugin-beta-overview/getting-started/setup/custom-scene-setup.md)
{% endcontent-ref %}

* **添加聊天界面** *（可选，文本输入 + 对话记录）*

{% content-ref url="/pages/ad50efa50c0b86db931678eb67333e50b359075c" %}
[添加聊天 UI（转录 UI）](/api-docs/zh/cha-jian-yu-ji-cheng/unity-plugin-beta-overview/getting-started/setup/add-chat-ui-transcript-ui.md)
{% endcontent-ref %}

* **为您的角色添加口型同步** *（可选，实时面部动画）*

## 推荐路径

1. 配置 API 密钥
2. 导入并运行一个示例场景
3. （可选）设置自定义场景
4. （可选）添加聊天界面
5. （可选）为您的角色添加口型同步

### 结论

您已准备好配置您的项目并运行第一次对话测试。首先从以下内容开始： **配置 API 密钥**.

{% hint style="info" %}
**需要帮助？** 如有问题，请访问 [**Convai 开发者论坛**](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/zh/cha-jian-yu-ji-cheng/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.