## 接口简介图片换装：基于用户输入的衣服图片，更换到指定的模特图上。即输入模特图A + 服装图B，输出A穿着指定服装B的照片 ## 限制条件 |名称 |内容 | |---|---| |输入图要求 |1. 图片格式：JPG(JPEG), PNG, JFIF 等常见格式, 建议使用JPG格式|\ | |2. 图片要求：小于5 MB，小于4096\*4096|\ | |3. 建议使用人物主体清晰的模特图与服装主体清晰的服装图，否则会导致出图效果不佳 | ## 请求说明 |名称 |内容 | |---|---| |接口地址 |[https://visual.volcengineapi.com](https://visual.volcengineapi.com/) | |请求方式 |POST | |**Content\-Type** |**application/json** | ### **Header参数** 完整公共参数列表见 [公共参数](https://www.volcengine.com/docs/6369/67268) 本服务**Region为cn\-north\-1，Service为cv** ### **Query参数** :::tip 拼接到url后的参数，示例：[https://visual.volcengineapi.com?Action=CVProcess&Version=2022-08-31](https://visual.volcengineapi.com?Action=CVProcess&Version=2022-08-31) ::: |参数 |可选/必选 |类型 |说明 | |---|---|---|---| |Action |必选 |String |接口名，取固定值：CVProcess | |Version |必选 |String |版本号，取固定值：2022\-08\-31 | ### **Body参数** :::warning 业务请求参数，放到request.body中，MIME\-Type为**application/json** ::: |参数 |可选/必选 |类型 |说明 |备注 | |---|---|---|---|---| |req_key |必选 |String |算法名称，取固定值为**dressing_diffusion** | | |model |必选 |Model |模特配置 | | |garment |必选 |Garment |服装配置 | | |inference_config |可选 |InferenceConfig |推理配置 | | |return_url |可选 |bool |输出是否返回图片链接 **（链接有效期为24小时）** | | |logo_info |可选 |LogoInfo |水印信息 | | **Model** 模特配置相关参数 |名称 |必选 |类型 |描述 |备注 | |---|---|---|---|---| |id |是 |String |模特ID| |\ | | | |建议值："1" | | |url |是 |String |模特图URL | | |protect_mask_url |否 |String |模特保护区域图URL |* 输入格式：PNG格式，保护区域为255，非保护区域为0|\ | | | | |* 上传时需要同步修改keep_head/keep_hand/keep_foot参数|\ | | | | |* 若同时上传protect_mask_url和keep_head/keep_hand/keep_foot字段，则取并集 | **Garment** 服装配置相关参数 |名称 |必选 |类型 |描述 |备注 | |---|---|---|---|---| |id |是 |String |服装ID| |\ | | | |建议值："1" | | |data |是 |array of Data |服装图详细信息 |当前仅支持配置一件服装，可以是上衣、裤子、鞋子或帽子其中之一 | **Data** 服装图相关参数 |名称 |必选 |类型 |描述 |备注 | |---|---|---|---|---| |url |是 |String |服装图URL | | **InferenceConfig** 推理配置相关参数 |名称 |必选 |类型 |描述 |备注 | |---|---|---|---|---| |do_sr |否 |bool |是否对结果进行超分处理| |\ | | | |默认值：false | | |seed |否 |int |随机种子参数，默认为\-1，表示系统随机生成seed| |\ | | | |默认值：\-1 | | |keep_head |否 |bool |是否保持模特原图的头（包括发型）| |\ | | | |默认值：true | | |keep_hand |否 |bool |是否保持模特原图的手| |\ | | | |默认值：true | | |keep_foot |否 |bool |是否保持模特原图的足| |\ | | | |默认值：true | | |num_steps |否 |int |模型推理步数，和算法效果、处理时间相关| |\ | | | |默认值：50| |\ | | | |取值范围： [25, 50] | | |keep_upper |否 |bool |是否保持模特原图的上装| |\ | | | |默认值：false | | |keep_lower |否 |bool |是否保持模特原图的下装| |\ | | | |默认值：false | | |tight_mask |否 |String |模特图遮挡区域范围| |\ | | | |默认值："loose"| |\ | | | |支持类型：["tight", "loose", "bbox"]| |\ | | | |说明：| |\ | | | | "tight": 上窄下窄| |\ | | | | "loose": 上窄下宽（默认）| |\ | | | | "bbox": 上宽下宽 | | |p_bbox_iou_ratio |否 |float |当画面有多个人时，每个人的bbox与主体相交的比例| |\ | | | |默认值：0.3| |\ | | | |取值范围：[0.1, 0.5] | | |p_bbox_expand_ratio |否 |float |bbox在inference时扩大的比例| |\ | | | |默认值：1.1| |\ | | | |取值范围：[1.0, 1.5] | | |max_process_side_length |否 |int |当输入图像时，最大的边长若超过该数值，会先resize到图像到该最大边长| |\ | | | |默认值：1920| |\ | | | |取值范围：[1080, 4096] | | **LogoInfo** 水印相关参数 |名称 |必选 |类型 |描述 |备注 | |---|---|---|---|---| |add_logo |否 |Boolean |是否添加水印。True为添加，False不添加。默认不添加 | | |position |否 |Int |水印的位置，取值如下：| |\ | | | |0\-右下角| |\ | | | |1\-左下角| |\ | | | |2\-左上角| |\ | | | |3\-右上角| |\ | | | |默认0 | | |language |否 |Int |水印的语言，取值如下：| |\ | | | |0\-中文（AI生成）| |\ | | | |1\-英文（Generated by AI）| |\ | | | |默认0 | | |logo_text_content |否 |String |明水印自定义内容 | | ## 输出说明 ### **通用输出参数** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) ### **业务输出参数** :::tip 重点关注data 字段，其他字段为公共返回 ::: |字段 |类型 |说明 | |---|---|---| |binary_data_base64 |array of string |返回图片的base64数组（单张图） | |image_urls |array of string |输出处理过的图片url数组（单张图），输出图片格式为png格式 | ## 请求&返回完整示例 ### **请求示例：** ```JSON { "req_key": "dressing_diffusion", "model": { "id": "1", "url": "https://xxx" }, "garment": { "id": "1", "data": [ { "url": "https://xxx" } ] }, "return_url": true, "logo_info": { "add_logo": false, "position": 0, "language": 0, "logo_text_content": "这里是明水印内容" } } ``` ### **返回示例：** ```JSON { "code": 10000, "data": { "algorithm_base_resp": { "status_code": 0, "status_message": "Success" }, "binary_data_base64": [], "code": 0, "image_urls": [ "https://xxxx" ], "inference_config": { "seed": 2030331032 }, "message": "success" }, "message": "Success", "request_id": "2025022019202974945DB0C5D9C5A130FB", "status": 10000, "time_elapsed": "12.044322116s" } ``` ## 错误码 ### **通用错误码** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) ### **业务错误码** 暂无，待补充 ## 接入说明 ### SDK使用说明请参考[SDK使用说明](https://www.volcengine.com/docs/6444/1340578) ### HTTP方式接入说明请参考[HTTP请求示例](https://www.volcengine.com/docs/6444/1390583)

智能视觉服务