通用XL pro-文生图--人像人体-火山引擎

文档中心

导航

通用XL pro-文生图

最近更新时间：2024.08.19 16:02:21首次发布时间：2024.08.12 16:09:09

接口简介

面向通用场景，延迟要求极高，效果要求较高通用XL PRO（文生图），推荐在通用类别，延迟要求极高，效果要求较高的场景进行使用。

请求说明

名称	内容
接口地址	https://visual.volcengineapi.com
请求方式	POST
Content-Type	application/json

请求参数
（1）header请求参数
公共请求参数
以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见公共参数

名称	类型	是否必填	描述
X-Date	String	是	使用UTC时间，精确到秒。请使用格式：`YYYYMMDD'T'HHMMSS'Z'` ，例如：`20201103T104027Z`
Authorization	String	是	HMAC-SHA256：签名方法 -Credential为签名凭证，其中: -AccessKeyId为访问密钥ID，可在访问密钥（Access Key）获取； -ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：`YYYYMMDD`，例如：`20180201`； -Region为请求地区，国内一般为为`cn-north-1`； -Service为请求的服务，一般为`cv`； -SignedHeaders为参与签名计算的头部信息，`content-type` 和 `host` 为必选头部； -Signature为签名，可在签名方法获取。注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考快速接入例如：`HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}`
X-Security-Token	String	否	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

（2）Query参数
业务请求参数

参数	可选/必选	类型	说明
Action	必选	String	接口名，取值：Text2ImgXLSft
Version	必选	String	版本号，取值：2022-08-31

（3）Body参数
业务请求参数

参数	可选/必选	类型	说明	备注
req_key	必选	String	算法名称，取固定值为t2i_xl_sft
prompt	可选	String	用于生成图像的提示词，支持中英文输入，建议内容简洁准确，控制在100中文字/英文单词以内，超出部分对生成效果影响较小
width	可选	int	生成图像的宽默认值：1024	宽、高与1024差距过大，则出图效果不佳、延迟过长概率显著增加。建议比例及对应宽高：widthheight 1:1：10241024 4:3：1024768 3:4：7681024 3:2：1024682 2:3：6821024 16:9：1024576 9:16：5761024 21:9：1195*512
height	可选	int	生成图像的高默认值：1024
seed	可选	int	随机种子，-1为不随机种子；其他为指定随机种子
ddim_step	可选	int	生成图像的步数默认值：20 取值范围[1-50]
scale	可选	float	影响文本描述的程度默认值：7.0 取值范围[1, 30]
return_url	可选	bool	输出是否返回图片链接
logo_info	可选	LogoInfo	水印信息

LogoInfo
水印相关信息。

名称	类型	必选	描述
add_logo	Boolean	否	是否添加水印。True为添加，False不添加。默认不添加
position	Int	否	水印的位置，取值如下： 0-右下角 1-左下角 2-左上角 3-右上角默认0
language	Int	否	水印的语言，取值如下： 0-中文（AI生成） 1-英文（Generated by AI）默认0
opacity	Float	否	水印的不透明度，取值范围0-1，1表示完全不透明，默认0.3

（4）请求示例

{
    "req_key": "t2i_xl_sft",
    "prompt": "一个小女孩",
    "seed": -1,
    "width": 1080,
    "height": 1080,
    "scale": 7,
    "ddim_steps": 20,
    "return_url": true,
    "logo_info": {
        "add_logo": true,
        "position": 2,
        "language": 0,
        "opacity": 1
    }
}

输出说明

（1）通用输出参数
请参考通用返回字段及错误码
（2）业务输出参数
data 字段说明

字段	类型	说明
binary_data_base64	array of string	返回图片的base64数组。
image_urls	array of string	输出处理过的图片url 数组（单张图）

（3）输出示例

{
    "code": 10000,
    "data": {
        "algorithm_base_resp": {
            "status_code": 0,
            "status_message": "Success"
        },
        "binary_data_base64": [],
        "comfyui_cost": 4,
        "custom_prompt": "一个小女孩",
        "ddim_steps": 20,
        "height": 1080,
        "image_urls": [
            "https://xxx"
        ],
        "logo_info": {
            "add_logo": true,
            "language": 0,
            "opacity": 1,
            "position": 2
        },
        "prompt": "A little girl.",
        "request_id": "dea044aa84a71449ec93580e29e41d33ebc028cbbf5717fa70318ef2a047cfc6",
        "return_url": true,
        "scale": 7,
        "seed": -1,
        "width": 1080
    },
    "message": "Success",
    "request_id": "2024080914280691301FD211D72A02FA4F",
    "status": 10000,
    "time_elapsed": "5.507397584s"
}

错误码

（1）通用错误码
请参考通用返回字段及错误码
（2）业务错误码

HttpCode	错误码	错误消息	描述
200	10000	无	请求成功
400	50411	Pre Img Risk Not Pass	输入图片前审核未通过
400	50511	Post Img Risk Not Pass	输出图片后审核未通过
400	50412	Text Risk Not Pass	输入文本前审核未通过
400	50512	Post Text Risk Not Pass	输出文本后审核未通过
400	50413	Post Text Risk Not Pass	输入文本NER、IP、Blocklist等拦截