人像保持--人像人体-火山引擎

文档中心

导航

人像保持

最近更新时间：2024.09.04 19:32:50首次发布时间：2024.07.16 17:19:22

接口简介

图生图能力，可以保持输出图片的人脸特征与输入「形象图」一致，输出图片风格支持通过「输入图」的风格、「风格图」的风格或文本prompt进行调节。

请求说明

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

限制条件

名称	内容
图片要求	图片格式：JPG(JPEG), PNG, BMP 等常见格式, 建议使用JPG格式. 2.最小 128 x 128 像素，最大 4096 x 4096 像素； base64格式下单张图片最大4.7Mb，2张图最大不超过8Mb.

请求参数
（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	接口名，取值：CVProcess
Version	必选	String	版本号，取值：2022-08-31

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

参数	可选/必选	类型	说明
req_key	必选	String	算法名称，取固定值为img2img_anime_accelerated_maintain_id
binary_data_base64	可选	array of String	如果需要传图，与image_urls二选一传入
image_urls	可选	array of String	如果需要传图，与binary_data_base64二选一传入
positive_prompt	可选	String	积极提示词，一般建议预置构图提示词和风格提示词（有特殊要求可联系火山引擎对接同学），同时接收终端用户写入的内容拼接好后传入。默认值：1girl,beautiful,looking at viewer,portrait,
hyper_switch	可选		加速hyper，文生图加速专用（需要关闭face_switch、facestyle_switch、style_switch），开启后step与cfg失效默认值：false
seed	可选	int	随机种子，-1为不随机种子；其他为指定随机种子默认值：-1
step	可选	int	默认值：18
cfg	可选	float	默认值：4.5
face_image	可选	string	输入形象图格式："uri://binary_data?index=0" （index对应输入图binary_data_base64/image_urls的下标）	未传时需要关闭face_switch、facestyle_switch、style_switch
style_image	可选	string	输入风格图格式："uri://binary_data?index=1" （index对应输入图binary_data_base64/image_urls的下标）	未传时需要关闭style_switch
face_switch	可选	bool	形象图人脸学习开关，打开则学习形象图的人脸特征默认值：false
facestyle_switch	可选	bool	形象图风格学习开关，打开则学习形象图的风格。facestyle_switch与style_switch强烈建议二选一，否则效果互有干扰且延迟长。默认值：false
style_switch	可选	bool	风格图的风格学习开关，打开则学习风格图的风格。风格图强烈不建议传入真人图片，可传入动漫人物或风格化明显的图片。默认值：false
width	可选	int	生成图像的宽默认值：1000 取值范围[600-1500]
height	可选	int	生成图像的高默认值：1000 取值范围[600-1500]
return_url	可选	bool	如果为true，则输出参数不再返回binary_data_base64，而是图片的url
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": "img2img_anime_accelerated_maintain_id",
    "positive_prompt": "1girl,beautiful,looking at viewer,portrait,",
    "return_url": True,
    "image_urls": [
        "https://xxx"],
    # "binary_data_base64": [],
    "hyper_switch": True,
    "seed": -1,
    "step": 18,
    "cfg": 4.5,
    "face_image": "uri://binary_data?index=0",
    "style_image": "uri://binary_data?index=1",
    "face_switch": True,
    "facestyle_switch": True,
    # "style_switch": False,
    "width": 1000,
    "height": 1000,
    "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": ["xxx"],
        "image_urls": [""],
        "request_id": ""
    },
    "message": "Success",
    "request_id": "2024061214082851989A35E4283DB7C8AD",
    "status": 10000,
    "time_elapsed": "16.52978614s"
}

错误码

（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等拦截