Appearance
API 介绍
AI-DOL Open API 采用 API Key + 请求签名 的认证方式,所有业务接口统一使用 POST 方法。
接口地址
- UAT 环境:https://open.aibabe.studio
- 生产环境:https://open.ai-dol.io
对接流程
- 获取凭证:从 AI-DOL 获取您的专属
apiKey和apiSecret - 联调测试:双方进行接口联调测试(建议先对接 UAT 环境)
- 正式上线:测试通过后切换至生产环境
接口列表
| 接口路径 | 说明 |
|---|---|
POST /v1/chat/conversation | 创建会话 |
POST /v1/chat/stream | 流式聊天(SSE) |
POST /v1/chat/image | 聊天图片生成 |
POST /v1/chat/tts | 语音播报 |
POST /v1/chat/inspire | 灵感回复建议 |
POST /v1/agent/list | 智能体列表 |
POST /v1/agent/face-detect | 人脸检测 |
POST /v1/agent/cover | 生成自定义角色封面 |
POST /v1/agent/create | 创建自定义角色 |
POST /v1/config/options | 素材选项查询 |
POST /v1/live/list | 直播列表 |
POST /v1/live/detail | 直播详情 |
POST /v1/image/upload | 上传参考图 |
POST /v1/image/generate | 自定义生图 |
通用响应格式
所有接口成功时返回统一 JSON 结构:
json
{
"code": 10200,
"success": true,
"message": "OK",
"data": { ... },
"traceId": "9fU0kfWy3E8YFGjS5S8bLPlAXG8xhdTH",
"timestamp": "1773298769366"
}业务错误以 HTTP 200 返回,通过 success: false 区分:
json
{
"code": 10400,
"success": false,
"message": "错误描述"
}错误处理
HTTP 状态码
| 状态码 | 说明 |
|---|---|
401 | 鉴权失败:缺少请求头、时间戳过期、API Key 无效或签名错误(此时不返回通用响应结构) |
除 401 外,业务接口的参数校验、资源不存在、上游服务异常、限流等错误,默认返回 HTTP 200,并在响应体中通过 success: false + code/message 体现错误原因。
code(业务码)
| code | 说明 |
|---|---|
10200 | 成功 |
10400 | 请求参数错误 / 业务校验失败(含限流与总量限制) |
10401 | 未授权(业务层) |
10403 | 无权限 |
10404 | 资源不存在 |
10500 | 服务端内部错误 / 上游服务异常 |