> 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/api-can-kao/core-api-reference/live-apis-beta.md).

# 实时 API（测试版）

{% hint style="danger" %}
Live API 仅适用于企业版方案。
{% endhint %}

Convai 的 **Live API** 通过……实现用户与 AI 角色之间的实时动态交互 **WebRTC**.\
这些 API 允许您的应用发送和接收 **audio**, **文本**、以及其他上下文数据，使与 AI 角色的对话无缝且响应迅速。

一旦创建了角色，Live API 会自动管理对话输入和上下文响应，确保在各个会话中表现自然且一致。

#### **借助 Live API，您可以：**

* **参与实时对话** — 发送用户文本或语音输入，并实时接收具有关联上下文、自然的回复。
* **以文本和/或音频形式获取回复** — 同时支持基于文本的聊天和语音对话体验。
* **使用实时模型** — 集成低延迟模型（目前支持 Google Realtime；OpenAI 支持即将推出），以实现高速对话性能。

该 **Live API** 充当您的 AI 角色与用户之间的桥梁，实现双方之间顺畅的双向通信，覆盖 **文本** 和 **语音** 渠道——全部实时进行。

***

#### 从哪里开始

| Page                                                                                                             | 涵盖内容                               |
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| [Connect API](/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/connect-api.md)                         | 打开会话以及您可以在其中配置的所有选项                |
| [使用多角色会话](/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/multi-character-sessions.md)                | 创建包含多个角色实例的共享房间、路由轮次并更新成员列表        |
| [轮次生命周期和消息顺序](/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/turn-lifecycle-and-message-ordering.md) | 机器人轮次如何传递、您可以依赖的顺序，以及字段存在规则        |
| [响应契约与解析](/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/response-contract-and-parsing.md)           | 语音、动作和情绪如何分离——以及服务器会从口语回复中准确移除哪些内容 |
| [消息术语表](/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/message-glossary.md)                          | 一览所有消息类型                           |
| [客户端到服务器的消息](/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/client-to-server-messages.md)            | 您发送的消息                             |
| [服务器到客户端的消息](/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/server-to-client-messages.md)            | 您接收的消息                             |
| [音频数据（通过数据通道）](/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/audio-data-via-data-channel.md)        | 自定义音频处理                            |
| [指标](/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/metrics.md)                                      | 性能指标和监控                            |

{% hint style="info" %}
如果您是从零开始编写客户端，请先阅读 [轮次生命周期和消息顺序](/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/turn-lifecycle-and-message-ordering.md) 。它解释了数据通道上的三种包络格式以及顺序保证，这两者合起来解释了大多数集成问题。
{% 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, and the optional `goal` query parameter:

```
GET https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.