提交局部重绘任务
1. 接口地址
https://www.hidreamai.com/api-pub/gw/v2/image/inpainting/async
2. 请求方式
POST
3. 请求参数
Header
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| Authorization | string | 是 | 客户授权Token |
| Content-Type | string | 是 | 使用json传参 |
| X-accept-language | string | 否 | 语言偏好，支持['en', 'zh']，en：英文，zh：中文，默认"zh" |
| API-User-ID | string | 否 | 用户唯一标识 |
Body
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| image | string | 是 | 待重绘的图片，支持传入图片的base64值/URL地址 |
| mask | string | 是 | 图片掩码的base64值/URL地址 |
| prompt | string | 是 | 重绘内容的提示词 |
| notify_url | string | 否 | 任务完成回调通知接口(需公网能访问)，请求体包含main_task_id(任务的task_id）、sub_task_results |
curl示例
curl -H 'Authorization: Bearer {USER_Authorization}' \
-H 'Content-Type: application/json' \
-X POST \
-d '{
"image": {image},
"mask": {mask},
"prompt": "apple",
}' \
-v 'https://www.hidreamai.com/api-pub/gw/v2/image/inpainting/async'Python示例
import requests
import json
import uuid
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 = {
"image": "", # 必选参数
"mask": "", # 必选参数
"prompt": "" # 必选参数
}
# 发送POST请求
url = 'https://www.hidreamai.com/api-pub/gw/v2/image/inpainting/async'
response = requests.post(url, headers=headers, data=json.dumps(data))
# 处理响应
if response.status_code == 200:
if response.json()['code'] == 0:
task_id = response.json()['result']['task_id']
print(task_id)
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 | 返回任务ID |
| sub_task_ids | list | 返回子任务ID的列表，子任务定义为生成单张图片的任务 |
示例
{
"code":0,
"message":"Success",
"request_id":"ccfc092e-8430-11ee-97ff-f60f825045d5",
"result":{
"sub_task_ids":["7ae9bc98-db8f-4bf7-86ff-e5bdd84e2311"],
"task_id":"cd23b1ae-8430-11ee-97ff-f60f825045d5"
}
}