潮际好麦标准API文档

好麦算法

虚拟试鞋

基本信息

Path： /marketing/algorithm/tryon_shoes

Method： POST

接口描述：

接口描述：
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_tryon_shoes
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
product_image	object	非必须		both_feet_image 商品图（双脚图）， inner_side_image 商品图（内侧图），outer_side_image 商品图（外侧图）。3个中只需有一个取值非空即可；输入的鞋商品图为多张时，可传此字段；product _image与image_shoe需要有一个为非空，都传时，取image_shoe
├─ both_feet_image	string	非必须		商品图（双脚图）
├─ inner_side_image	string	非必须		商品图（内侧图）
├─ outer_side_image	string	非必须		商品图（外侧图）
image_shoe	string	非必须		输入的鞋商品图，输入鞋图为单张时，可传此字段，product _image与image_shoe需要有一个为非空，都传时，取image_shoe
list_images_human	string []	必须		输入的模特图列表，成员为字符串，为对应模特图的url，目前只取第一个成员	item 类型: string
├─		非必须
tryon_type	integer	非必须	1	取1时，为“试鞋-高级模式”，对复杂姿势、复杂纹理的鞋效果较好；取2时，为“替换海报图鞋靴”功能，可以将输入的海报图上的鞋靴，替换成输入的商品图中的鞋靴；取3时，为“试鞋-标准模式”，适合分辨率高于2K的全身图或高于1K的局部图，出图效果均衡，可以兼容部分复杂姿势；取4时，为“试鞋-快速模式”，出图速度快，支持分辨率低于2K的全身图，或低于1K的局部图，适用于简单姿势；
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1
dpi	integer	非必须	300	默认值为300，设置结果的dpi
output_format	string	非必须	jpg	输出图片的格式，可以取'jpg'或'png'，默认为'jpg'
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口

返回数据

名称	类型	是否必须
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	integer	非必须

素材生成-图生图

基本信息

Path： /marketing/algorithm/material_generation_image_to_image

Method： POST

接口描述：

接口描述：
接口说明
appKey: marketing-server
apiName: marketing_algorithm_image2image
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口
model_type	string	必须		模型类型，可选值包括["chao_paint_3.0pro","chao_paint_3.0","chao_paint_2.0pro","chao_paint_2.0","chao_paint_1.0"],分别对应潮绘3.0 pro、潮绘3.0 、潮绘2.0pro、潮绘2.0 、潮绘1.0
img	string []	必须		参考图，可访问的url，必填。目前仅chao_paint_3.0pro、chao_paint_3.0和chao_paint_2.0pro支持多图上传；其中，chao_paint_3.0pro、chao_paint_3.0最多上传14张参考图，chao_paint_2.0pro最多上传10张参考图；其余模型仅支持单图。	item 类型: string
├─		非必须
prompt	string	必须		生成图片文本描述,不能超过4000个字符
ratio	string	必须		生图比例。不同模型的 ratio 不同：潮绘3.0pro auto、1:1、3:4、4:3、9:16、16:9、2:3、3:2、21:9 潮绘3.0 auto、1:1、3:4、4:3、9:16、16:9、2:3、3:2、21:9 潮绘2.0pro 1:1、3:4、4:3、9:16、16:9、2:3、3:2、21:9 潮绘2.0 auto 潮绘1.0 1:1、3:4、4:3、9:16、16:9、2:3、3:2、21:9
resolution	string	必须		生成图片分辨率不同模型所支持生成图像分辨率不同 1k、2k、4k 潮绘3.0pro 1k、2k 潮绘3.0 1k 潮绘2.0pro 1k、2k、4k 潮绘2.0 1k 潮绘1.0 1k

返回数据

名称	类型	是否必须
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	integer	非必须

图片超清

基本信息

Path： /marketing/algorithm/upscale

Method： POST

接口描述：

图片超清能力支持对用户上传的图像进行智能高清化处理，提升图像的分辨率与细节表现。用户可选择2倍或4倍放大倍数，也可根据图像内容选择更适配的处理模式，包括：
鞋服模式：针对商品图中布料、纹理、边缘等细节优化，适用于鞋履与服饰类商品图像；
人像模式：针对面部、皮肤、发丝等区域进行精细增强，提升人像图像质感。
高清化过程中，系统将自动完成图像像素放大操作，在增强图像清晰度的同时尽可能保持原始风格与内容不变。

图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB

接口说明
appKey: marketing-server
apiName: marketing_algorithm_upscale
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

curl 调用示例

curl --location --request POST 'https://open.metac-inc.com/api'
--header 'requestId: xxxx'
--header 'accessKey: xxxx'
--header 'apiName: marketing_algorithm_upscale'
--header 'appKey: marketing-server'
--header 'timestamp: xxxxx'
--header 'sign: xxxx'
--header 'Content-Type: application/json'
--data-raw '{
"image": "xxxxxxxx",
"modelType": 1,
"output_format": "jpg",
"dpi": 300,
"quality": 90,
}'

返回格式

{
"requestId": "xxxx",
"code": 2000,
"message": "success",
"data": 123,
"succ": true
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
image	string	必须		输入图像的url
modelType	integer	非必须	1	模型类型： 1: 人像2倍，可支持处理0~2560像素的图片 2: 人像4倍，可支持处理0~1280像素的图片 3: 鞋服2倍，可支持处理0~2560像素的图片 4: 鞋服4倍，可支持处理0~1280像素的图片默认值 1
output_format	string	非必须	jpg	设定输出图像的格式，支持'jpg'和'png',默认为jpg
dpi	integer	非必须	300	设定输出图像的dpi,默认为300	最大值: 300 最小值: 0 mock: @integer(0,300)
quality	integer	非必须	90	设置图像的质量，默认为90，如果需要对生成结果图片大小进行限制，可以修改quality参数，数值越大，图片越清晰，图片文件大小越大	最大值: 100 最小值: 0 mock: @integer(0,100)

返回数据

名称	类型	是否必须	备注
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	integer	非必须	任务id

模特换姿势

基本信息

Path： /marketing/algorithm/model_change_pose

Method： POST

接口描述：

接口描述：
接口说明
appKey: marketing-server
apiName: marketing_algorithm_pose_edit
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口
image	string	必须		必填，上传的待换姿势模特图
ref_img	string	非必须		输入姿势参考图像: 1 仅支持单张图片输入； 2 ref_img和ref_text仅支持二选一传入 2 若ref_img和ref_text都未传入，自动调用智能换姿； 3 若传入ref_img，调用以图换姿；
ref_text	string	非必须		输入文本： 1 ref_img和ref_text仅支持二选一传入 2 若ref_img和ref_text都未传入，自动调用智能换姿； 3 若传入ref_text，调用文字换姿；
ratio	string	非必须		1、若传入ref_img，该字段不需要传入； 2、若传入ref_text，该字段为必填项； 3、若ref_img和ref_text都未传入，该字段为必填项； 4、可选值：auto、4:3、3:4、16:9、9:16、1:1、3:2、2:3；

返回数据

名称	类型	是否必须
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	integer	非必须

AI试戴

基本信息

Path： /marketing/algorithm/ai_wear

Method： POST

接口描述：

接口描述：
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_ai_wear
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1
proc_type	string	非必须		'tryon_belt': 试腰带 'tryon_necklace': 试项链 'tryon_glasses':试眼镜'tryon_hat': 试帽子'tryon_bag': 试包'tryon_hand_accessory': 试手链手表'tryon_ring': 试戒指默认值 tryon_belt
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口
image_shoe	string	必须		输入的商品图
list_images_human	string []	必须		输入的模特图列表，成员为字符串，为对应模特图的url，目前只取第一个成员	item 类型: string
├─		非必须
mask_shoe	string	非必须		模特图的mask，用户输入的模特图中应该重绘的区域(仅proc type为tryon belt时需要传入)
output_format	string	非必须	tryon_shoes	默认值为'jpg'，只有'jpg'和'png'两种取值，设置结果的格式
dpi	integer	非必须	300	默认值为300，设置结果的dpi

返回数据

名称	类型	是否必须
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	integer	非必须

素材生成-文生图

基本信息

Path： /marketing/algorithm/material_generation_text_to_image

Method： POST

接口描述：

接口描述：
接口说明
appKey: marketing-server
apiName: marketing_algorithm_text2image
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口
model_type	string	必须		模型类型，可选值包括["chao_paint_2.0pro","chao_paint_2.0","chao_paint_1.0pro"，"chao_paint_1.0"] 分别对应潮绘2.0pro 、潮绘2.0 、潮绘1.0pro 、潮绘1.0
prompt	string	必须		生成图片文本描述,不能超过4000个字符
ratio	string	必须		生图比例，各模型均支持以下生图比例：1:1、3:4、4:3、9:16、16:9、2:3、3:2、21:9
resolution	string	必须		生成图片分辨率，1k、2k、4k。不同模型的支持的生成图片分辨率不同：潮绘2.0pro 1k、2k、4k 潮绘2.0 2k 潮绘1.0pro 1k、2k 潮绘1.0 1k

返回数据

名称	类型	是否必须
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	integer	非必须

米豆剩余量查询

基本信息

Path： /marketing/algorithm/remaining_quantity_of_beans

Method： GET

接口描述：

接口描述：
接口说明
appKey: marketing-server
apiName: marketing_algorithm_remaining_quantity_of_beans
qps: 10
接口为同步接口

请求参数

返回数据

名称	类型	是否必须	备注
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	object	非必须
├─ remaining_quantity	number	非必须	米豆余量

商品修复（鞋靴）

基本信息

Path： /marketing/algorithm/product_repair_shoes

Method： POST

接口描述：

接口描述：
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_product_repair_shoes
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
list_images_human	string []	必须		输入的待修复的模特图列表，成员为字符串，为对应模特图的url，目前只取第一个成员	item 类型: string
├─		非必须
mask_shoe	string	必须		待修复的模特图中希望重绘的区域的mask
product_image	object	非必须		输入参考的商品图，建议上传局部放大截图，效果会更好
├─ both_feet_image	string	非必须		双脚图
├─ inner_side_image	string	非必须		内侧图
├─ outer_side_image	string	非必须		外侧图
dpi	integer	非必须	300	默认值为300，设置结果的dpi
output_format	string	非必须	jpg	默认值为'jpg'，只有'jpg'和'png'两种取值，设置结果的格式
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口

返回数据

名称	类型	是否必须	备注
requestId	string	非必须	请求编号
code	integer	非必须	响应码
message	string	非必须	响应消息
data	integer	非必须	该值为任务ID。在“异步任务API调用”中，通过传入该值，得到生成结果

模特生成

基本信息

Path： /marketing/algorithm/model_generate

Method： POST

接口描述：

接口描述：
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_model_generate
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注
src_image	string	必须		输入模特图
ref_image	string	必须		参考姿势模特图
seed	integer	非必须		随机种子
steps	integer	非必须		模型迭代步数
output_format	string	非必须	jpg	设定输出图像的格式，支持'jpg'和'png'
dpi	integer	非必须	300	默认值为300，设置结果的dpi
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认：1
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口

返回数据

名称	类型	是否必须	备注
requestId	string	非必须	请求编号
code	integer	非必须	响应码
message	string	非必须	响应消息
data	integer	非必须	该值为任务ID。在“异步任务API调用”中，通过传入该值，得到生成结果

图生视频

基本信息

Path： /marketing/algorithm/image_to_video

Method： POST

接口描述：

接口描述：
图片要求
图片格式：'.JPG', '.PNG', '.JPEG', '.BMP', '.WEBP'
图片大小：不超过10MB
接口说明
api_name：marketing_algorithm_image_to_video
appKey: marketing-server
qps:10
接口为异步接口，需要异步获取。异步接口api_name: marketing_model_task_fetchWithMarketingModelTaskOutputPO_id。
curl 调用示例

curl --location --request POST 'https://open.metac-inc.com/api'
--header 'requestId: xxxx'
--header 'accessKey: xxxx'
--header 'apiName: marketing_algorithm_image_to_video'
--header 'appKey: marketing-server'
--header 'timestamp: xxxxx'
--header 'sign: xxxx'
--header 'Content-Type: application/json'
--data-raw '{
"first_frame_image": "xxxxxxxx",
"prompt": "手持镜头，一个女模特双手叉腰，面带微笑，缓缓低头",
"mode": "HD",
"duration": 5
}'

返回格式

{
"requestId": "xxxx",
"code": 2000,
"message": "success",
"data": 123,
"succ": true
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注
first_frame_image	string	必须		视频的首帧参考图
last_frame_image	string	非必须		视频的尾帧参考图，输入时视频自动按首尾帧图片参照输出
prompt	string	非必须		正向文本提示词,不能超过500个字符
negative_prompt	string	非必须		负向文本提示词。不能超过2500个字符
mode	string	非必须	HD	生成视频的分辨率模式。首尾帧模式仅支持超清模式（UHD）枚举值：HD：高清模式，720p , UHD：超清模式，1080p。
duration	integer	非必须	5	生成视频时长，单位s 枚举值：5，10

返回数据

名称	类型	是否必须	备注
requestId	string	非必须	请求编号
code	integer	非必须	响应码
message	string	非必须	响应消息
data	integer	非必须	该值为任务ID。在“异步任务API调用”中，通过传入该值，得到生成结果

服饰换色

基本信息

Path： /marketing/algorithm/image_color_change

Method： POST

接口描述：

接口描述：
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_image_color_change
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注
image	string	必须		参考图 oss path(非服装的参考图，目前不支持)
mask	string	非必须		Mask图，oss path（非必选）
fg_prompt	string	非必须	garment	使用内部默认分割算法时，可指定分割前景物体英文词。
type	string	非必须	模拍图	换色模式可选参数["非模拍图", "模拍图"]
color_hex_code	string	非必须		十六进制颜色码，或者RGB颜色码.如 "#FFFFFF"，"(255,255,255)"
color_reference_image	string	非必须		换色参考款式图，oss path。
resolution	integer	非必须	1024	生成图片尺寸 512, 768, 1024，默认1024
refine	boolean	非必须	true	是否自动优化边缘，默认true。如果是true，将尝试自动重绘边缘部分修正分割问题和阴影，如果是false，将严格依照传参mask区域或自动分割的mask区域进行换色。
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口

返回数据

名称	类型	是否必须
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	integer	非必须

虚拟试衣(废弃，请使用：模特试衣-真人试衣/ 模特试衣-平铺/人台试衣

基本信息

Path： /marketing/algorithm/tryon

Method： POST

接口描述：

接口描述：
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_tryon
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
image_cloth	string	必须		输入的服装图像。
mask_cloth	string	非必须		针对image_cloth的mask，决定取其中哪一部分作为服饰输入
image_cloth1	string	非必须		仅在cloth_length为overall生效，用于上下装一起换，输入下装的服装图像。
mask_cloth1	string	非必须		针对image_cloth1的mask，决定取其中哪一部分作为服饰输入，不传的话服务内部自动去调用
list_images_human	string []	必须		输入的人物图像列表，成员为字符串，为对应试穿人物图像的url，目前只取第一个成员	item 类型: string
├─		非必须
list_masks_human	string []	非必须		输入的人物图像mask列表，成员为字符串，为对应试穿人物图像的url，目前只取第一个成员，若置空则服务内部自动生成	item 类型: string
├─		非必须
list_inpaint_mask	string []	非必须		模特图重绘区域mask图像url	item 类型: string
├─		非必须
cloth_length	string	必须		可以有这三个取值： upper, lower, overall(上装，下装，全身)，默认为upper，组合换装时选overall，上装传image_cloth，下装传image_cloth1
restore_bg	boolean	非必须	true	是否保持原背景
condition_mode	string	非必须	mixed	模特图辅助输入参考，可以取mixed/skeleton
repaint_mode	string	非必须	v2_bbox	重绘区域，可以取v2/v2_bbox/v3
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口
dpi	integer	非必须	300	设定输出图像的dpi,默认为300
output_format	string	非必须	jpg	设定输出图像的格式，支持'jpg'和'png',默认为jpg

返回数据

名称	类型	是否必须
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	integer	非必须

模特试衣（真人试衣）

基本信息

Path： /marketing/algorithm/human_tryon

Method： POST

接口描述：

图片要求
图片格式：'.JPG', '.PNG', '.JPEG', '.BMP', '.WEBP'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_human_tryon
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
image_cloth	string	必须		输入的服装图像，可为真人图，url格式示例值: https://metac-open.oss-cn-hangzhou.aliyuncs.com/yaoyihong/1752555596157_0.png
mask_cloth	string	非必须		针对image_cloth的mask，决定取其中哪一部分作为服饰输入；若未传入mask，接口将自动调用分割模型生成。url格式
list_images_human	string []	必须		输入的人物图像列表，成员为字符串，为对应试穿人物图像的url，目前只取第一个成员	item 类型: string
├─		非必须
list_masks_human	string []	非必须		输入的人物图像对应的mask列表，成员为字符串，url格式，目前只取第一个成员，若未传入mask，接口将自动调用分割模型生成。	item 类型: string
├─		非必须
cloth_length	string	非必须	overall	真人图 overall
restore_bg	boolean	非必须	true	是否保持模特图的原背景
condition_mode	string	非必须	mixed	模特图辅助输入参考，可以取mixed/skeleton 默认值 mixed mixed ：识别模特骨骼和身材 skeleton：识别模特骨骼推荐使用mixed，效果更好
model_type	string	非必须		此参数控制模型出图策略，可指定的模型类型为1: 模型A，2:模型B 如果该值为空，为以下默认策略： batch_size为1时，默认模型A 1张； batch_size为2时，默认模型A 1张，模型B 1张； batch_size为3时，默认模型A 2张，模型B 1张； batch_size为4时，默认模型A 3张，模型B 1张； batch_size为5时，默认模型A 4张，模型B 1张； batch_size为6时，默认模型A 5张，模型B 1张； batch_size为7时，默认模型A 6张，模型B 1张； batch_size为8时，默认模型A 7张，模型B 1张；建议生成两张及以上结果，覆盖全部出图策略，以获取更好的试衣效果。
repaint_mode	string	非必须	v2_bbox	重绘区域，可以取v2/v2_bbox/v3 默认值 v2_bbox model_type为1时，该参数可以生效；若服饰图与模特图身上的服饰为同版型时，推荐输入v2，效果更佳 model_type为2时，该参数不生效
material_enhancement	string	非必须	false	开启材质增强后，系统将自动对结果进行材质增强处理，可显著提升图案、针织纹理、拉链、纽扣等细节暂时不支持上装+下装组合换装的材质增强，建议分开试衣后分别进行材质增强。
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1 建议生成两张及以上结果，覆盖全部出图策略，以获取更好的试衣效果。
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口
dpi	integer	非必须	300	设定输出图像的dpi,默认为300
output_format	string	非必须	jpg	设定输出图像的格式，支持'jpg'和'png',默认为jpg

返回数据

名称	类型	是否必须	备注
requestId	string	非必须	请求编号
code	integer	非必须
message	string	非必须
data	integer	非必须

模特试衣（平铺/人台试衣）

基本信息

Path： /marketing/algorithm/flat_lay_mannequin_tryon

Method： POST

接口描述：

图片要求
图片格式：'.JPG', '.PNG', '.JPEG', '.BMP', '.WEBP'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_flat_lay_mannequin_tryon
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
image_cloth	string	必须		输入的服装图像，可为平铺图或人台图，url格式示例值: https://metac-open.oss-cn-hangzhou.aliyuncs.com/yaoyihong/1753407578767_0.png
mask_cloth	string	非必须		针对image_cloth的mask，决定取其中哪一部分作为服饰输入；若未传入mask，接口将自动调用分割模型生成。url格式
image_cloth1	string	非必须		仅在cloth_length为overall生效，用于上下装一起换，输入下装的服装图像，可为平铺图、人台图或模特上身图，url格式
mask_cloth1	string	非必须		针对image_cloth1的mask，决定取其中哪一部分作为服饰输入，若未传入mask，接口将自动调用分割模型生成。url格式
list_images_human	string []	必须		输入的人物图像列表，成员为字符串，为对应试穿人物图像的url，目前只取第一个成员	item 类型: string
├─		非必须
list_masks_human	string []	非必须		输入的人物图像对应的mask列表，成员为字符串，url格式，目前只取第一个成员，若未传入mask，接口将自动调用分割模型生成。	item 类型: string
├─		非必须
list_inpaint_mask	string []	非必须		模特图重绘区域mask图像，url格式	item 类型: string
├─		非必须
cloth_length	string	必须		字符串，可以有upper,lower,overall三种取值，组合换装时选overall，上装传image_cloth，下装传image_cloth1 分别对应上半身，下半身，全身
restore_bg	boolean	非必须	true	是否保持模特图的原背景
condition_mode	string	非必须	mixed	模特图辅助输入参考，可以取mixed/skeleton 默认值 mixed mixed ：识别模特骨骼和身材 skeleton：识别模特骨骼推荐使用mixed，效果更好
model_type	integer	非必须		此参数控制模型出图策略，可指定的模型类型为1: 模型A，2:模型B 如果该值为空，为以下默认策略： batch_size为1时，默认模型A 1张； batch_size为2时，默认模型A 1张，模型B 1张； batch_size为3时，默认模型A 2张，模型B 1张； batch_size为4时，默认模型A 3张，模型B 1张； batch_size为5时，默认模型A 4张，模型B 1张； batch_size为6时，默认模型A 5张，模型B 1张； batch_size为7时，默认模型A 6张，模型B 1张； batch_size为8时，默认模型A 7张，模型B 1张；建议生成两张及以上结果，覆盖全部出图策略，以获取更好的试衣效果。	mock: @integer(1,2)
repaint_mode	string	非必须	v2_bbox	重绘区域，可以取v2/v2_bbox/v3 默认值 v2_bbox model_type为1时，该参数可以生效；若服饰图与模特图身上的服饰为同版型时，推荐输入v2，效果更佳 model_type为2时，该参数不生效
material_enhancement	string	非必须	false	开启材质增强后，系统将自动对结果进行材质增强处理，可显著提升图案、针织纹理、拉链、纽扣等细节暂时不支持上装+下装组合换装的材质增强，建议分开试衣后分别进行材质增强。
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1建议生成两张及以上结果，覆盖全部出图策略，以获取更好的试衣效果。
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口
dpi	integer	非必须	300	设定输出图像的dpi,默认为300
output_format	string	非必须	jpg	设定输出图像的格式，支持'jpg'和'png',默认为jpg

返回数据

名称	类型	是否必须	备注
requestId	string	非必须	请求编号
code	integer	非必须
message	string	非必须
data	integer	非必须

材质增强（模特试衣）

基本信息

Path： /marketing/algorithm/material_enhancement_tryon

Method： POST

接口描述：

图片要求
图片格式：'.JPG', '.PNG', '.JPEG', '.BMP', '.WEBP'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_material_enhancement_tryon
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
image_cloth	string	必须		输入的服装图像，可为平铺图、人台图或真人图，url格式示例值:https://metac-open.oss-cn-hangzhou.aliyuncs.com/yaoyihong/1753407578767_0.png
mask_cloth	string	非必须		针对image_cloth的mask，决定取其中哪一部分作为服饰输入；若未传入mask，接口将自动调用分割模型生成。url格式
list_images_human	string []	必须		请从已生成的模特试衣结果中，选择一张结果图作为模特图传入。人物图像列表为字符串，url格式，目前只取第一个成员。	item 类型: string
├─		非必须
list_masks_human	string []	非必须		输入的人物图像对应的mask列表，成员为字符串，url格式，目前只取第一个成员，若未传入mask，接口将自动调用分割模型生成。	item 类型: string
├─		非必须
cloth_length	string	非必须	upper	可以有这三个取值： upper, lower, overall(上装，下装，全身)，默认为upper 当前不支持上装+下装组合换装的材质增强，建议分开试衣后分别进行材质增强。
dpi	integer	非必须	300	设定输出图像的dpi
output_format	string	非必须	jpg	设定输出图像的格式，支持'jpg'和'png'
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认：1
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口

返回数据

名称	类型	是否必须	备注
requestId	string	非必须	请求编号
code	integer	非必须
message	string	非必须
data	integer	非必须

AI人像换背景-文生图

基本信息

Path： /marketing/algorithm/human_bg_replace_text_to_image

Method： POST

接口描述：

接口描述：
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_human_bg_replace_text_to_image
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注
image	string	必须		原图，可访问的url
background_prompt	string	必须		文本描述。
is_relighting	boolean	非必须	false	是否打光.默认False.True为是,relighting_mode参数才会生效。False为否,，relighting_mode参数不生效
relighting_mode	string	非必须	twostep	打光模式.默认twostep.枚举值onestep,twostep. onestep为直接打光,twostep为后打光
model_resolution	string	非必须	normalres	出图清晰度.默认normalres.枚举值highres, normalres. highres为超清,normalres为高清.当relighting_mode为twostep时才生效
mask	string	非必须		mask url。若不传，则内部自动调用分割
return_fmt	string	非必须	jpeg	返回图像编码格式, 默认 jpeg. 取值范围jpeg, png
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口

返回数据

名称	类型	是否必须
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	integer	非必须

AI人像换背景-单图复刻

基本信息

Path： /marketing/algorithm/human_bg_replace_single_image_replica

Method： POST

接口描述：

接口描述：
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_human_bg_replace_single_image_replica
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注
image	string	必须		原图，可访问的url
ref_img	string	必须		图生图参考图参考图，可访问的url。inference_mode为replica_gen时必填
is_relighting	boolean	非必须	false	是否打光.默认False.True为是,relighting_mode参数才会生效。False为否,，relighting_mode参数不生效
relighting_mode	string	非必须	twostep	打光模式.默认twostep.枚举值onestep,twostep. onestep为直接打光,twostep为后打光
model_resolution	string	非必须	normalres	出图清晰度.默认normalres.枚举值highres, normalres. highres为超清,normalres为高清.当relighting_mode为twostep时才生效
mask	string	非必须		mask url。若不传，则内部自动调用分割
return_fmt	string	非必须	jpeg	返回图像编码格式, 默认 jpeg. 取值范围jpeg, png
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口

返回数据

名称	类型	是否必须
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	integer	非必须

AI人像换背景-风格背景

基本信息

Path： /marketing/algorithm/human_bg_replace_style_background

Method： POST

接口描述：

接口描述：
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_human_bg_replace_style_background
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注
image	string	必须		原图，可访问的url
style_name	string	必须		风格名。
is_relighting	boolean	非必须	false	是否打光.默认False.True为是
mask	string	非必须		mask url。若不传，则内部自动调用分割
return_fmt	string	非必须	jpeg	返回图像编码格式, 默认 jpeg. 取值范围jpeg, png
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口

返回数据

名称	类型	是否必须
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	integer	非必须

AI商品图

基本信息

Path： /marketing/algorithm/ai_product

Method： POST

接口描述：

接口描述：
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_ai_product
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注
image	string	必须		原图，可访问的url
mask	string	必须		原图mask，可访问的url
ref_img	string	非必须		参考图，可访问url(高相似度模式时或者inference_mode为replica_gen时必传)
ref_mask	string	非必须		参考图mask，可访问的url(高相似度模式时必传)
is_relighting	boolean	非必须	false	是否打光.默认False.True为是,relighting_mode参数才会生效。False为否,，relighting_mode参数不生效
relighting_mode	string	非必须	twostep	打光模式.默认twostep.枚举值onestep,twostep. onestep为直接打光,twostep为后打光
model_resolution	string	非必须	normalres	出图清晰度.默认normalres.枚举值highres, normalres. highres为超清,normalres为高清.当relighting_mode为twostep时才生效
background_prompt	string	非必须		文本描述。inference_mode为free_txt2bg_gen时必填
return_fmt	string	非必须	jpeg	返回图像编码格式, 默认 jpeg. 取值范围jpeg, png
inference_mode	string	非必须	free_txt2bg_gen	取值范围, free_txt2bg_gen, replica_gen。 free_txt2bg_gen为自由文本生图，replica_gen为单图复刻
isHighSimilarity	boolean	非必须	false	是否高相似度 true-是 false-否默认值false
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口

返回数据

名称	类型	是否必须
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	integer	非必须

商品换背景（高相似度）

基本信息

Path： /marketing/algorithm/ai_product_entire

Method： POST

接口描述：

接口描述：
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_ai_product_entire_replica
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注
image	string	必须		商品原图，可访问URL
mask	string	必须		商品mask，可访问URL
ref_img	string	必须		参考图，可访问URL
ref_mask	string	必须		参考图mask，可访问URL
is_relighting	boolean	非必须	false	是否打光.默认False True为是，开启打光 False为否，关闭打光
seed	integer	非必须	-1	生图随机种子,默认-1
scale_factor	number	非必须	1.0	缩放比例（默认 1.0）
delta_xy	string	非必须	"0.0,0.0"	平移量 (x,y，相对坐标，通常 -1~1)
rotate_angle	number	非必须	0.0	旋转角度（度数，-180~180）
rotate_center_xy	string	非必须	"0.5,0.5"	旋转中心点坐标（相对比例 0~1）
crop_coords	string	非必须	"0,0,1,1"	裁剪范围（x1,y1,x2,y2，相对坐标 0~1）
final_target_size	string	非必须		模型后的结果图resize,默认为null
return_fmt	string	非必须	jpeg	返回图片编码格式，默认 jpeg 可选值 jpeg/png
model_resolution	string	非必须	normalres	出图清晰度.默认normalres. 枚举值highres, normalres. highres为超清,normalres为高清.
batch_size	integer	非必须	1	生成图片数量 [1, 8]，默认 1
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口

返回数据

名称	类型	是否必须	备注
requestId	string	非必须	请求编号
code	integer	非必须
message	string	非必须
data	integer	非必须

AI人像换背景-文生图、单图复刻、风格背景

基本信息

Path： /marketing/algorithm/person_image_outpaint_with_text_prompt

Method： POST

接口描述：

接口描述：
功能描述
对模特图的背景进行更换。
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过10MB
使用说明

上传模特原图、原图对应的模特mask图片、替换背景对应的promp、是否参考原图和生成张数
上传参数后返回对应任务id，根据调用链路查询生成结果

图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过10MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_person_image_outpaint_with_text_prompt
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取
功能示例
prompt：The background of the image features a park with a pathway lined with trees and benches. The pathway is surrounded by grass and plants, creating a serene and peaceful atmosphere. The sun is shining, illuminating the scene and adding to the overall beauty of the park.
页面_24@0,25x.png

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注
image	string	非必须		原图，可访问的url
mask	string	非必须		mask url
background_prompt	string	非必须		文本描述。inference_mode为free_txt2bg_gen时必填
style_name	string	非必须		风格名。inference_mode为style_gen时必填
ref_img	string	非必须		参考图，可访问的url。inference_mode为replica_gen时必填
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1
return_fmt	string	非必须	jpeg	返回图像编码格式, 默认 jpeg. 取值范围jpeg, png
inference_mode	string	非必须	style_gen	取值范围[style_gen、free_txt2bg_gen、replica_gen] free_txt2bg_gen：文生图、style_gen：风格、replica_gen：单图复刻
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口

返回数据

名称	类型	是否必须
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	integer	非必须

AI换模特

基本信息

Path： /marketing/algorithm/human_model_swap

Method： POST

接口描述：

接口描述：
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_human_model_swap
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1
image	string	必须		参考图 oss path
mask_fix	string	非必须		输入Mask
model_id	string	必须		换模特ID
mode	integer	非必须	0	换模特模式 0为换头，1为全身换，默认0
inference_steps	integer	非必须	30	推理步数默认为30
strength	number	非必须	0.7	重绘强度,默认为0.7
guidance_scale	number	非必须	3.5	guidance scale 默认为3.5
seed	integer	非必须	-1	随机种子，-1为随机默认为-1
max_size	integer	非必须	1600	最大图像尺寸默认为2048
ori_size_return	boolean	非必须	false	是否返回原尺寸图片默认False
auto_hands_feet_fix	boolean	非必须	false	自动手脚修复默认False
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口

返回数据

名称	类型	是否必须
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	integer	非必须

AI换脸

基本信息

Path： /marketing/algorithm/swap_head

Method： POST

接口描述：

接口描述：
功能描述
根据用户上传的模特原图和目标人脸图对模特图进行换脸。
使用说明

上传模特原图、目标人脸图，选择对应的换脸方法、性别和生成张数
上传参数后返回对应任务id，根据调用链路查询生成结果

图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_swap_head
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取
功能示例

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
image_trg	string	必须	llava_person_background_caption	图像url
image_src	string	必须		字符串类型的图像url，包含源脸，以换入目标脸中。可能存在人脸占图像面积比例过大的情形而导致失败。
n_swap_choiceList	number []	必须		可选值为0.25, 0.5, 0.75, 1.0。其中0.25表示使用传统人脸融合方法。 0.25, 0.5, 0.75, 1.0 表示使用新的换脸方法，从小到大的4个不同权值。例如：[0.5].这个值越大会越全方位像参考的人脸图，但可能会更偏离被换的那张脸。数组的长度会影响出图张数。例如：[025,0.5] 对应的出图张数是两张	item 类型: number
├─		非必须
n_gender	integer	非必须
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口

返回数据

名称	类型	是否必须
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	integer	非必须

原子能力-自动分割抠图

基本信息

Path： /marketing/algorithm/auto_seg

Method： POST

接口描述：

接口描述：
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_auto_seg
qps :1
接口为同步接口，无需异步获取。

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
image	string	必须		参考图url
type	integer	必须		类别 0 表示商品，1表示人像，2表示图形

返回数据

名称	类型	是否必须	备注
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	object	非必须
├─ mask	string	非必须	抠图mask图
├─ image	string	非必须	透明底结果图

交互式分割-异步

基本信息

Path： /marketing/algorithm/run_auto_parsing/

Method： POST

接口描述：

功能描述
根据用户上传的图片进行选区划分。
使用说明
上传图片后，针对图片区域进行识别，返回区域mask，可进行区域性mask选择。
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_run_auto_parsing_async
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制请参考任务异步回调说明(推荐)
2.通过查询任务接口获取
功能示例

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	备注
image	string	必须	输入的服装图像。
seg_detail	integer	非必须	1为精细(慢速)，0为粗糙(快速)，2为超快速 ,默认1
callBackUrl	string	非必须	异步任务回调url,具体格式请参考异步回调接口

返回数据

名称	类型	是否必须	备注
code	integer	非必须
message	string	非必须
data	string	非必须	任务id
requestId	string	非必须

交互式分割-matting

基本信息

Path： /marketing/algorithm/run_image_matting

Method： POST

接口描述：

接口描述：
apiNmae: marketing_algorithm_run_image_matting

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1
id	integer	非必须		任务id
name	string	非必须		任务名称
measureNo	string	非必须		计量计费单号
image	string	必须		款式图url
mask	string	非必须		二值mask图，base64格式或url
read_from_url	boolean	非必须	true	是否读取图片url

返回数据

名称	类型	是否必须	备注
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	object	非必须
├─ mask	string	非必须	参考图 oss url
├─ view_image	string	非必须	png透明底图 RGBA
├─ maskPath	string	非必须	参考图 oss path

自动分割-服饰+人像

基本信息

Path： /marketing/algorithm/run_auto_segmentation_haomai

Method： POST

接口描述：

接口描述：
功能描述
调用者提供图片，可识别图片中的款式主体并生成对应选区，并且根据自身需求可进行针对性的识别，设置对应参数后便只会识别参数设置的内容，不设置则默认识别全部
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_run_auto_segmentation
qps :1
接口为同步接口，无需异步获取。
功能示例****

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	备注
image	string	必须	款式图，base64格式或url
read_from_url	boolean	非必须	是否读取图片url
fg_caption	string	非必须	前景描述如果只想分割上衣，则设置为'upper,top clothes';人像'handbag,person,handbag,bag,mobilephone,hat,hands'

返回数据

名称	类型	是否必须	备注	其他信息
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	object []	非必须		item 类型: object
├─ mask	string	非必须	输出mask，0～255二值图
├─ bbox	string	非必须	bounding_box坐标，逗号分隔符 "x1,y1,x2,y2"

选区交互

基本信息

Path： /marketing/algorithm/run_iteractive_segmentation

Method： POST

接口描述：

接口描述：
功能描述
调用者提供图片，通过添加保留点和去除点可选择图片中的区域，添加保留点后会自动识别保留点周边的区域，并生成对应选区，添加删除点后会自动识别删除点周边的区域，并删除对应区域的选区
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_run_iteractive_segmentation
qps :10
接口为同步接口，无需异步获取。
功能示例
1.原图 2.添加‘保留点’

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	备注
image	string	必须	参考图 oss path
fg_points	string	非必须	保留点（归一化0～1相对值），包含历史有效点字符串x,y@x,y@x,y格式
bg_points	string	非必须	去除点（归一化0～1相对值），包含历史有效点字符串x,y@x,y@x,y格式

返回数据

名称	类型	是否必须
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	object	非必须
├─ key	string	非必须

细节提升

基本信息

Path： /marketing/algorithm/detail_enhance

Method： POST

接口描述：

接口描述：
功能描述
根据用户上传的模特图进行细节提升。
使用说明

上传模特原图、选择是否进行服饰提升、是否进行面部提升和生成张数
上传参数后返回对应任务id，根据调用链路查询生成结果

图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_detail_enhance
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取
功能示例

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注
image_face	string	必须		输入面部图像，为url
isImageUpscale	boolean	非必须	false	是否服饰提升。默认:false不使用
isFaceEnhance	boolean	非必须	false	是否头部提升。默认:false不使用
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口

返回数据

名称	类型	是否必须	备注
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	integer	非必须	任务id

AI背景图生文

基本信息

Path： /marketing/algorithm/llava_person_background_caption

Method： POST

接口描述：

接口描述：
功能描述
根据用户上传背景图片反推prompt
使用说明
上传背景图，调用接口返回根据背景图推理出的prompt
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_llava_person_background_caption
qps :10
接口为同步接口，无需异步获取。
功能示例
背景图

prompt:The background of the image features a park with a pathway lined with trees and benches. The pathway is surrounded by grass and plants, creating a serene and inviting atmosphere. The trees provide shade and a sense of tranquility, making it an ideal place for relaxation and leisure activities.

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
image	string	必须		图像可访问的url

返回数据

名称	类型	是否必须	备注
requestId	string	非必须
code	integer	非必须
message	string	非必须
data	string	非必须	prompt

手脚修复

基本信息

Path： /marketing/algorithm/flux_inpainting_app

Method： POST

接口描述：

接口描述：
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_flux_inpainting_app
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注
image	string	必须		参考图 oss path
mask	string	非必须		输入mask 图像base64或url，修手脚时非必需，其余必需。仅auto_hands_feet_fix，auto_hands_fix，auto_feet_fix均为false时生效
read_from_url	boolean	非必须	true	是否从url读取图像和mask url或base获取 true为url，false为base64，默认为false
auto_hands_feet_fix	boolean	非必须	false	自动修手脚默认false。自动修手、自动修脚、自动修手脚三项中有超过一项为true时，生效优先级：auto_hands_feet_fix > auto_hands_fix > auto_feet_fix
auto_hands_fix	boolean	非必须	false	自动修手默认false
auto_feet_fix	boolean	非必须	false	自动修脚默认false
ori_size_return	boolean	非必须	true	是否返回原尺寸图片默认true
batch_size	integer	非必须	8	生成图片数量 [1, 8]区间整数，默认8
id	integer	非必须		创建ID
name	string	非必须		名称，默认使用UUID;不可重复
businessKey	string	非必须		业务字段，业务方可以自定义
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口

返回数据

名称	类型	是否必须	备注
requestId	string	非必须	请求编号
code	integer	非必须	响应码
message	string	非必须	响应消息
data	integer	非必须	该值为任务ID。在“异步任务API调用”中，通过传入该值，得到生成结果

服饰修复

基本信息

Path： /marketing/algorithm/product_repair_app

Method： POST

接口描述：

接口描述：
图片要求
图片格式：'.JPG', '.PNG', '.JPEG'
图片大小：不超过20MB
接口说明
appKey: marketing-server
apiName: marketing_algorithm_product_repair_app
qps: 10
接口为异步接口，结果获取：
1.可通过回调方式获取，具体回调机制参考任务异步回调说明(推荐)
2.通过查询任务接口获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注
repair_type	string	非必须		枚举值："detail_repair"、"pattern_repair"。detail_repair为细节修复，pattern_repair为款式修复，当选择"detail_repair"时，ref_mask为必填项。该字段未传参时，默认调用"pattern_repair"款式修复。
image	string	必须		输入图像/待修复图像，图像base64或url
mask	string	必须		输入图像/待修复图像的mask图像，图像base64或url
ref_image	string	必须		参考图像，图像base64或url
ref_mask	string	非必须		参考图像的mask图像，图像base64或url，当repair_type选择"detail_repair"时，ref_mask为必填项。
inference_steps	integer	非必须	20	推理步数默认为20
guidance_scale	integer	非必须	35	guidance scale 默认为35
read_from_url	boolean	非必须	true	是否从url读取图像和Maskurl或base获取 true为url，False为base64
batch_size	integer	非必须	1	生成图片数量 [1, 8]区间整数，默认1
callBackUrl	string	非必须		异步任务回调url,具体格式请参考异步回调接口

返回数据

名称	类型	是否必须	备注
requestId	string	非必须	请求编号
code	integer	非必须	响应码
message	string	非必须	响应消息
data	integer	非必须	该值为任务ID。在“异步任务API调用”中，通过传入该值，得到生成结果

图案抠图

基本信息

Path： /marketing/algorithm/pattern_seg

Method： POST

接口描述：

接口描述：
appKey: marketing-server
api_name: marketing_algorithm_pattern_seg
接口为同步接口，无需异步获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
image	string	必须		款式图，url格式
return_view_image	boolean	非必须	false	True返回抠图view_image_url以及mask_url。False只返回 mask_url。默认False

返回数据

名称	类型	是否必须	备注
requestId	string	非必须	请求编号
code	integer	非必须	响应码
message	string	非必须	响应消息
data	object	非必须
├─ image_mask	string	非必须	mask 灰度图,单通道alpha值，url格式
├─ view_image	string	非必须	抠图前景透明底图，rgba四通道，url格式，仅在return_view_image 为True时候返回

人像抠图

基本信息

Path： /marketing/algorithm/human_seg

Method： POST

接口描述：

接口描述：
appKey: marketing-server
api_name: marketing_algorithm_human_seg
接口为同步接口，无需异步获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
image	string	必须		款式图，url格式
return_view_image	boolean	非必须	false	True返回抠图view_image_url以及mask_url。False只返回 mask_url。默认False

返回数据

名称	类型	是否必须	备注
requestId	string	非必须	请求编号
code	integer	非必须	响应码
message	string	非必须	响应消息
data	object	非必须
├─ image_mask	string	非必须	mask 灰度图,单通道alpha值，url格式
├─ view_image	string	非必须	抠图前景透明底图，rgba四通道，url格式，仅在return_view_image 为True时候返回

服饰抠图

基本信息

Path： /marketing/algorithm/cloth_seg

Method： POST

接口描述：

接口描述：
appKey: marketing-server
api_name: marketing_algorithm_cloth_seg
接口为同步接口，无需异步获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注
image	string	必须		款式图，url格式
cate_token	string	非必须	overall	服饰分割传参 'upper','lower','overall',默认值为'overall'
return_view_image	boolean	非必须	false	True返回抠图view_image_url以及mask_url。False只返回 mask_url。默认False

返回数据

名称	类型	是否必须	备注
requestId	string	非必须	请求编号
code	integer	非必须	响应码
message	string	非必须	响应消息
data	object	非必须
├─ image_mask	string	非必须	mask 灰度图,单通道alpha值，url格式
├─ view_image	string	非必须	抠图前景透明底图，rgba四通道，url格式，仅在return_view_image 为True时候返回

通用抠图

基本信息

Path： /marketing/algorithm/general_seg

Method： POST

接口描述：

接口描述：
appKey: marketing-server
api_name: marketing_algorithm_general_seg
接口为同步接口，无需异步获取

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
image	string	必须		款式图，url格式
return_view_image	boolean	非必须	false	True返回抠图view_image_url以及mask_url。False只返回 mask_url。默认False

返回数据

名称	类型	是否必须	备注
requestId	string	非必须	请求编号
code	integer	非必须	响应码
message	string	非必须	响应消息
data	object	非必须
├─ image_mask	string	非必须	mask 灰度图,单通道alpha值，url格式
├─ view_image	string	非必须	抠图前景透明底图，rgba四通道，url格式，仅在return_view_image 为True时候返回

任务管理

任务异步回调

基本信息

Path： /marketing/task/call_back

Method： POST

接口描述：

1. 回调接口要求
调用方首先需要定义一个回调接口，用于异步任务完成后通知回调方。接口包括任务ID、状态、结果、失败原因字段。
请求方式：POST
回调URL：该链接是通过任务提交口中的请求参数“callBackUrl”来设置的，要求必须为HTTPS地址。请确保回调URL是外部可正常访问的，且不能携带后缀参数，否则可能导致客户无法接收到回调通知信息。回调地址超时时间默认是500毫秒。
2.请求示例:
curl --location --request POST 'http://open.metac-inc.com/api'
--header 'requestId: 123456789'
--header 'accessKey: ak'
--header 'apiName: marketing_algorithm_tryon'
--header 'appKey: marketing-server'
--header 'timestamp: 123456789'
--header 'sign: 24ea072b7b9949799ddecb95df13c5ab'
--header 'Content-Type: application/json'
--data-raw '{
"batch_size": 1,
"image_cloth": null,
"mask_cloth": null,
"image_cloth1": "xxxxx",
"mask_cloth1": "xxxxxx",
"list_images_human": ["xxx"],
"list_masks_human": null,
"cloth_length": "overall"
"callBackUrl": "潮际可访问的url"
}'
3. 回调规则
客户提交的异步任务执行完成后，我们会把相关任务结果信息发送给客户，客户需要接收处理该消息，并返回应答。
接收成功： HTTP应答状态码需返回200，同时应答报文如下：
{
"code": 2000,
"message": "成功"
}
接收失败：HTTP应答状态码(httpstatus)需5XX或4XX（请求失败），返回应答报文，格式如下：
{
"code": 501,
"message": "失败"
}
后台回调交互时，如果我们收到客户的应答不符合规范或超时，我们会认为通知失败，我们会通过一定的策略定期重新发起回调通知，尽可能提高回调通知的成功率，但我们不保证通知最终能成功。（通知频率为0s/2s/60s/180s - 总计4次,持续242s）
回调重试可能存在丢失或者降级的情况。比如请求大批量报错或者回调请求服务宕机，重试的请求增多，资源不足，会存在降级等待时间，当重试请求达到一定数量未处理时，会把多余的请求丢掉，避免内存溢出等风险。
4. 回调字段说明：


字段名	类型	备注
code	integer	响应码
message	string	响应消息
data	String	结果。data字段请参考：异步API任务结果查询接口
requestId	String	请求编号

接口curl示例：
curl --location --request POST 'localhost/path'
--header 'Content-Type: application/json'
--data-raw '{
"requestId": "123456789",
"code": 2000,
"message": "success",
"data": {
"id": 1,
"status": 2,
"createBy": "1",
"createTime": "2024-09-19 14:42:13",
"updateBy": "1",
"updateTime": "2024-09-19 14:42:47",
"tenantId": 1,
"name": "b6c4d877-9701-4f7e-820d-88b43ebd9d2237",
"requestId": "a444e318-e308-4e97-a427-a3b5262e8b55",
"errorMsg": null,
"remark": null,
"marketingModelTaskOutputVOS": [{
"workOutputUrl": "xxxxx",
"id": 1,
"name": "b6c4d877-9701-4f7e-820d-88b43ebd9d2237_0",
"status": 1,
"createBy": "1",
"createTime": "2024-09-19 14:42:47",
"updateBy": "1",
"updateTime": "2024-09-19 14:42:47",
"remark": null
}]
}
}'

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是

Body

名称	类型	是否必须	备注	其他信息
code	integer	非必须
message	string	非必须
data	object	非必须
├─ marketingModelTaskOutputVOS	object []	非必须	任务产出详情	item 类型: object
├─ workOutputUrl	string	非必须	输出作品url
├─ id	integer	非必须	主键
├─ name	string	非必须	名称
├─ taskId	integer	非必须	任务ID
├─ outputType	string	非必须	作品类型
├─ status	integer	非必须	状态
├─ createBy	string	非必须	创建人
├─ createTime	string	非必须	创建时间	mock: @datetime
├─ updateBy	string	非必须	修改人
├─ updateTime	string	非必须	修改时间	mock: @datetime
├─ remark	string	非必须	备注
├─ id	integer	非必须	主键
├─ name	string	非必须	名称
├─ bizType	string	非必须	业务类型
├─ failReason	string	非必须	失败原因
├─ requestId	string	非必须	全局请求id
├─ endTime	string	非必须	任务完成时间	mock: @datetime
├─ priority	integer	非必须	任务优先级 0:低（离线任务）1:正常 2:高
├─ status	integer	非必须	状态
├─ createBy	string	非必须	创建人
├─ createTime	string	非必须	创建时间	mock: @datetime
├─ updateBy	string	非必须	修改人
├─ updateTime	string	非必须	修改时间	mock: @datetime
├─ remark	string	非必须	备注
requestId	string	非必须

返回数据

名称	类型	是否必须	默认值	备注	其他信息
code	integer	非必须
message	string	非必须

查询任务

基本信息

Path： /marketing/model_task/fetchWithMarketingModelTaskOutputPO

Method： GET

接口描述：

接口说明
appKey: marketing-server
apiName: marketing_model_task_fetchWithMarketingModelTaskOutputPO_id
qps: 10
描述
调通过异步的算法服务接口返回的任务id查询任务结果。
目前API还不支持离线任务。
status 枚举值： 1. 处理中 2.成功 3.失败 5.离线待调度 6.部分失败 7.排队中
部分任务失败说明：假如一条任务生成4张图，有一张图失败，此时的任务状体为：6，对应marketingModelTaskOutputVOS 的长度为：3

请求参数

Query

参数名称	是否必须	示例	备注
id	是		任务id

返回数据

名称	类型	是否必须	备注	其他信息
code	integer	非必须
message	string	非必须
data	object	非必须
├─ marketingModelTaskOutputVOS	object []	非必须	任务产出详情	item 类型: object
├─ workOutputUrl	string	非必须	输出作品url
├─ id	integer	非必须	主键
├─ name	string	非必须	名称
├─ taskId	integer	非必须	任务ID
├─ outputType	string	非必须	作品类型
├─ createBy	string	非必须	创建人
├─ createTime	string	非必须	创建时间	mock: @datetime
├─ updateBy	string	非必须	修改人
├─ updateTime	string	非必须	修改时间	mock: @datetime
├─ remark	string	非必须	备注
├─ id	integer	非必须	主键
├─ name	string	非必须	名称
├─ bizType	string	非必须	业务类型
├─ failReason	string	非必须	失败原因
├─ requestId	string	非必须	全局请求id
├─ endTime	string	非必须	任务完成时间	mock: @datetime
├─ priority	integer	非必须	任务优先级 0:低（离线任务）1:正常 2:高
├─ status	integer	非必须	状态
├─ createBy	string	非必须	创建人
├─ createTime	string	非必须	创建时间	mock: @datetime
├─ updateBy	string	非必须	修改人
├─ updateTime	string	非必须	修改时间	mock: @datetime
├─ remark	string	非必须	备注
requestId	string	非必须

新增任务

基本信息

Path： /marketing/model_task/add_task

Method： POST

接口描述：

接口说明
该接口后续会下线，请直接使用算法接口发起任务
appKey: marketing-server
apiName: marketing_model_task_add_task
qps: 10

inputConfig字段json格式示例
比如虚拟试衣：
{
"name":"uuidXXXXX",
"bizType":"MODEL_TRYON",
"inputConfig":"{"batch_size":1,"image_cloth":null,"mask_cloth":null,"image_cloth1":"xxxxx","mask_cloth1":"xxxxxx","list_images_human":["xxx"],"list_masks_human":null,"cloth_length":"overall"}"
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	备注
name	string	非必须	任务名称，可以自定义
bizType	string	必须	任务类型，参考好麦算法接口说明
inputConfig	string	必须	算法所需入参，jsonString格式。示例参考接口说明。入参字段请参考具体算法接口文档；

返回数据

名称	类型	是否必须	备注
code	integer	非必须	响应吗
message	string	非必须	响应消息
data	integer	非必须	任务id
requestId	string	非必须	请求id

执行任务

基本信息

Path： /marketing/model_task/execute_task

Method： POST

接口描述：

接口说明
appKey: marketing-server
apiName: marketing_model_task_execute_task
qps: 10

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
taskId	integer	必须		任务id
priority	integer	非必须	1	任务优先级（0:离线任务，将会在资源空闲时执行任务，执行优先级最低；1:普通任务）

返回数据

名称	类型	是否必须	备注
code	integer	非必须	请求响应码
message	string	非必须	请求响应消息
data	integer	非必须	任务id
requestId	string	非必须	请求id

批量取消任务

基本信息

Path： /batch_cancel_task

Method： POST

接口描述：

描述
调通过id批量取消任务，只允许取消排队中（status=7）且是调用者本人创建的任务。
status 枚举值： 1. 处理中 2:成功 3.失败 5.离线待调度 6.部分失败7.排队中
说明
apiName: marketing_model_task_batch_cancel_task
appkey： marketing-server

请求示例

curl --location --request POST 'http://open.metac-inc.com/api' \
--header 'requestId: uuid123' \
--header 'accessKey: ak' \
--header 'apiName: marketing_model_task_batch_cancel_task' \
--header 'appKey: marketing-server' \
--header 'timestamp: 1755502590173' \
--header 'sign: sign' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ids":[1,2]
}'

返回示例

{
    "requestId": "1755514953293",
    "code": 2000,
    "message": "success",
    "data": {
        "failIds": null
    },
    "succ": true
}

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	是	application/json

Body

名称	类型	是否必须	默认值	备注	其他信息
ids	long []	非必须			item 类型: long
├─		非必须

返回数据

名称	类型	是否必须	备注	其他信息
code	integer	非必须	请求响应码
message	string	非必须	请求响应消息
data	object	非必须	请求结果
├─ failIds	long []	必须	任务已开始执行会取消失败, 如果全部取消成功该字段为空	item 类型: long
├─		非必须
requestId	string	非必须	请求id

YAPI 接口文档

潮际好麦标准API文档

好麦算法

虚拟试鞋

基本信息

请求参数

返回数据

素材生成-图生图

基本信息

请求参数

返回数据

图片超清

基本信息

请求参数

返回数据

模特换姿势

基本信息

请求参数

返回数据

AI试戴

基本信息

请求参数

返回数据

素材生成-文生图

基本信息

请求参数

返回数据

米豆剩余量查询

基本信息

请求参数

返回数据

商品修复（鞋靴）

基本信息

请求参数

返回数据

模特生成

基本信息

请求参数

返回数据

图生视频

基本信息

请求参数

返回数据

服饰换色

基本信息

请求参数

返回数据

虚拟试衣(废弃，请使用：模特试衣-真人试衣/ 模特试衣-平铺/人台试衣

基本信息

请求参数

返回数据

模特试衣（真人试衣）

基本信息

请求参数

返回数据

模特试衣（平铺/人台试衣）

基本信息

请求参数

返回数据

材质增强（模特试衣）

基本信息

请求参数

返回数据

AI人像换背景-文生图

基本信息

请求参数

返回数据

AI人像换背景-单图复刻

基本信息

请求参数

返回数据

AI人像换背景-风格背景

基本信息

请求参数

返回数据

AI商品图

基本信息

请求参数

返回数据

商品换背景（高相似度）