# 接口简介支持用户上传包含物品主体的营销商品图和提示词，实现商品图的背景替换。 # 接入说明 ## 限制条件 |名称 |内容 | |---|---| |输入图要求 |1. 图片格式：仅支持JPEG、PNG格式，建议使用JPEG格式；|\ | |2. 图片文件大小：最大 4.7MB，图片分辨率：最大 4096 \* 4096 | ## 请求说明 |名称 |内容 | |---|---| |接口地址 |[https://visual.volcengineapi.com](https://visual.volcengineapi.com/) | |请求方式 |POST | |Content\-Type |application/json | ## 提交任务 ### **提交任务请求参数** #### **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 | #### **Header参数** :::warning 本服务固定值：**Region为cn\-north\-1，Service为cv** ::: 主要用于鉴权，详见 [公共参数](https://www.volcengine.com/docs/6369/67268) \- 签名参数 \- 在Header中的场景部分 #### **Body参数** :::warning 业务请求参数，放到request.body中，MIME\-Type为**application/json** ::: |名称 |类型 |必选 |描述 | |---|---|---|---| |req_key |string |必选 |服务标识|\ | | | |取固定值: **i2i_dreamlight3_0_background_replace** | |binary_data_base64 |array of string |必选（二选一） |图片文件base64编码，需输入1张图片 | |image_urls |array of string |^^|图片文件URL，需输入1张图片 | |prompt |string |必选 |用于编辑图像的提示词，支持中英文 | |seg_prompt |string |可选 |精准抠图提示词，支持中英文|\ | | | ||\ | | | |* 当传入seg_prompt参数时，会抠出输入图中的指定主体，如seg_prompt传入"红色的行李箱"，就会抠出图片中的"红色的行李箱"并进行后续处理；|\ | | | |* 当不传入seg_prompt参数时，默认会自动抠出图片中的主体（人/商品） | |downscale_longer_side |int |可选 |指定长边最大值|\ | | | |当尺寸过大时，可按长边缩小。长边超过downscale_longer_side数值时，自动按比例，缩小至指定边长。|\ | | | |推荐值：2048，过高的数值会生成报错|\ | | | |默认值：2048 | |seed |int |可选 |随机种子，作为确定扩散初始状态的基础，默认\-1（随机）。若随机种子为相同正整数且其他参数均一致，则生成内容极大概率效果一致|\ | | | |默认值：\-1 | |light_switch |bool |可选 |是否保留产品光影|\ | | | |默认值：false（false按照环境适配光影，true保留产品光影） | |

||||\ |手动构图参数

| | | |\ | | | | | |pct_composition_switch |bool |可选 |是否开启手动构图|\ | | | |默认值：false（关闭手动构体） | |pct_x_offset |int |可选 |手动构图控制画布的宽|\ | | | |默认值：1440 | |pct_y_offset |int |可选 |手动构图控制画布的高|\ | | | |默认值：2048 | |x_percent |float |可选 |控制商品在画布X轴上的位置（单位为百分比）|\ | | | |默认值：50 | |y_percent |float |可选 |控制商品在画布Y轴上的位置（单位为百分比）|\ | | | |默认值：50 | |pct_scale |float |可选 |缩放比例，大于1为放大，小于1为缩小|\ | | | |默认值：1 | ### 提交任务返回参数 #### **通用返回参数** 请参考[通用返回字段及错误码](https://www.volcengine.com/docs/6444/69728) #### **业务返回参数** :::tip 重点关注data中以下字段，其他字段为公共返回(可忽略或不做解析) ::: |字段 |类型 |说明 | |---|---|---| |task_id |string |任务ID，用于查询结果 | ### 提交任务请求&返回完整示例 **请求示例：** ```JSON { "req_key": "i2i_dreamlight3_0_background_replace", // "binary_data_base64": [], "image_urls": [ "https://xxxx" ], "prompt": "雪山，雪地，草甸，一望无际的雪原，优美的风景", "seed": -1 } ``` **返回示例：** ```JSON { "code": 10000, "data": { "task_id": "7392616336519610409" }, "message": "Success", "request_id": "20240720103939AF0029465CF6A74E51EC", "status": 10000, "time_elapsed": "104.852309ms" } ``` ## 查询任务 ### **查询任务请求参数** #### **Query参数** :::tip 拼接到url后的参数，示例：[https://visual.volcengineapi.com](https://visual.volcengineapi.com/)[?Action=CVSync2AsyncGetResult&Version=2022-08-31](https://visual.volcengineapi.com?Action=CVGetResult&Version=2022-08-31) ::: |参数 |类型 |**可选/必选** |说明 | |---|---|---|---| |Action |string |必选 |接口名，固定值：**CVSync2AsyncGetResult** | |Version |string |必选 |版本号，固定值：**2022\-08\-31** | #### **Header参数** :::warning 本服务固定值：**Region为cn\-north\-1，Service为cv** ::: 主要用于鉴权，详见 [公共参数](https://www.volcengine.com/docs/6369/67268) \- 签名参数 \- 在Header中的场景部分 #### **Body参数** :::warning 业务请求参数，放到request.body中，MIME\-Type为**application/json** ::: |参数 |类型 |可选/必选 |说明 | |---|---|---|---| |req_key |string |必选 |服务标识|\ | | | |取固定值: **i2i_dreamlight3_0_background_replace** | |task_id |string |必选 |任务ID，此字段的取值为**提交任务接口**的返回 | |req_json |JSON string |可选 |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\",\"logo_text_content\":\"xxx\",\"logo_text_content\":\"xxx\"}}" | ##### **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 |bool |可选 |是否添加水印。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数组，输出图片格式为jpeg格式 | |status |string |任务执行状态|\ | | ||\ | | |* in_queue：任务已提交|\ | | |* generating：任务已被消费，处理中|\ | | |* done：处理完成，成功或者失败，可根据外层code&message进行判断|\ | | |* not_found：任务未找到，可能原因是无此任务或任务已过期(12小时)|\ | | |* expired：任务已过期，请尝试重新提交任务请求 | ### 查询任务请求&返回完整示例 **请求示例：** ```JSON { "req_key": "i2i_dreamlight3_0_background_replace", "task_id": "<任务提交接口返回task_id>", "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\",\"logo_text_content\":\"xxx\",\"logo_text_content\":\"xxx\"}}" } ``` **返回示例：** ```JSON { "code": 10000, "data": { "binary_data_base64": null, "image_urls": [ "https://xxxx" ], "status": "done" }, "message": "Success", "request_id": "2025061718460554C9B78D23B0BAB45B2A", "status": 10000, "time_elapsed": "508.312154ms" } ``` ## 错误码 ### **通用错误码** 请参考[通用返回字段及错误码](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 |输入文本含敏感词、版权词等审核不通过 |不需要 | |429 |50429 |Request Has Reached API Limit, Please Try Later |QPS超限 |可重试 | |429 |50430 |Request Has Reached API Concurrent Limit, Please Try Later |并发超限 |可重试 | |500 |50500 |Internal Error |内部错误 |不需要 | |500 |50501 |Internal RPC Error |内部算法错误 |不需要 | ## 接入说明 ### SDK使用说明请参考[SDK使用说明](https://www.volcengine.com/docs/6444/1340578) ### HTTP方式接入说明请参考[HTTP请求示例](https://www.volcengine.com/docs/6444/1390583)

即梦AI