跳转到内容

AI 包虚拟试戴

概览

AR 让精品包的选购变得实实在在!AR 技术让品牌以极致的真实感呈现手袋:从肩带长度到包款搭配,顾客通过相机就能即刻看到上身效果。

接入指南

本指南将带您走完全流程:

  • 接口地址: /s2s/v2.0/task/bag
  • 鉴权: 所有请求都需要 Authorization: Bearer YOUR_API_KEY
  • 流程:
    1. 准备自拍照: 上传您自己的图片或提供有效图片 URL,作为虚拟试背的目标。
    2. 准备包图片: 上传包商品图,或提供一位无遮挡的拎包人物图片的有效 URL。
    3. 选择风格与性别: 挑选您偏好的风格,以及您想呈现的性别。
    4. 发起 AI 任务并取得 Task ID: 从响应中取回 task_id。
    5. 轮询状态(GET): 用 task_id 查看任务状态,持续轮询直到 task_status 为 "success" 或 "error"。

  • 鉴权
  • 请在请求头中以 Bearer Token 方式带上您的 API 密钥:
Authorization: Bearer YOUR_API_KEY

API Key 可在 https://yce.makeupar.com/api-console/en/api-keys/ 获取。


  • AI 包接口使用指引

本指引说明如何上传图片、准备参考包,以及创建虚拟试背任务。


  • 第 1 步:用 File 接口上传文件

用 File 接口(/s2s/v2.0/file)上传目标用户图片。

图片要求:

  • 上传一张自拍照。
  • 确保照片把上半身清楚呈现出来。
  • 避免背景里有多人,或杂乱干扰的物体。

请求示例:

curl --request POST \
  --url https://yce-api-01.makeupar.com/s2s/v2.0/file \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'content-type: application/json' \
  --data '{
    "files": [
      {
        "content_type": "image/jpg",
        "file_name": "selfie_photo_01_3dbd1b6683.jpg",
        "file_size": 547541
      }
    ]
  }'

  • 第 2 步:取得 File 接口响应

响应中包含:

  • 用于创建 AI 任务的 file_id。
  • 用于上传实际图片文件的 requests.url。

响应示例:

{
  "status": 200,
  "data": {
    "files": [
      {
        "content_type": "image/jpg",
        "file_name": "selfie_photo_01_3dbd1b6683.jpg",
        "file_id": "SaGaqpDgKwFrVBgMpQMA3HY0LeqdT9/13W5TOD8/u/FfjK3xgCQ+hRt9MJXBFaud",
        "requests": [
          {
            "method": "PUT",
            "url": "https://yce-us.s3-accelerate.amazonaws.com/demo/ttl30/...signature...",
            "headers": {
              "Content-Length": "547541",
              "Content-Type": "image/jpg"
            }
          }
        ]
      }
    ]
  }
}

  • 第 3 步:把图片上传到提供的 URL

用 File 接口响应中的 requests.url 上传图片:

curl --location --request PUT 'https://yce-us.s3-accelerate.amazonaws.com/demo/ttl30/...signature...' \
  --header 'Content-Type: image/jpg' \
  --header 'Content-Length: 547541' \
  --data-binary @'./selfie_photo_01_3dbd1b6683.jpg'

  • 第 4 步:准备参考包图片

您可以:

  • 用 File 接口(/s2s/v2.0/file)上传包图片,或
  • 提供一个有效的图片 URL。

支持的包图片:

  • 包的商品图。
  • 一位无遮挡的拎包人物图片,作为包参考。

详细规格见 文件规格与错误码。


  • 第 5 步:创建 AI 任务

挑选您偏好的风格与想呈现的性别。 用 AI 任务接口(/s2s/v2.0/task/bag)创建虚拟试背任务。

参数:

  • 用户图片:src_file_id 或 src_file_url。
  • 包图片:ref_file_id 或 ref_file_url。

请求示例:

curl --request POST \
  --url https://yce-api-01.makeupar.com/s2s/v2.0/task/bag \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'content-type: application/json' \
  --data '{
    "src_file_url": "https://example.com/selfie.jpg",
    "ref_file_url": "https://example.com/accessory.jpg",
    "gender": "female",
    "style": "random"
}'

响应示例:

{
  "status": 200,
  "data": {
    "task_id": "SaGaqpDgKwFrVBgMpQMA3HY0LeqdT9_13W5TOD8_u_GPi6NqQ3dhlmN-6ntFwhzT"
  }
}

  • 第 6 步:轮询任务结果

用任务 ID 查看状态:

curl --request GET \
  --url https://yce-api-01.makeupar.com/s2s/v2.0/task/bag/SaGaqpDgKwFrVBgMpQMA3HY0LeqdT9_13W5TOD8_u_GPi6NqQ3dhlmN-6ntFwhzT \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'content-type: application/json'

  • 第 7 步:取回结果

成功的响应会给出结果图片的下载 URL:

{
  "status": 200,
  "data": {
    "error": null,
    "results": {
      "url": "https://yce-us.s3-accelerate.amazonaws.com/demo/ttl30/...signature..."
    },
    "task_status": "success"
  }
}

API 密钥无效的报错响应:

{
  "status": 401,
  "error": "Unauthorized",
  "error_code": "InvalidAccessToken"
}

文件规格与错误码

  • AI 包虚拟试戴规格

支持的包图片

  • 商品图要求
    • 最低分辨率:512 × 512 像素
    • 每张图片只放一件商品
    • 商品应占图片高度的 25% 以上

  • 实拍照要求
    • 最低分辨率:800 × 800 像素

支持的自拍视角

  • 建议图片分辨率:至少 512 × 512 像素。
  • 建议脸部占比:超过图片高度的 15%。
  • 图片必须清楚呈现单一真人主体,脸部完整可见,画面至少包含从头顶到胸口的头像照,半身照更佳。

试背风格

  • 生成虚拟试背结果有四种预设风格:"style_parisian_chic"、"style_urban_chic"、"style_mediterranean_chic" 与 "style_art_deco_style"。创建 AI 任务时可指定该风格参数;不指定时,系统默认随机挑选。

style_parisian_chic


  • 支持的格式与尺寸
AI 功能支持尺寸支持文件大小支持格式
AI 包虚拟试戴输入:长边 <= 4096
输出:1104 x 1472
< 10MBjpg/jpeg/png/heic
  • 错误码
错误码说明
error_download_image下载 srcKeys/refKeys 出错
error_inference推理流程出错
error_no_face源图中未检测到人脸
error_nsfw_content_detected在结果图中检测到不适宜内容(NSFW)
exceed_max_filesize输入文件大小超出上限(10 MB)
invalid_parameter性别选项取值无效
风格选项取值无效
unknown_internal_error其他
  • 运行环境与依赖
示例代码语言 / 工具建议运行时版本
cURL- bash >= 3.2
- curl >= 7.58 (modern TLS/HTTP support)
- jq >= 1.6 (robust JSON parsing)
Node.js (JavaScript)Node >= 18 (for global fetch)
JavaScript- Chrome / Edge >= 80
- Firefox >= 74
- Safari >= 13.1
PHPPHP >= 7.4 (for modern TLS/compat), ext-curl (recommended) or allow_url_fopen=On + ext-openssl, ext-json
PythonPython >= 3.10 (for f-strings), requests >= 2.20.0
JavaJava 11+ (for HttpClient), Jackson Databind >= 2.12.0

点数消耗

AI 功能消耗点数
AI 包虚拟试戴 V2.02

下载 OpenAPI 描述
语言
服务器
https://yce-api-01.makeupar.com