Skip to content

API 介绍

AI-DOL Open API 采用 API Key + 请求签名 的认证方式,所有业务接口统一使用 POST 方法。

接口地址

对接流程

  1. 获取凭证:从 AI-DOL 获取您的专属 apiKeyapiSecret
  2. 联调测试:双方进行接口联调测试(建议先对接 UAT 环境)
  3. 正式上线:测试通过后切换至生产环境

接口列表

接口路径说明
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服务端内部错误 / 上游服务异常

Released under the MIT License.