批量查询图片结果
说明
1. 接口地址
https://www.hidreamai.com/api-pub/gw/v2/image/<MODULE>/async
其中MODULE为生图模型，目前支持以下几种：
| 类型 | 说明 |
|---|---|
| txt2img | 文生图 |
| img2img | 图生图 |
| inpainting | 智能重绘 |
| outpainting | 智能拓图 |
| img2svg | 矢量图 |
2. 请求方式
POST
3. 请求参数
Header
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| Authorization | string | 是 | 客户授权Token |
| Content-Type | string | 是 | 使用json传参 |
| API-User-ID | string | 否 | 用户唯一标识 |
Body
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| task_id_list | list | 是 | 需要查询的任务的id列表 |
| notify_url | string | 否 | 任务完成回调通知接口(需公网能访问)，请求体包含main_task_id(任务的task_id）、result |
curl示例
curl -H 'Authorization: Bearer {USER_Authorization}' -H 'Content-Type: application/json' -X POST -d '{
"task_id_list": ["3fe836e2-e1ce-11ee-975a-76ad3c0ace6b", "56bb8770-e1ce-11ee-81f0-76ad3c0ace6b"],
}' -v 'https://www.hidreamai.com/api-pub/gw/v2/image/txt2img/async/results/batch'
Python示例
import requests
import json
USER_Authorization = <token> # 获取方式详见接口文档https://www.hidreamai.com/docs/pixeling/user/token.html
# 请求头
headers = {
'Authorization': f'Bearer {USER_Authorization}',
'Content-Type': 'application/json',
'API-User-ID': '' # 可选的用户唯一标识
}
# 请求体参数
data = {
"task_id_list": ["3fe836e2-e1ce-11ee-975a-76ad3c0ace6b", "56bb8770-e1ce-11ee-81f0-76ad3c0ace6b"]
}
# 发送POST请求
url = 'https://www.hidreamai.com/api-pub/gw/v2/image/txt2img/async/results/batch'
response = requests.post(url, headers=headers, data=json.dumps(data))
# 处理响应
if response.status_code == 200:
if response.json()['code'] == 0:
results = response.json()['result']
for result in results:
sub_task_results = result['sub_task_results']
for sub_task_result in sub_task_results:
print(f"task_status: {sub_task_result['task_status']}, task_completion: {sub_task_result['task_completion']}, image_url: {sub_task_result['image']}")
else:
print(response.json()['message'])
else:
print(response.status_code)
4. 返回参数
| 参数 | 类型 | 说明 |
|---|---|---|
| code | int | 返回状态码 |
| message | string | 返回状态信息 |
| request_id | string | 本次请求的ID |
| result | list | 返回结果 |
| 参数 | 类型 | 说明 |
|---|---|---|
| task_id | string | 任务的task_id |
| sub_task_results | list | 各个子任务的生成结果(若传入的task_id_list参数中存在不存在任务，则对应的sub_task_results字段为空列表。) |
其中sub_task_result字段具体为
| 参数 | 类型 | 说明 |
|---|---|---|
| sub_task_id | string | 子任务的task_id |
| task_status | int | 子任务的状态，0: 等待中，1: 完成，2: 处理中，3: 失败，4：未通过审核 |
| task_completion | float | 子任务的进度，取值范围为0-1的小数点后保留2位的小数 |
| image | string | 生成的图片的url |
示例：
{
"code": 0,
"message": "请求成功",
"request_id": "b9bc5570-e1ce-11ee-a98d-5e84dd40ad42",
"result": [
{
"sub_task_results": [
{
"image": "https://storage.hidreamai.com/image/p_6e9daec2-e1ce-11ee-bbfd-525400d58a02.jpg",
"image_wm": "https://storage.hidreamai.com/image/p_6e9daec2-e1ce-11ee-bbfd-525400d58a02_wm.jpg",
"sub_task_id": "09509d6b-c8ee-40aa-9271-f28ab4f54d69",
"task_completion": 1,
"task_status": 1
},
{
"image": "https://storage.hidreamai.com/image/p_9e1aecaa-e1ce-11ee-9ea9-525400d58a02.jpg",
"image_wm": "https://storage.hidreamai.com/image/p_9e1aecaa-e1ce-11ee-9ea9-525400d58a02_wm.jpg",
"sub_task_id": "229ed0d1-5195-472f-8a75-f1a9f322c78f",
"task_completion": 1,
"task_status": 1
},
{
"image": "https://storage.hidreamai.com/image/p_56d989dc-e1ce-11ee-8f80-525400d58a02.jpg",
"image_wm": "https://storage.hidreamai.com/image/p_56d989dc-e1ce-11ee-8f80-525400d58a02_wm.jpg",
"sub_task_id": "87e44817-7bd5-474a-bf0d-7cd435664711",
"task_completion": 1,
"task_status": 1
}
],
"task_id": "3fe836e2-e1ce-11ee-975a-76ad3c0ace6b"
},
{
"sub_task_results": [
{
"image": "https://storage.hidreamai.com/image/p_86315ed0-e1ce-11ee-a9e1-525400d58a02.jpg",
"image_wm": "https://storage.hidreamai.com/image/p_86315ed0-e1ce-11ee-a9e1-525400d58a02_wm.jpg",
"sub_task_id": "6d8375da-8878-434d-a89f-90c2c525c080",
"task_completion": 1,
"task_status": 1
}
],
"task_id": "56bb8770-e1ce-11ee-81f0-76ad3c0ace6b"
}
]
}