快速开始¶
本指南帮助你在 5 分钟内完成 UPath AI 导师平台接入。
接入流程¶
第一步：注册账号¶
访问 UPath 官网 完成账号注册：
- 填写手机号，获取短信验证码
- 填写用户名、密码、邮箱等信息
- 完成注册后自动获得体验余额
提示
新注册用户自动获得体验余额，可用于体验 AI 导师对话功能。
第二步：创建 API Key¶
登录 UPath 官网控制台：
- 进入控制台，点击「API 密钥」菜单
- 点击「创建密钥」，输入密钥名称（如：测试密钥）
- 保存生成的
api_key，后续调用接口时使用
重要
API Key 创建后请妥善保管，不要泄露给他人。
第三步：获取 AI 导师配置¶
调用 getScenes 接口获取 AI 导师场景配置和 RTC 连接信息：
请求地址：POST https://api.upath.cn/api/aigc/getScenes
请求头：
| 参数 | 值 |
|---|---|
| X-API-Key | 你的 API Key |
| Content-Type | application/json |
请求参数：
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| scene_name | string | 否 | AI 导师场景名称，不传返回所有场景 |
| RoomId | string | 是 | 房间 ID，自定义字符串 |
| UserId | string | 否 | 用户 ID |
响应说明：
响应中包含各个 AI 导师场景（如英语老师、数学老师等）及 rtc 字段，提供 RTC SDK 连接所需的配置信息。
第四步：开启 AI 导师对话¶
调用 StartVoiceChat 接口开始与 AI 导师的语音对话：
请求地址：POST https://api.upath.cn/api/aigc/proxy?Action=StartVoiceChat
请求参数：
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| SceneID | string | 是 | AI 导师场景 ID |
| inputParams.RoomId | string | 是 | 房间 ID，与 getScenes 保持一致 |
余额检查
调用 StartVoiceChat 前会自动检查账户余额，余额不足时返回错误。
第五步：结束对话¶
调用 StopVoiceChat 接口结束与 AI 导师的对话：
请求地址：POST https://api.upath.cn/api/aigc/proxy?Action=StopVoiceChat
请求参数：
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| SceneID | string | 是 | AI 导师场景 ID |
| inputParams.RoomId | string | 是 | 房间 ID |
响应说明：
响应中包含 BillingInfo 字段，显示本次对话的计费信息：
| 字段 | 说明 |
|---|---|
| duration_seconds | 对话时长（秒） |
| total_charge | 本次费用（元） |
| balance_after | 扣费后余额 |
注意事项¶
- RoomId 一致性：getScenes、StartVoiceChat、StopVoiceChat 中的 RoomId 必须一致
- 余额管理：请及时在 官网控制台 充值，余额不足时无法开启新的对话
- 房间复用：同一 RoomId 重复调用 StartVoiceChat 会先结算上次费用
- 对话管理：
- 推荐：在客户端实现语音活动检测和倒计时自动关闭，参考 示例项目
- 快速接入：设置
EnableStatusMonitor: true，服务端会在 AI 导师状态 5 分钟未更新时自动关闭 - 超时保护：对话超过 2 小时未主动关闭会自动结束并计费（服务端兜底）