接口文档--人像人体-火山引擎

文档中心

导航

接口文档

最近更新时间：2024.12.19 16:42:09首次发布时间：2024.11.05 20:56:47

接口简介

基于图生图技术，将输入图进行风格化，为用户生成具有艺术美感的高质量图片。

限制条件

名称	内容
图片要求	图片格式：仅支持JPG、JPEG、PNG格式，建议使用JPG格式。图片文件大小：最大 5 MB。图片分辨率：最小600 * 800，最大 4096 * 4096

请求说明

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

完整公共参数列表见公共参数
本服务Region为cn-north-1； Service为cv

Query参数

拼接到url后的参数，示例：https://visual.volcengineapi.com?Action=CVProcess&Version=2022-08-31

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

Body参数

业务请求参数，放到request.body中，MIME-Type为application/json

参数	可选/必选	类型	说明
req_key	必选	String	图像风格化风格列表，不同风格传入不同req_key 3D风: img2img_disney_3d_style 写实风：img2img_real_mix_style 天使风：img2img_pastel_boys_style 动漫风：img2img_cartoon_style 日漫风：img2img_makoto_style 公主风：img2img_rev_animated_style 梦幻风：img2img_blueline_style 水墨风：img2img_water_ink_style 新莫奈花园: i2i_ai_create_monet 水彩风：img2img_water_paint_style 莫奈花园：img2img_comic_style 精致美漫：img2img_comic_style 赛博机械：img2img_comic_style 精致韩漫：img2img_exquisite_style 国风-水墨：img2img_pretty_style 浪漫光影：img2img_pretty_style 陶瓷娃娃：img2img_ceramics_style 中国红：img2img_chinese_style 丑萌粘土：img2img_clay_style 可爱玩偶：img2img_clay_style 3D-游戏_Z时代：img2img_3d_style 动画电影：img2img_3d_style 玩偶：img2img_3d_style
sub_req_key	必选	String	图像风格化风格列表，不同风格传入不同sub_req_key，需要与req_key风格选择一致 3D风: 不需要传参写实风：不需要传参天使风：不需要传参动漫风：不需要传参日漫风：不需要传参公主风：不需要传参梦幻风：不需要传参水墨风：不需要传参新莫奈花园：不需要传参水彩风：不需要传参莫奈花园：img2img_comic_style_monet 精致美漫：img2img_comic_style_marvel 赛博机械：img2img_comic_style_future 精致韩漫：不需要传参国风-水墨：img2img_pretty_style_ink 浪漫光影：img2img_pretty_style_light 陶瓷娃娃：不需要传参中国红：不需要传参丑萌粘土：img2img_clay_style_3d 可爱玩偶：img2img_clay_style_bubble 3D-游戏_Z时代：img2img_3d_style_era 动画电影：img2img_3d_style_movie 玩偶：img2img_3d_style_doll
binary_data_base64	必选 (与image_urls二选一)	array of String	输入图片base64数组，仅支持一张图
image_urls	必选 (与binary_data_base64二选一)	array of String	图片文件URL
return_url	可选	bool	输出是否返回图片链接（链接有效期为24小时）
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
logo_text_content	String	否	明水印自定义内容

输出说明

通用输出参数

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

业务输出参数

重点关注data 字段，其他字段为公共返回

字段	类型	说明
binary_data_base64	Array of String	输出处理过的图片Base64数组（单张图）
image_urls	Array of String	输出图片url数组（单张图）

请求&返回完整示例

请求示例

{
    "req_key": "img2img_disney_3d_style",
    "image_urls": [
        "https://xxx"
    ],
    "return_url": True,
    "logo_info": {
        "add_logo": True,
        "position": 0,
        "language": 0,
        "opacity": 0.3,
        "logo_text_content": "这里是明水印内容"
    }
}

输出示例

{
    "code": 10000,
    "data": {
        "algorithm_base_resp": {
            "status_code": 0,
            "status_message": "Success"
        },
        "binary_data_base64": [
            "/9xxx",  //重点关注此返回，转换后的图片Base64
        ],
        "image_urls": [
            "https://xxx" //重点关注此返回，转换后的图片url
        ],
        //.... 其他不重要的返回数据
    },
    "message": "Success",
    "request_id": "202405201722544E4A22904AB5C20B42D5",
    "status": 10000,
    "time_elapsed": "5.849820164s"
}

错误码

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

SDK使用说明

请参考SDK使用说明

人像人体