文档
智能擦除请求接口

提交智能擦除任务

1. 接口地址

https://www.hidreamai.com/api-pub/gw/v3/images/image_erase/async

 

2. 请求方式

POST

 

3. 请求参数

Header

参数类型是否必填说明
Authorization(用户授权)string客户授权Token
Content-Type(传递内容)string使用json传参
X-accept-languagestring语言偏好,支持['en', 'zh'],en:英文,zh:中文,默认为"zh"
API-User-IDstring用户唯一标识

Body

参数类型是否必填说明
imagestring原始图片,支持传入图片的base64值/URL地址
maskstring蒙版图片,为黑白图片,与image的size相同,白色代表要消除的区域,支持传入图片的base64值/URL地址
versionstring模型版本,默认为"v1",可选范围为{"v1"}
notify_urlstring任务完成回调通知接口(需公网能访问),请求参数与task result 一致
request_idstring请求的ID,默认为""

说明:

curl示例

curl -H 'Authorization: Bearer {USER_Authorization}' \
     -H 'Content-Type: application/json' \
     -X POST \
     -d '{
        "image": "https://storage.hidreamai.com/image/j_583e6d82-ff47-48fb-81f8-e5f6bf4d97c4.jpg",
        "mask": "https://storage.hidreamai.com/image/p_0e61c553-cf7b-4519-84b2-e25c16056386.png",
        "version": "v1",
        "request_id": "b146d886-5c57-11ee-bf2b-f6f8d60dadec"
     }' \
     -v 'https://www.hidreamai.com/api-pub/gw/v3/images/image_erase/async'
 

Python示例

import requests
import json
import uuid
 
USER_Authorization = <token>
 
 
# 请求头
headers = {
    'Authorization': f'Bearer {USER_Authorization}',
    'Content-Type': 'application/json',
    'API-User-ID': ''  # 可选的用户唯一标识
}
 
# 请求体参数
data = {
    "image": "https://storage.hidreamai.com/image/j_583e6d82-ff47-48fb-81f8-e5f6bf4d97c4.jpg",
    "mask": "https://storage.hidreamai.com/image/p_0e61c553-cf7b-4519-84b2-e25c16056386.png",
    "version": "v1",
    "request_id": "b146d886-5c57-11ee-bf2b-f6f8d60dadec"
}
 
# 发送POST请求
url = 'https://www.hidreamai.com/api-pub/gw/v3/images/image_erase/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. 返回参数

参数类型说明
codeint返回状态码
messagestring返回状态信息
request_idstring本次请求的ID
resultdict返回结果

其中返回结果 result字段具体为:

参数类型说明
task_idstring返回任务ID
sub_task_idslist返回子任务ID的列表,子任务定义为生成单张图片的任务

示例:

{
    "code":0,
    "message":"Success",
    "request_id":"ccfc092e-8430-11ee-97ff-f60f825045d5",
    "result":{
        "sub_task_ids":["0465305f-19b8-446c-be85-14d4541eddf7"],
        "task_id":"2b3cee2e-3aaa-11ef-9496-3a18d93f3388"
    }
}