## 接口简介图片换装已支持通过同步转异步接口进行异步调用，整个调用流程分为两个步骤：1. 使用CVSync2AsyncSubmitTask接口提交任务；2. 使用CVSync2AsyncGetResult接口查询任务结果。如有异步调用的需求，可参考本文档中**提交任务**与**查询任务**两个章节的示例进行调用。 ## 请求说明 |名称 |内容 | |---|---| |接口地址 |[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=CVSync2AsyncSubmitTask&Version=2022-08-31](https://visual.volcengineapi.com?Action=CVSync2AsyncSubmitTask&Version=2022-08-31) ::: |参数 |可选/必选 |类型 |说明 | |---|---|---|---| |Action |必选 |String |接口名，取值：**CVSync2AsyncSubmitTask** | |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 |推理配置 | | **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 |是否对结果进行超分处理| |\ | | | |默认值：true | | |seed |否 |int |随机种子参数，默认为\-1，表示系统随机生成seed| |\ | | | |默认值：\-1 | | |keep_head |否 |bool |是否保持模特原图的头（包括发型）| |\ | | | |默认值：true | | |keep_hand |否 |bool |是否保持模特原图的手| |\ | | | |默认值：true | | |keep_foot |否 |bool |是否保持模特原图的足| |\ | | | |默认值：true | | |scheduler_name |否 |String |算法采样器类型，和算法效果相关| |\ | | | |默认值："DDIM" | | |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] | | ### 提交任务返回参数 #### **通用返回参数** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) #### **业务返回参数** :::tip 重点关注data 字段，其他字段为公共返回 ::: |字段 |类型 |说明 | |---|---|---| |task_id |string |任务ID，用于查询结果 | ### 提交任务请求&返回完整示例 **请求示例：** ```JSON { "req_key": "dressing_diffusion", "model": { "id": "1", "url": "https://xxx" }, "garment": { "id": "1", "data": [ { "url": "https://xxx" } ] } } ``` **返回示例：** ```JSON { "code": 10000, //状态码，判断状态，code!=10000的情况下，不会返回task_id "data": { "task_id": "7392616336519610409" //任务ID，查询接口使用 }, "message": "Success", "request_id": "20240720103939AF0029465CF6A74E51EC", //排查错误的关键信息 "time_elapsed": "104.852309ms" //链路耗时 } ``` ## 查询任务 ### **查询任务请求参数** #### **Header参数** 完整公共参数列表见 [公共参数](https://www.volcengine.com/docs/6369/67268) 本服务**Region为cn\-north\-1，Service为cv** #### **Query参数** :::tip 拼接到url后的参数，示例：[https://visual.volcengineapi.com](https://visual.volcengineapi.com/)[?Action=CVSync2AsyncGetResult&Version=2022-08-31](https://visual.volcengineapi.com?Action=CVSync2AsyncGetResult&Version=2022-08-31) ::: |参数 |可选/必选 |类型 |说明 | |---|---|---|---| |Action |必选 |String |接口名，固定值：**CVSync2AsyncGetResult** | |Version |必选 |String |版本号，固定值：**2022\-08\-31** | #### **Body参数** :::warning 业务请求参数，放到request.body中，MIME\-Type为**application/json** ::: |参数 |可选/必选 |类型 |说明 |示例 | |---|---|---|---|---| |req_key |必选 |String |算法名称，取固定值为**dressing_diffusion** | | |task_id |必选 |String |任务ID，此字段为**提交任务接口中返回的task_id** | | |req_json |可选 |JSON String |json序列化后的字符串|"{"logo_info":{"add_logo":true,"position":0,"language":0,"logo_text_content":"这里是明水印内容"},"return_url":true}" |\ | | | |目前支持**水印配置**和**是否以图片链接形式返回**，可在返回结果中添加 | | **ReqJson** :::warning ReqJson(序列化后的结果再赋值给req_json) ::: |**参数** |**可选/必选** |**类型** |**说明** | | |---|---|---|---|---| |return_url |可选 |bool |输出是否返回图片链接 **（链接有效期为24小时）** | | |logo_info |可选 |LogoInfo |水印信息 | | |aigc_meta |可选 |AIGCMeta |隐式标识 |隐式标识验证方式：|\ | | | | ||\ | | | | |1. 查看【png】或【mp4】格式，人工智能生成合成内容表示服务平台（后续预计增加jpg）|\ | | | | |* [https://www.gcmark.com/web/index.html#/mark/check/image](https://www.gcmark.com/web/index.html#/mark/check/image)|\ | | | | |2. 查看【jpg】格式，使用app11 segment查看aigc元数据内容|\ | | | | |* 如 [https://cyber.meme.tips/jpdump/#](https://cyber.meme.tips/jpdump/#) | **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表示完全不透明，默认1 | |logo_text_content |String |否 |明水印自定义内容 | ##### AIGCMeta 隐式标识，依据《人工智能生成合成内容标识办法》&《网络安全技术人工智能生成合成内容标识方法》 |名称 |类型 |**可选/必选** |描述 | |---|---|---|---| |content_producer |string |可选 |内容生成服务ID | |producer_id |string |必选 |内容生成服务商给此图片数据的唯一ID | |content_propagator |string |可选 |内容传播服务商ID | |propagate_id |string |可选 |传播服务商给此图片数据的唯一ID | ### 查询任务返回参数 #### **通用返回参数** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) #### **业务返回参数** :::tip 重点关注data 字段，其他字段为公共返回 ::: |参数名 |参数说明 |参数示例 | |---|---|---| |binary_data_base64 |Array of string |返回图片的base64数组。 | |image_urls |Array of string |返回图片的url数组（有效期为 24 小时）|\ | | |输出图片格式为png格式 | |response_data |String |算法返回的一些信息，可忽略，是json序列化字符串 | |status |String |in_queue：任务已提交|\ | | |generating：任务已被消费，处理中|\ | | |done：处理完成，成功或者失败，可根据外层code&message进行判断|\ | | |not_found：任务未找到，可能原因是无此任务或任务已过期(12小时) | ### 查询任务请求&返回完整示例 **请求示例：** ```JSON { "req_key": "dressing_diffusion", "task_id": "7418049665255653414", "req_json": "{\"logo_info\":{\"add_logo\":false,\"position\":0,\"language\":0,\"opacity\":1,\"logo_text_content\":\"这里是明水印内容\"},\"return_url\":true,\"aigc_meta\":{\"content_producer\":\"xxx\",\"producer_id\":\"xxx\",\"content_propagator\":\"xxx\",\"propagate_id\":\"xxx\"}}" } ``` **返回示例：** ```JSON { "code": 10000, //状态码，优先判断 code=10000, 然后再判断data.status，否则解析有可能会panic "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", "status": 10000, //无需关注，请忽略 "request_id": "2025061718460554C9B78D23B0BAB45B2A", //排查错误的关键信息 "time_elapsed": "508.312154ms" //链路耗时 } ``` **返回报错示例：** ```JSON { "code": 50413, //状态码，优先判断 code=10000, 然后再判断data.status，否则解析有可能会panic "data": null, //code!=10000的情况下，该字段返回为null "message": "Post Text Risk Not Pass", //错误信息 "request_id": "202511281418218670D408837A9B0EB58F", //排查错误的关键信息 "status": 50413, //无需关注，请忽略 "time_elapsed": "36.799829ms" //链路耗时 } ``` ## 错误码 ### **通用错误码** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) ### **业务错误码** |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使用说明请参考[SDK使用说明](https://www.volcengine.com/docs/6444/1340578) ### HTTP方式接入说明请参考[HTTP请求示例](https://www.volcengine.com/docs/6444/1390583)

图像生成大模型