API 公共约定

接口域名

API 示例统一使用生产域名：

https://co.aippt.cn

文档中的 URL、任务 ID、用户 ID 和鉴权信息均为示例，接入时需要替换为接入方自己的真实数据。

公共 Header

Header	是否必传	说明
x-api-key	是	开放平台分配的 App Key
x-token	是	通过 获取认证 TOKEN 获得
x-channel	是	渠道标识，无渠道区分时传空值

需要 AK/SK 签名的接口，请按 鉴权 中的签名规则传入 x-timestamp 和 x-signature。

x-token 只用于拼装版（API 版本）的开放 API 请求。预装版（UI 版本）初始化 iframe 时使用 code，不要把 token 直接暴露给前端页面。

示例中统一传入渠道标识：

--header 'x-channel: {{channel}}'

无渠道区分时传空值：

--header 'x-channel: '

占位符说明

占位符	说明
	接入方的 App Key
	接入方为当前用户获取的认证 TOKEN
	任务 ID
	接入方用户唯一标识
	异步任务查询凭证
	模板类型，1 为系统模板，2 为企业模板

响应格式

大多数接口返回以下结构：

{
  "code": 0,
  "data": {},
  "msg": "ok"
}

• code = 0 表示请求成功。
• code != 0 表示请求失败，具体错误请参考 鉴权 中的状态码说明。
• data 的结构由具体接口决定。

错误处理建议

场景	处理建议
鉴权失败	重新检查 x-api-key、x-token、x-timestamp 和 x-signature 是否匹配当前请求
任务不存在	检查 taskId 是否来自当前用户和当前接入方
生成未完成	继续按接口说明轮询或等待流式结束事件
生成失败	回到对应生成步骤重新提交，不要继续使用失败的中间结果
下载链接过期	重新调用对应导出或结果接口获取新的下载地址

流式响应

部分生成内容接口返回流式数据，常见格式如下：

event:message
data:{"content":"# 标题"}

event:close
data:api-close

接入方需要按 event:message 增量拼接 content，并在收到 event:close 后结束本次读取。

如果流式连接中断但没有收到 event:close，应按业务需要重新发起当前步骤或进入结果查询接口确认任务状态。