跳转到内容
中文

创建任务

POST /v1/tasks

提交一个异步生成任务。成功即返回 taskId不等待生成完成;随后通过获取任务详情轮询,或等待终态回调

Authorization Bearer YOUR_API_KEY 必填

账号 API Key,所有请求必填。

Content-Type application/json 必填

请求体为 JSON。

model string 必填

目标 HiAPI 对外模型名。

示例 happyhorse-1-0
input object 必填

该模型的业务参数对象。字段由各模型自行定义,参考对应模型页。

callback object 可选

终态通知配置;为空则不回调,由调用方自行查询。

url string 必填

callback 存在时必填;任务终态后向该 URL 发起 POST,须为合法 http(s) URL。

when string 可选

当前仅支持 final,即 success / fail 均回调。

默认 final
{
"code": 200,
"message": "success",
"data": {
"taskId": "tk-hiapi-01HZTQ8BX2N3GM3YFK4Z9D7VQR"
}
}
  • taskId 形如 tk-hiapi- + 26 位字符,全长 35 字符。
  • 创建成功即返回,不等待生成完成。
{
"code": 400,
"message": "invalid request",
"data": null,
"error_code": "INVALID_REQUEST"
}

code 为 HTTP 状态码,error_code 为业务错误码(枚举见状态码)。平台暂时不可用时可能返回 HTTP 503,请按退避策略稍后重试。