> 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，用于创建、自定义并与智能 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): 使用 Convai 创建你自己的智能 AI 角色所需的所有相关 API。
- [背景故事 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/backstory-api.md): 了解如何使用背景故事 API 创建和管理角色背景故事，为你的 NPC 增添深度与个性。
- [思维视图 API](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/character-crafting-apis/mindview-api.md): 了解如何使用背景故事 API 创建和管理角色背景故事，为你的 NPC 增添深度与个性。
- [核心 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/action-api.md): 本页介绍动作 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): 通过 WebSocket 将音频流式发送到 Convai 的 ASR 引擎，并接收实时转写。专为与你的 AI 角色进行低延迟、智能语音体验而设计。
- [实时 API（Beta）](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta.md): 通过基于 WebRTC 的实时 API 启用与 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/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 实时 API 中所有可用于客户端与服务器之间实时通信的消息类型完整术语表。
- [客户端到服务器消息](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/client-to-server-messages.md): 参考客户端通过 WebRTC 数据通道发送到 Convai 实时 API 服务器的所有消息，包括负载、字段和响应详情。
- [服务器到客户端消息](https://docs.convai.com/api-docs/zh/api-can-kao/core-api-reference/live-apis-beta/server-to-client-messages.md): Convai 在实时 API 中通过 WebRTC 数据通道发送给客户端的所有消息的完整参考，包括字段、类型和推荐操作。
- [交互 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.