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

# API 参考

- [核心 API 参考](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference.md): 探索 Convai 的核心 API，分为角色构建 API 和交互 API，用于创建、自定义并与智能 AI 角色交互。
- [角色构建 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis.md): 使用 Convai 的角色构建 API 创建和配置 AI 角色，以定义其个性、行为、知识等。
- [角色基础 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/character-api.md): 创建你自己的智能 AI 角色所需的所有相关 API。
- [背景故事 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/backstory-api.md): 使用流式 API 端点根据简短描述和名称生成角色背景故事，仅适用于付费计划。
- [Mindview API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/mindview-api.md): 获取用于构建响应的对话上下文，可以来自已存储的会话，也可以来自当前角色设置。
- [核心 AI 设置 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/core-ai-settings-api.md): 修改你的 Convai 角色核心 AI 设置所需的所有相关 API。
- [叙事设计 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/narrative-design-api.md): 本页列出了与叙事设计交互所需的所有 API
- [知识库 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/knowledge-bank-api.md): 使用 Convai 与你的 AI 角色的知识库交互所需的所有相关 API。
- [外部 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/external-api.md): 创建、列出、关联和删除外部 API 函数，以便你的角色能在对话中调用自定义 Python 代码。
- [动作 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/action-api.md): 参考面向现有客户端保留的基于字符串的 Action API 工作流，并查找面向新集成的 Agentic Actions 和 Live API 替代方案。
- [聊天历史 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/chat-history-api.md): 与会话或角色聊天历史交互所需的所有相关 API。
- [聊天历史删除 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/chat-history-delete-api.md): 用于删除角色会话的 API 端点。
- [评估 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/evaluation-api.md): 根据用户定义的属性（例如回复清晰度、礼貌性、倾听能力等）评估对话记录的 API。
- [语言列表 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/language-list-api.md): 用于检索用户可用的完整语言列表，包括公开和私有语言。
- [语音列表 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/voice-list-api.md): 用于检索用户可用的完整语音列表，包括公开和私有语音。
- [角色列表 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/character-list-api.md): 用于检索用户创建的角色列表的 API。
- [自定义 LLM API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/custom-llm-api.md): 在 Convai 上管理你的私有 LLM 集成。通过简单的 API 端点安全地注册、更新或删除与 OpenAI 兼容的自定义模型。
- [文本转语音 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/text-to-speech-api.md): 本页解释了如何使用独立的文本转语音（TTS）API，通过从可用语音列表中选择的语音，基于给定转录生成音频。
- [流式转录 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/streaming-transcription-api.md): 使用 WebSockets 将音频流式传输到 Convai 的 ASR 引擎，并接收实时转录。专为与你的 AI 角色实现低延迟、智能语音体验而设计。
- [MCP 服务器 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/mcp-server-api.md): 注册 MCP 服务器，使用静态请求头或 OAuth 将其连接，并以编程方式将它们附加到角色上。
- [Live APIs（Beta）](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta.md): 通过基于 WebRTC 的 Live APIs 实现与 Convai AI 角色的实时、低延迟交互，支持文本、音频和动态上下文通信。
- [连接 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/connect-api.md): 为你的 Convai 角色建立一个实时聊天机器人会话，使用户能够通过音频或视频连接并保持对话上下文。
- [使用多角色会话](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/multi-character-sessions.md): 创建一个包含多个角色的 Live API 房间，映射它们的媒体，切换活动角色，并安全地更新成员列表。
- [构建群聊](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/build-a-group-chat.md): 创建一个 Live API 房间，让多个角色回答同一条消息，收集带归属的回复，并在对话结束时关闭房间。
- [群聊消息](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/group-chat-messages.md): 用于通过 Live APIs 运行群聊房间的管理员客户端收发消息的参考，包括字段、错误和轮次结果。
- [指标](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/metrics.md): 本页解释了通过 WebRTC 数据通道发送给客户端的指标。
- [音频数据（通过数据通道）](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/audio-data-via-data-channel.md): 本页解释了通过 WebRTC 数据通道发送给客户端的指标。
- [消息术语表](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/message-glossary.md): Convai Live API 中用于客户端与服务器之间实时通信的所有消息类型的完整术语表。
- [客户端到服务器消息](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/client-to-server-messages.md): 参考客户端通过 WebRTC 数据通道发送到 Convai Live API 服务器的所有消息，包括载荷、字段和响应细节。
- [服务器到客户端消息](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/server-to-client-messages.md): Convai 在 Live API 中通过 WebRTC 数据通道发送给客户端的所有消息的完整参考，包括字段、类型和建议操作。
- [轮次生命周期与消息顺序](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/turn-lifecycle-and-message-ordering.md): 了解 Live API 轮次传递，包括旧版文本、规范输出、动作结果续接、关联和顺序保证。
- [响应契约与解析](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/response-contract-and-parsing.md): 了解旧版和规范模型输出、原始文本投影、动作解析、客户端执行反馈以及保留的响应模式。
- [交互 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/interaction-apis.md): 使用 Convai 的交互 API，实现与 AI 角色的实时交互，以自然的文本和语音方式进行通信。
- [交互 API（Beta）](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/interaction-apis/interaction-api-beta.md): 使用 Convai 的交互 API 启用实时对话式 AI。向你的 AI 角色发送文本消息，并通过服务器发送事件（SSE）接收自然、流式的回复。
- [交互 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/interaction-apis/interaction-api.md): 本页详细说明了如何与角色交互。


---

# 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.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.