文档
文生图
文生图请求接口

提交文生图任务

1. 接口地址

https://www.hidreamai.com/api-pub/gw/v3/image/txt2img/async

 

2. 请求方式

POST

 

3. 请求参数

Header

参数类型是否必填说明
Authorizationstring是客户授权Token
Content-Typestring是使用json传参
API-User-IDstring否用户唯一标识

Body

参数类型是否必填说明
promptstring是生成图片的提示词，默认为""
negative_promptstring否禁止生成的提示词，默认为""
img_countint否一次生成的图片数量，1-4，默认为1
versionstring否模型版本，默认为"v2L"，可选范围为{"v2L"}
resolutionstring否分辨率"宽*高",
模型版本v2L，可选范围为 {"1024*1024", "832*1248", "880*1168", "768*1360", "1248*832", "1168*880", "1360*768"}
request_idstring否请求的ID，默认为""
notify_urlstring否任务完成回调通知接口(需公网能访问)，请求参数与task result 一致

curl示例

curl -H 'Authorization: Bearer {USER_Authorization}' -H 'Content-Type: application/json' -X POST -d '{
    "prompt": "Romantic painting of a ship sailing in a stromy sea, with dramatic lighting and powerful waves",
    "img_count": 1,
    "version": "v2L",
    "resolution": "1024*1024",
    "request_id": "b146d886-5c57-11ee-bf2b-f6f8d60dadec"
}' -v 'https://www.hidreamai.com/api-pub/gw/v3/image/txt2img/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 = {
    "prompt": "Romantic painting of a ship sailing in a stromy sea, with dramatic lighting and powerful waves",
    "negative_prompt": "sun",
    "aspect_ratio": "1:1",
    "img_count": 1,
    "version": "v2L",
    "resolution": "1024*1024",
    "request_id": str(uuid.uuid4())
}
 
# 发送POST请求
url = 'https://www.hidreamai.com/api-pub/gw/v3/image/txt2img/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": "请求成功",
    "request_id": "b146d886-5c57-11ee-bf2b-f6f8d60dadec",
    "result": {
        "sub_task_ids": [
            "d932ac2b-4591-4fc3-8995-adf81a87ce53"
        ],
        "task_id": "b2781982-5c57-11ee-bf2b-f6f8d60dadec"
    }
}
文生图文生图结果接口