API 概览¶
本文档提供 UPath AI 导师平台所有 API 接口的概览。
基础信息¶
| 项目 | 说明 |
|---|---|
| 基础 URL | https://api.upath.cn |
| 数据格式 | JSON |
| 字符编码 | UTF-8 |
接口分类¶
AIGC 接口（核心）¶
AI 导师核心接口，用于获取 AI 导师配置和进行语音对话。
| 接口 | 方法 | 说明 |
|---|---|---|
| /api/aigc/getScenes | POST | 获取 AI 导师场景配置 |
| /api/aigc/proxy?Action=StartVoiceChat | POST | 开启 AI 导师对话 |
| /api/aigc/proxy?Action=StopVoiceChat | POST | 结束 AI 导师对话 |
教材接口¶
基于 AI 的动态教材生成，支持文本、图片、视频、交互组件等多种内容类型。
| 接口 | 方法 | 说明 |
|---|---|---|
| /api/curriculum/ | POST | 创建教材 |
| /api/curriculum/ | GET | 获取教材列表 |
| /api/curriculum/{id}/ | GET | 获取教材详情 |
| /api/curriculum/{id}/updates/ | GET | 获取增量更新 |
| /api/curriculum/{id}/cancel/ | POST | 取消生成 |
| /api/curriculum/{id}/blocks/{block_id}/regenerate/ | POST | 重新生成 Block |
API 密钥¶
API 密钥用于调用 AIGC 接口，请在官网控制台进行管理。
| 操作 | 说明 |
|---|---|
| 创建密钥 | 在 官网控制台 创建 |
| 查看密钥 | 在 官网控制台 查看 |
| 删除密钥 | 在 官网控制台 删除 |
账户接口¶
用于查看账户信息和交易流水。
| 接口 | 方法 | 说明 |
|---|---|---|
| /api/transactions/ | GET | 获取交易流水 |
调用日志接口¶
用于查看 API 调用记录。
| 接口 | 方法 | 说明 |
|---|---|---|
| /api/api-call-logs/ | GET | 获取调用日志 |
控制台接口¶
用于获取统计数据和分析报表。
| 接口 | 方法 | 说明 |
|---|---|---|
| /api/dashboard/overview | GET | 控制台概览 |
| /api/dashboard/usage_trend | GET | 用量趋势 |
| /api/dashboard/api_stats | GET | API 统计 |
通用响应格式¶
成功响应¶
所有成功响应返回 HTTP 200，响应体为 JSON 格式。
错误响应¶
| 字段 | 说明 |
|---|---|
| success | false |
| message | 错误描述 |
| errors | 详细错误信息（可选） |
分页响应¶
列表接口支持分页，响应格式：
| 字段 | 说明 |
|---|---|
| count | 总记录数 |
| next | 下一页 URL |
| previous | 上一页 URL |
| results | 数据列表 |