Skip to content

API 介绍

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

接口列表

接口路径说明
POST /v1/chat/conversation创建会话
POST /v1/chat/stream流式聊天(SSE)
POST /v1/chat/image聊天图片生成
POST /v1/chat/tts语音播报
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": 40000,
  "success": false,
  "message": "错误描述"
}

HTTP 错误码

状态码说明
401认证失败:缺少请求头、时间戳过期、API Key 无效或签名错误
400请求参数缺失或格式错误
404资源不存在
500服务端内部错误

Released under the MIT License.