Skip to content

AI Ring Virtual Try-On API (v1.8) (1.0.0)

Easily Create Your AR Ring or Engagement Ring Try Ons. You Only Need to Upload Images. Opt for 2D images for effortless yet high-quality virtual try-on experiences with minimal effort.

Download OpenAPI description
ring_vto.json
ring_vto.yaml
Languages
Servers
Production server
https://api.example.com

AI Ring Virtual Try-On

Request

Easily Create Your AR Ring or Engagement Ring Try Ons. You Only Need to Upload Images.

Bodyapplication/jsonrequired
One of:
source_infoobject(SourceInfo)required
source_info.​namestringrequired

The source url or File ID.

Example: "https://example.com/selfie.jpg"
source_info.​mask_namestring or null

The source mask url or File ID.

Default null
Example: "https://example.com/src_mask.jpg"
ref_file_urlsArray of stringsrequired

Url of the reference file to run task. The url should be publicly accessible.

Example: ["https://example.com/vto_sku.jpg"]
refmsk_file_urlsArray of strings or null

Url of the reference mask file to run task. The url should be publicly accessible.

Default null
Example: ["https://example.com/vto_sku_mask.jpg"]
src_file_urlstringrequired

Url of the file to run task. The url should be publicly accessible.

Example: "https://example.com/selfie.jpg"
srcmsk_file_urlstring or null

Url of the source mask file to run task. The url should be publicly accessible.

Default null
Example: "https://example.com/src_mask.jpg"
object_infosArray of objects(ObjectInfo)required
object_infos[].​namestringrequired

The reference url or File ID. Indicate which reference product image should be matched.

Example: "https://example.com/vto_sku.jpg"
object_infos[].​mask_namestring or null

The reference mask url or File ID. Indicate which reference product image should be matched.

Default null
Example: "https://example.com/vto_sku_mask.jpg"
object_infos[].​parameterobject(RingParameter)
curl -i -X POST \
  https://api.example.com/s2s/v2.0/task/ring \
  -H 'Content-Type: application/json' \
  -d '{
    "source_info": {
      "name": "https://example.com/selfie.jpg",
      "mask_name": "https://example.com/src_mask.jpg"
    },
    "ref_file_urls": [
      "https://example.com/vto_sku.jpg"
    ],
    "refmsk_file_urls": [
      "https://example.com/vto_sku_mask.jpg"
    ],
    "src_file_url": "https://example.com/selfie.jpg",
    "srcmsk_file_url": "https://example.com/src_mask.jpg",
    "object_infos": [
      {
        "name": "https://example.com/vto_sku.jpg",
        "mask_name": "https://example.com/vto_sku_mask.jpg",
        "parameter": {
          "ring_ambient_light_intensity": 1,
          "ring_anchor_point": null,
          "ring_need_remove_background": true,
          "ring_shadow_intensity": 0.15,
          "ring_wearing_finger": null,
          "ring_wearing_location": null
        }
      }
    ]
  }'

Responses

Successful response

Bodyapplication/json
dataobject
Response
application/json
{
  "data": {
    "task_id": "string",
    "status": "string",
    "results": [ … ]
  }
}