面向通用场景,延迟要求极高,效果要求较高通用XL PRO(文生图),推荐在通用类别,延迟要求极高,效果要求较高的场景进行使用。
名称 | 内容 |
---|---|
接口地址 | |
请求方式 | POST |
Content-Type | application/json |
完整公共参数列表见 公共参数
本服务Region为cn-north-1; Service为cv
拼接到url后的参数,示例:https://visual.volcengineapi.com?Action=CVProcess&Version=2022-08-31
参数 | 可选/必选 | 类型 | 说明 |
---|---|---|---|
Action | 必选 | String | 接口名,取值:Text2ImgXLSft |
Version | 必选 | String | 版本号,取值:2022-08-31 |
业务请求参数,放到request.body中,MIME-Type为application/json
参数 | 可选/必选 | 类型 | 说明 | 备注 |
---|---|---|---|---|
req_key | 必选 | String | 算法名称,取固定值为t2i_xl_sft | |
prompt | 可选 | String | 用于生成图像的提示词,支持中英文输入,建议内容简洁准确,控制在100中文字/英文单词以内,超出部分对生成效果影响较小 | |
width | 可选 | int | 生成图像的宽 | 宽、高与1024差距过大,则出图效果不佳、延迟过长概率显著增加。
|
height | 可选 | int | 生成图像的高 | |
seed | 可选 | int | 随机种子,-1为不随机种子;其他为指定随机种子 | |
ddim_steps | 可选 | int | 生成图像的步数 | |
scale | 可选 | float | 影响文本描述的程度 | |
return_url | 可选 | bool | 输出是否返回图片链接 | |
logo_info | 可选 | LogoInfo | 水印信息 |
LogoInfo
水印相关信息。
名称 | 类型 | 必选 | 描述 | 备注 |
---|---|---|---|---|
add_logo | Boolean | 否 | 是否添加水印。True为添加,False不添加。默认不添加 | |
position | Int | 否 | 水印的位置,取值如下: | |
language | Int | 否 | 水印的语言,取值如下: | |
logo_text_content | String | 否 | 明水印自定义内容 |
请参考通用返回字段及错误码
data 字段说明
字段 | 类型 | 说明 |
---|---|---|
binary_data_base64 | array of string | 返回图片的base64数组。 |
image_urls | array of string | 输出处理过的图片url |
{ "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, "logo_text_content": "这里是明水印内容" } }
{ "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等拦截 |
请参考SDK使用说明