主题
查询任务
所有请求均需携带 API Key。基础地址及响应格式见通用约定。
图片与视频任务使用同一组查询接口。保存创建响应中的 taskId,进入成功或失败终态后停止轮询。
表格较宽时,可左右滑动查看完整内容。
| 场景 | 接口 | 返回内容 |
|---|---|---|
| 查看提示词、参数、积分及结果 | GET /generation/detail | 完整任务详情 |
| 仅跟踪单个任务进度与结果 | GET /generation/status | 状态、进度、输出及错误信息 |
| 同时跟踪多个任务 | POST /generation/status/batch | 最多 100 个任务的状态列表 |
建议每 10~15 秒查询一次。状态含义和异常处理见错误处理与轮询。
查询生成任务详情
作用:使用 API Key 查询图片或视频生成任务详情。
请求:GET /generation/detail?taskId={taskId}
请求示例
将 YOUR_TASK_ID 替换为实际任务 ID。
bash
curl 'https://api.video.aistarslab.com/openapi/generation/detail?taskId=YOUR_TASK_ID' \
-H "Authorization: Bearer $AISTARSLAB_API_KEY"输入参数
表格较宽时,可左右滑动查看完整内容。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| taskId | string | 是 | 创建接口返回的任务业务 ID |
返回参数
HTTP 200 且 response.code=0 时,response.data:
表格较宽时,可左右滑动查看完整内容。
| 属性名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| taskId | string | 是 | 任务业务 ID |
| type | integer | 是 | 生成类型编码 |
| channel | string | 是 | 生成线路编码 |
| model | string | 是 | 模型编码 |
| prompt | string | 是 | 生成提示词 |
| status | integer | 是 | 任务状态编码 |
| progress | integer | 否 | 任务进度,范围 0-100 |
| outputs | array<string> | 否 | 平台最终输出 URL 列表 |
| inputs | Inputs | 否 | 输入素材 |
| options | Options | 否 | 创建选项 |
| costCredits | integer | 是 | 本次任务实际消耗积分 |
| errorCode | string | 否 | 错误码 |
| errorMessage | string | 否 | 错误信息,仅失败终态返回 |
| createdAt | string | 是 | 创建时间 |
| updatedAt | string | 是 | 更新时间 |
| completedAt | string | 否 | 任务完成时间 |
Inputs
表格较宽时,可左右滑动查看完整内容。
| 属性名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| images | array<string> | 否 | 输入参考图片 URL 列表 |
| videos | array<string> | 否 | 输入参考视频 URL 列表 |
| audios | array<string> | 否 | 输入参考音频 URL 列表 |
Options
表格较宽时,可左右滑动查看完整内容。
| 属性名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| aspectRatio | string | 否 | 画幅比例 |
| quality | string | 否 | 质量/清晰度档位 |
| duration | integer | 否 | 视频时长,单位:秒;图片任务为空 |
| n | integer | 否 | 生成数量 |
查询生成任务状态
作用:使用 API Key 查询单个图片或视频生成任务状态。
请求:GET /generation/status?taskId={taskId}
请求示例
将 YOUR_TASK_ID 替换为实际任务 ID。
bash
curl 'https://api.video.aistarslab.com/openapi/generation/status?taskId=YOUR_TASK_ID' \
-H "Authorization: Bearer $AISTARSLAB_API_KEY"输入参数
表格较宽时,可左右滑动查看完整内容。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| taskId | string | 是 | 创建接口返回的任务业务 ID |
返回参数
HTTP 200 且 response.code=0 时,response.data:
表格较宽时,可左右滑动查看完整内容。
| 属性名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| taskId | string | 是 | 任务业务 ID |
| type | integer | 是 | 生成类型编码 |
| status | integer | 是 | 任务状态编码 |
| progress | integer | 否 | 任务进度,范围 0-100 |
| outputs | array<string> | 否 | 平台最终输出 URL 列表 |
| errorCode | string | 否 | 错误码 |
| errorMessage | string | 否 | 错误信息,仅失败终态返回 |
批量查询生成任务状态
作用:使用 API Key 批量查询图片或视频生成任务状态。
请求:POST /generation/status/batch
Content-Type:application/json
请求示例
将 YOUR_TASK_ID 替换为实际任务 ID。
bash
curl 'https://api.video.aistarslab.com/openapi/generation/status/batch' \
-H "Authorization: Bearer $AISTARSLAB_API_KEY" \
-H 'Content-Type: application/json' \
--data '{"taskIds":["YOUR_TASK_ID"]}'输入参数
表格较宽时,可左右滑动查看完整内容。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| taskIds | array<string> | 是 | 任务业务 ID 列表,不能为空,最多 100 个;元素不能为空字符串 |
返回参数
HTTP 200 且 response.code=0 时,response.data 为 array<OpenApiGenerationStatusResp>:
表格较宽时,可左右滑动查看完整内容。
| 属性名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| taskId | string | 是 | 任务业务 ID |
| type | integer | 是 | 生成类型编码 |
| status | integer | 是 | 任务状态编码 |
| progress | integer | 否 | 任务进度,范围 0-100 |
| outputs | array<string> | 否 | 平台最终输出 URL 列表 |
| errorCode | string | 否 | 错误码 |
| errorMessage | string | 否 | 错误信息,仅失败终态返回 |
状态响应示例
以下为单任务状态接口的结构示例;详情接口还包含提示词、输入、创建选项、积分与时间等字段。
json
{
"code": 0,
"msg": "success",
"data": {
"taskId": "task_example",
"type": 2,
"status": 2,
"progress": 35
}
}json
{
"code": 0,
"msg": "success",
"data": {
"taskId": "task_example",
"type": 2,
"status": 3,
"progress": 100,
"outputs": [
"https://example.com/result.mp4"
]
}
}json
{
"code": 0,
"msg": "success",
"data": {
"taskId": "task_example",
"type": 2,
"status": 4,
"errorCode": "task_failed",
"errorMessage": "生成失败,请检查提示词或素材"
}
}json
{
"code": 0,
"msg": "success",
"data": [
{
"taskId": "task_example",
"type": 2,
"status": 3,
"outputs": [
"https://example.com/result.mp4"
]
}
]
}失败示例中的错误码和提示语仅演示结构,应读取实际返回值。code=0 表示查询成功,即使查询到的任务已经失败,外层也可以是 0。