获取商品图生成结果
1. 接口地址
https://hidreamai.com/api-pub/ec/v3/image/commerical/result
2. 请求方式
GET
3. 请求参数
Header
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
Authorization | string | 是 | 客户授权Token |
Query Params
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
task_id | string | 是 | 提交任务时返回的任务task_id |
request_id | string | 否 | 请求的ID,默认为"" |
curl示例
curl -H 'Authorization: Bearer {USER_Authorization}' -X GET
-v 'https://hidreamai.com/api-pub/ec/v3/image/commerical/result?task_id=2a94299c-5dd7-11ef-8f2e-7623a83533a8'
Python示例
import requests
import uuid
USER_Authorization = <token>
task_id = "2a94299c-5dd7-11ef-8f2e-7623a83533a8"
# 请求头
headers = {
'Authorization': f'Bearer {USER_Authorization}'
}
# 请求参数
params = {
'task_id': task_id,
'request_id': str(uuid.uuid4())
}
# 发送GET请求
url = 'https://hidreamai.com/api-pub/ec/v3/image/commerical/result'
response = requests.get(url, headers=headers, params=params)
# 处理响应
if response.status_code == 200:
if response.json()['code'] == 0:
results = response.json()['result']['sub_task_results']
for result in results:
print(f"task_status: {result['task_status']}, task_completion: {result['task_completion']}, image_url: {result['image']}")
else:
print(response.json()['message'])
else:
print(response.status_code)
4. 返回参数
参数 | 类型 | 说明 |
---|---|---|
code | int | 返回状态码 |
message | string | 返回状态信息 |
request_id | string | 本次请求的ID |
result | dict | 返回结果 |
其中返回结果 result
字段具体为:
参数 | 类型 | 说明 |
---|---|---|
task_id | string | 任务的task_id |
sub_task_results | list | 各个子任务的生成结果 |
其中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, eg.'https://storage.hidreamai.com/image/p_5cc025ec-5dd7-11ef-a082-368c61127f7d.png (opens in a new tab)' |
示例:
{
"code": 0,
"message": "Success",
"request_id": "425d6094-3a73-11ee-85e2-0a4fb61b1c34",
"result": {
"sub_task_results": [
{
"image": "https://storage.hidreamai.com/image/p_5cc025ec-5dd7-11ef-a082-368c61127f7d.png",
"sub_task_id": "94ecd4e4-7d90-4daa-8edb-f3ee02fafa19",
"task_completion": 1,
"task_status": 1
}
],
"task_id": "2a94299c-5dd7-11ef-8f2e-7623a83533a8"
}
}