# HiDream 图片生成 API文档

# 1. HiDream接口描述

HiDream接口提供非实时图片生成能力，先发起图片生成请求任务，再通过任务查询接口获取图片链接。

支持通过prompt、image、prompt+image的方式，进行图片生成。

# 1.1. 接口Demo

HiDream demo python语言 (opens new window)

# 1.2. 接口要求

接口类型：非流式 [http(s)]
接口鉴权：使用签名机制进行鉴权，签名详情参照 “接口鉴权 (opens new window)”

注：全链路请求会话时长不超过1分钟

# 2. 接口列表

# 2.1. 任务创建

2.1.1 接口地址

https://cn-huadong-1.xf-yun.com/v1/private/s3fd61810/create

2.1.2 请求查询参数：

POST，application/json

2.1.3 请求数据：

{
        "header": {
            "app_id": "xxxxxx",
            "status": 3,
            "channel": "default",
            "callback_url": "default"
        },
        "parameter": {
            "oig": {
                "result": {
                    "encoding": "utf8",
                    "compress": "raw",
                    "format": "json"
                }
            }
        },
        "payload": {
            "oig": {
                "encoding": "utf8",
                "compress": "raw",
                "format": "json",
                "status": 3,
                "text": text
            }
        }
    }

字段	类型	说明	必填	默认值
header	string	协议头部，用于描述平台特性的参数
header.app_id	string	平台申请的app id信息	是
header.status	int	请求方式，可选值为：3-一次传完	否	3
header.channel	string	通道,可选值为default	是	default
header.callback_url	string	回调,可选值为default,"maxLength":1024	是	default
parameter	string	AI 能力功能参数
parameter.oig.result.encoding	object	取值范围utf8, gb231	否	utf8
parameter.oig.result.compress	string	取值范围raw, gzip	否	raw
parameter.oig.result.format	string	取值范围plain, json, xml	否	json
payload	string	请求参数
payload.oig.text	string	最小尺寸:0B, 最大尺寸:1048576B。base64编码	是

text字段示例：

	{
        "image": [image],  
        "prompt": "大闹天空",
        "aspect_ratio": "1:1",
        "negative_prompt": "",
        "img_count": 1,
        "resolution": "2k"
    }

字段	含义	类型	取值范围	示例	说明
image	图片数组, 支持url或base64	array	--	[]	--
prompt	图片生成提示词	string	字符长度0 ~ 2000的字符串	--	prompt和image至少填一个
aspect_ratio	图片比例	string	--	1:1	--
negative_prompt	禁止生成的提示词	string	字符长度0 ~ 2000的字符串	--	--
img_count	一次生成的图片数量	int	1: 生成1张图片2: 生成2张图片3: 生成3张图片4: 生成4张图片	1	--
resolution	生成图片的分辨率 (目前仅支持2k)	string	2k: 2k分辨率	2k	--

2.1.4 响应成功示例：

{
    "header":{
    	"code":0,	//返回码，0表示成功，其他为异常
        "message":"success",			
        "sid" : "xxxxxxxxxxxxxxxxxxxx",		//请求唯一id
        "task_id" : "xxxxxxxxxxxxxxxxxxx"	// 本次图片生成请求的任务id
    }
    "payload":null
}

# 2.2. 任务查询

2.2.1 接口地址

https://cn-huadong-1.xf-yun.com/v1/private/s3fd61810/query

2.2.2 请求查询参数：

POST，application/json

2.2.3 请求数据：

{
    "header": {
        "app_id": "xxxxxx",
        "task_id": "xxxxxxxxxxxx"  # 填写创建任务时返回的task_id
    }
}

字段	含义	类型	说明
header	平台公共协议段	Object	用于传递平台框架使用的相关公共参数。
header.app_id	在平台申请app_id信息	string
header.task_id	任务唯一标识	string	由任务创建接口返回。

2.2.4 响应数据：

{
    "header": {
    	"code":0,	//返回码，0表示成功，其他为异常
        "message":"success", 
        "task_id": "xxxxxx",
        "task_status": "3"
    },
    "payload": {
        "result": {
            "encoding": "utf8",
            "compress": "raw",
            "format": "json",
            "status": 3,
            "text": ""  //图片信息，需base64解码
        }
    }
}

字段	含义	类型	说明
header	平台公共协议段	Object
task_id	任务唯一标识	string
task_status	任务状态	string	1：待处理 2：处理中 3：处理完成 4：回调完成
encodingw	文本编码	string
compress	文本压缩格式	string
format	文本格式	string
status	数据请求类型	int	3:一次性传完
text	图片数据	string	base64编码格式

在这篇文章中：