API 参考

同合云公开接口采用统一的 HTTP + JSON 设计,覆盖用户信息、文件管理、任务管理,以及图片 / 音频 / 视频处理能力。本文汇总通用约定,便于你快速理解所有接口的共性。

基础信息

项目
Base URLhttps://api.ai-mcn.tv:10000
协议HTTPS
数据格式JSON,文件上传接口使用 multipart/form-data
鉴权方式Authorization 请求头直接传 API Key

鉴权约定

所有业务接口都要求在请求头中携带 API Key:

Authorization: YOUR_API_KEY

⚠️ 注意:系统不会解析 Bearer 前缀。若写成 Authorization: Bearer YOUR_API_KEY,会直接鉴权失败。

详细说明请参见 鉴权方式

请求规范

  • 文件上传接口:POST /base/file/upload,使用 multipart/form-data
  • 其余大多数接口:使用 application/json
  • 所有处理类接口都基于异步任务模型,先创建任务,再查询任务结果
  • 时间字段统一为 ISO 8601 风格字符串

统一响应格式

所有接口都会返回以下结构:

{
  "code": 200,
  "msg": "success",
  "data": {}
}
字段类型说明
codenumber业务状态码。成功时通常为 200
msgstring状态说明或错误信息
dataobject / string / null响应数据。部分接口成功时也可能返回空字符串

任务状态

状态值说明
created任务已创建,尚未进入队列
queued任务已入队,等待处理
processing任务处理中
completed任务处理完成
failed任务处理失败
cancelled任务已取消

文件生命周期

  • 上传文件默认保留 60 天
  • 同内容文件重复上传时,系统会根据指纹复用已有文件记录
  • 文件过期后可被续期或重新上传

通用错误码

错误码HTTP 状态码说明解决方案
400400请求参数或请求体格式错误检查 JSON 格式和参数类型
401401未认证检查请求头 Authorization
413413请求体过大压缩文件或缩小请求内容
415415Content-Type 不受支持使用 application/jsonmultipart/form-data
6001400不支持的文件类型使用受支持的媒体格式
6002413文件大小超过限制上传 20 GB 以内文件
6004404文件不存在检查 file_id 是否正确
6006404任务不存在检查 task_id 是否正确
6007400当前任务状态不允许取消created / queued 状态支持取消
6013400必填参数缺失补充缺失字段
6014400文件类型与任务类型不匹配确认上传文件与接口能力一致
6015400语言代码不受支持使用系统支持的语言代码
6016400任务参数类型或取值非法检查字段类型与枚举值
6019400媒体时长不合法或超限截短媒体后重试
6022400视频分辨率超出限制降低输入分辨率或输出倍率
6201402配额不足购买配额包或充值
6202402余额不足前往仪表盘充值
6502401鉴权失败使用真实 API Key 填充 Authorization 请求头
500500服务器内部错误稍后重试,必要时联系支持

接口分类