调用方式--图像技术-火山引擎

文档中心

导航

调用方式

最近更新时间：2023.01.18 22:25:31首次发布时间：2023.01.18 22:25:31

接口简介

多模态风格化图片生成。适用于生成风格化较强及较为抽象的图片生成场景，支持用户输入文本prompt及参考图，通过参数调节生成贴近原图或文本描述的图片。

限制条件

名称	内容
图片要求	1. 图片格式：JPG、JPEG、PNG、BMP等常见格式，建议使用JPG格式。 2. 图片大小及分辨率：最大 5 MB，分辨率需要大于64x64，小于4096x4096。

请求说明

名称	内容
接口地址	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	接口名，取值：Img2ImgStyle
Version	必选	String	版本号，取值：2022-08-31

（3）Body参数

业务请求参数

参数	可选/必选	类型	说明
req_key	必选	string	算法名称，取固定值为img2img_style
prompt	必选	string	引导词文本，控制转换图像风格，可支持多种语言。不要一次请求时混合输入多种语言，中文建议在100字以内，英文单词数小于等于77个单词（超出部分会对生成结果无影响）
strength	可选	float	文本控制强度，0.0<strength<1.0之间，越小越接近原图，越大越接近文本控制，默认为0.5
seed	可选	int	随机种子，作为确定扩散初始状态的基础，默认-1（随机）。若随机种子为相同正整数且其他参数均一致，则生成图片极大概率效果一致
binary_data_base64	可选	array of string	输入图片的base64数组，与image_url二选一，如果两者同时有值，以binary_data_base64为准，此算法需要输入1张图片，图片比例越接近9:16或尺寸越接近384*640效果越好
image_url	可选	string	输入图片的url，与binary_data_base64二选一，如果两者同时有值，以binary_data_base64为准，图片比例越接近9:16或尺寸越接近384*640效果越好

输出说明

（1）通用输出参数

请参考通用返回字段及错误码

（2）业务输出参数

data 字段说明

字段	类型	说明
binary_data_base64	array of string	输出图片的base64数组，在入参binary_data_base64生效时返回此字段，此算法会返回1张768*1280的图
image_url	string	输出图片的URL，在入参image_url生效时返回此字段，此算法会返回1张768*1280的图

（3）输出示例

{
    "code":10000,
    "data":{
        "binary_data_base64":["xxx"],
        "image_url": "",
    },
    "message":"Success",
    "request_id":"20220926182941010212157201024017C6",
    "status":10000,
    "time_elapsed":"456.790505ms"
}

错误码

（1）通用错误码

请参考通用返回字段及错误码

（2）业务错误码

HttpCode	错误码	错误消息	描述
200	10000	无	请求成功