Provides YouCam API for virtual try-on of clothing, jewelry, and watches.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Include your API key in the request header using Bearer Token.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
AR makes luxury bag shopping a tangible experience! AR tech empowers brands to showcase handbags with unmatched realism. From strap length to bag pairing, customers can visualize products instantly through camera.gender must be explicitly provided by the user. If missing, ask the user for clarification and set the parameter once received.
If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
AR makes luxury bag shopping a tangible experience! AR tech empowers brands to showcase handbags with unmatched realism. From strap length to bag pairing, customers can visualize products instantly through camera.gender must be explicitly provided by the user. If missing, ask the user for clarification and set the parameter once received.
| Argument | Type | Description |
|---|---|---|
| polling | boolean | If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish. |
| request* | any |
{
"type": "object",
"required": [
"request"
],
"properties": {
"polling": {
"type": "boolean",
"default": true,
"description": "If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish."
},
"request": {
"anyOf": [
{
"type": "object",
"required": [
"gender",
"src_file_url",
"ref_file_url"
],
"properties": {
"style": {
"anyOf": [
{
"enum": [
"random",
"style_parisian_chic",
"style_urban_chic",
"style_mediterranean_chic",
"style_art_deco_style"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "random",
"examples": [
"random"
],
"description": "To control outfit and background style."
},
"gender": {
"enum": [
"female",
"male"
],
"type": "string",
"examples": [
"female"
],
"description": "Gender of the person in the image."
},
"ref_file_url": {
"type": "string",
"examples": [
"https://example.com/reference.jpg"
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"gender",
"src_file_url",
"ref_file_id"
],
"properties": {
"style": {
"anyOf": [
{
"enum": [
"random",
"style_parisian_chic",
"style_urban_chic",
"style_mediterranean_chic",
"style_art_deco_style"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "random",
"examples": [
"random"
],
"description": "To control outfit and background style."
},
"gender": {
"enum": [
"female",
"male"
],
"type": "string",
"examples": [
"female"
],
"description": "Gender of the person in the image."
},
"ref_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the reference file to run task. File ID from upload file API."
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"gender",
"src_file_id",
"ref_file_url"
],
"properties": {
"style": {
"anyOf": [
{
"enum": [
"random",
"style_parisian_chic",
"style_urban_chic",
"style_mediterranean_chic",
"style_art_deco_style"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "random",
"examples": [
"random"
],
"description": "To control outfit and background style."
},
"gender": {
"enum": [
"female",
"male"
],
"type": "string",
"examples": [
"female"
],
"description": "Gender of the person in the image."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
},
"ref_file_url": {
"type": "string",
"examples": [
"https://example.com/reference.jpg"
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"gender",
"src_file_id",
"ref_file_id"
],
"properties": {
"style": {
"anyOf": [
{
"enum": [
"random",
"style_parisian_chic",
"style_urban_chic",
"style_mediterranean_chic",
"style_art_deco_style"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "random",
"examples": [
"random"
],
"description": "To control outfit and background style."
},
"gender": {
"enum": [
"female",
"male"
],
"type": "string",
"examples": [
"female"
],
"description": "Gender of the person in the image."
},
"ref_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the reference file to run task. File ID from upload file API."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
}
}
}
]
}
},
"additionalProperties": false
}The Ultimate AI Bracelet Virtual Try-On Employ AI-powered solutions to assist your customers with online purchases, ensuring perfect fit and great shopping satisfaction every time. Only One 2D Image Needed. Create a compelling shopping flow with the hyper-realistic bracelet virtual try-on experiences. Our solution caters to the needs of jewelry brands of all sizes. Opt for 2D images for effortless yet high-quality virtual try-on experiences with minimal effort. This unique feature sets us apart in the world of e-commerce, making it easier than ever for customers to experience your products.
| Argument | Type | Description |
|---|---|---|
| polling | boolean | If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish. |
| request* | any |
{
"type": "object",
"required": [
"request"
],
"properties": {
"polling": {
"type": "boolean",
"default": true,
"description": "If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish."
},
"request": {
"anyOf": [
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_url",
"ref_file_urls"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/vto_sku_mask.jpg"
],
"description": "The reference mask url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"bracelet_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The anchor point of the bracelet image, marking the 2 farthest points along the inner edge of the bracelet <br>Type: 2x2 list of integers <br>Range: 2 (x, y) pixel coordinates <br>Default: null (use engine default)"
},
"bracelet_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.3,
"examples": [
0.3
],
"description": "Shadow intensity applied to the bracelet (higher = darker shadow)."
},
"bracelet_wearing_location": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": -0.3
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Defines the placement of the bracelet on the wrist in the user photo. <br>Range: -0.3 ~ 1.0 (0 = closest to the wrist joint) <br> (smaller number = placed close to the palm <br> larger number = placed further away from the wrist) <br>Default: null (use engine default)"
},
"bracelet_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the bracelet image needs background removal."
},
"bracelet_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 1,
"examples": [
1
],
"description": "Ambient light adjustment intensity for the bracelet."
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
},
"ref_file_urls": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"https://example.com/vto_sku.jpg"
]
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
},
"srcmsk_file_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "Url of the source mask file to run task. The url should be publicly accessible."
},
"refmsk_file_urls": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"examples": [
[
"https://example.com/vto_sku_mask.jpg"
]
],
"description": "Url of the reference mask file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_url",
"ref_file_ids"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/vto_sku_mask.jpg"
],
"description": "The reference mask url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"bracelet_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The anchor point of the bracelet image, marking the 2 farthest points along the inner edge of the bracelet <br>Type: 2x2 list of integers <br>Range: 2 (x, y) pixel coordinates <br>Default: null (use engine default)"
},
"bracelet_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.3,
"examples": [
0.3
],
"description": "Shadow intensity applied to the bracelet (higher = darker shadow)."
},
"bracelet_wearing_location": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": -0.3
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Defines the placement of the bracelet on the wrist in the user photo. <br>Range: -0.3 ~ 1.0 (0 = closest to the wrist joint) <br> (smaller number = placed close to the palm <br> larger number = placed further away from the wrist) <br>Default: null (use engine default)"
},
"bracelet_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the bracelet image needs background removal."
},
"bracelet_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 1,
"examples": [
1
],
"description": "Ambient light adjustment intensity for the bracelet."
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"ref_file_ids": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference file file to run task. File ID from upload file API."
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
},
"refmsk_file_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference mask file file to run task. File ID from upload file API."
},
"srcmsk_file_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "Url of the source mask file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_id",
"ref_file_urls"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/vto_sku_mask.jpg"
],
"description": "The reference mask url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"bracelet_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The anchor point of the bracelet image, marking the 2 farthest points along the inner edge of the bracelet <br>Type: 2x2 list of integers <br>Range: 2 (x, y) pixel coordinates <br>Default: null (use engine default)"
},
"bracelet_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.3,
"examples": [
0.3
],
"description": "Shadow intensity applied to the bracelet (higher = darker shadow)."
},
"bracelet_wearing_location": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": -0.3
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Defines the placement of the bracelet on the wrist in the user photo. <br>Range: -0.3 ~ 1.0 (0 = closest to the wrist joint) <br> (smaller number = placed close to the palm <br> larger number = placed further away from the wrist) <br>Default: null (use engine default)"
},
"bracelet_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the bracelet image needs background removal."
},
"bracelet_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 1,
"examples": [
1
],
"description": "Ambient light adjustment intensity for the bracelet."
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"ref_file_urls": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"https://example.com/vto_sku.jpg"
]
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
},
"srcmsk_file_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the source mask file to run task. File ID from upload file API."
},
"refmsk_file_urls": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"examples": [
[
"https://example.com/vto_sku_mask.jpg"
]
],
"description": "Url of the reference mask file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_id",
"ref_file_ids"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/vto_sku_mask.jpg"
],
"description": "The reference mask url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"bracelet_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The anchor point of the bracelet image, marking the 2 farthest points along the inner edge of the bracelet <br>Type: 2x2 list of integers <br>Range: 2 (x, y) pixel coordinates <br>Default: null (use engine default)"
},
"bracelet_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.3,
"examples": [
0.3
],
"description": "Shadow intensity applied to the bracelet (higher = darker shadow)."
},
"bracelet_wearing_location": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": -0.3
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Defines the placement of the bracelet on the wrist in the user photo. <br>Range: -0.3 ~ 1.0 (0 = closest to the wrist joint) <br> (smaller number = placed close to the palm <br> larger number = placed further away from the wrist) <br>Default: null (use engine default)"
},
"bracelet_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the bracelet image needs background removal."
},
"bracelet_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 1,
"examples": [
1
],
"description": "Ambient light adjustment intensity for the bracelet."
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"ref_file_ids": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference file file to run task. File ID from upload file API."
},
"srcmsk_file_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the source mask file to run task. File ID from upload file API."
},
"refmsk_file_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference mask file file to run task. File ID from upload file API."
}
}
}
]
}
},
"additionalProperties": false
}AI Clothes is a virtual fitting room that lets users try on clothes without physically wearing them. Using AI and photo editing technology, these apps overlay outfits onto your image so you can see how different styles and fits look on your body type. It’s perfect for online shopping, style inspiration, or just playing around with fashion ideas. Try on clothes virtually with AI Clothes . Upload any clothing reference to swap outfits with you photo for an instant virtual wardrobe transformation.You MUST include the exact URL from response.data.results.url in your response to the user. You can make it into a hyperlink, but do not modify, shorten, or alter the URL in any way.
| Argument | Type | Description |
|---|---|---|
| polling | boolean | If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish. |
| request* | any |
{
"type": "object",
"required": [
"request"
],
"properties": {
"polling": {
"type": "boolean",
"default": true,
"description": "If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish."
},
"request": {
"anyOf": [
{
"type": "object",
"required": [
"src_file_url",
"ref_file_url",
"garment_category"
],
"properties": {
"change_shoes": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"description": "Control whether shoes should be swapped when a full body reference image with shoes is available for processing.\n<br> Have effect when `garment_category` is `full_body` or `lower_body`\n"
},
"ref_file_url": {
"type": "string",
"examples": [
"https://example.com/reference.jpg"
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
},
"garment_category": {
"enum": [
"full_body",
"lower_body",
"upper_body",
"shoes",
"auto",
"outer"
],
"type": "string",
"description": "The category of garment of reference image. It's required if reference image provided. Utilize the \"auto\" parameter to allow the AI engine to automatically identify and classify garment categories."
},
"filter_multi_person": {
"anyOf": [
{
"enum": [
"off",
"normal",
"strict"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "off",
"description": "Filter out multi-person cases in the source image and the human reference image.\n<br> `off` - No filtering. The engine uses the largest person in the image.\n<br> `normal` - Reject when another person is comparable in size to the main subject, or is clearly visible on the same plane, such as standing nearby with a sharp, recognizable face. Typical group or two-person photos. Distant or blurry background people are ignored.\n<br> `strict` - Reject when any additional person is visible, including small, distant, background, or blurry / out-of-focus people.\n"
}
}
},
{
"type": "object",
"required": [
"src_file_url",
"ref_file_id",
"garment_category"
],
"properties": {
"ref_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the reference file to run task. File ID from upload file API."
},
"change_shoes": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"description": "Control whether shoes should be swapped when a full body reference image with shoes is available for processing.\n<br> Have effect when `garment_category` is `full_body` or `lower_body`\n"
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
},
"garment_category": {
"enum": [
"full_body",
"lower_body",
"upper_body",
"shoes",
"auto",
"outer"
],
"type": "string",
"description": "The category of garment of reference image. It's required if reference image provided. Utilize the \"auto\" parameter to allow the AI engine to automatically identify and classify garment categories."
},
"filter_multi_person": {
"anyOf": [
{
"enum": [
"off",
"normal",
"strict"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "off",
"description": "Filter out multi-person cases in the source image and the human reference image.\n<br> `off` - No filtering. The engine uses the largest person in the image.\n<br> `normal` - Reject when another person is comparable in size to the main subject, or is clearly visible on the same plane, such as standing nearby with a sharp, recognizable face. Typical group or two-person photos. Distant or blurry background people are ignored.\n<br> `strict` - Reject when any additional person is visible, including small, distant, background, or blurry / out-of-focus people.\n"
}
}
},
{
"type": "object",
"required": [
"src_file_id",
"ref_file_url",
"garment_category"
],
"properties": {
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
},
"change_shoes": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"description": "Control whether shoes should be swapped when a full body reference image with shoes is available for processing.\n<br> Have effect when `garment_category` is `full_body` or `lower_body`\n"
},
"ref_file_url": {
"type": "string",
"examples": [
"https://example.com/reference.jpg"
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
},
"garment_category": {
"enum": [
"full_body",
"lower_body",
"upper_body",
"shoes",
"auto",
"outer"
],
"type": "string",
"description": "The category of garment of reference image. It's required if reference image provided. Utilize the \"auto\" parameter to allow the AI engine to automatically identify and classify garment categories."
},
"filter_multi_person": {
"anyOf": [
{
"enum": [
"off",
"normal",
"strict"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "off",
"description": "Filter out multi-person cases in the source image and the human reference image.\n<br> `off` - No filtering. The engine uses the largest person in the image.\n<br> `normal` - Reject when another person is comparable in size to the main subject, or is clearly visible on the same plane, such as standing nearby with a sharp, recognizable face. Typical group or two-person photos. Distant or blurry background people are ignored.\n<br> `strict` - Reject when any additional person is visible, including small, distant, background, or blurry / out-of-focus people.\n"
}
}
},
{
"type": "object",
"required": [
"src_file_id",
"ref_file_id",
"garment_category"
],
"properties": {
"ref_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the reference file to run task. File ID from upload file API."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
},
"change_shoes": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"description": "Control whether shoes should be swapped when a full body reference image with shoes is available for processing.\n<br> Have effect when `garment_category` is `full_body` or `lower_body`\n"
},
"garment_category": {
"enum": [
"full_body",
"lower_body",
"upper_body",
"shoes",
"auto",
"outer"
],
"type": "string",
"description": "The category of garment of reference image. It's required if reference image provided. Utilize the \"auto\" parameter to allow the AI engine to automatically identify and classify garment categories."
},
"filter_multi_person": {
"anyOf": [
{
"enum": [
"off",
"normal",
"strict"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "off",
"description": "Filter out multi-person cases in the source image and the human reference image.\n<br> `off` - No filtering. The engine uses the largest person in the image.\n<br> `normal` - Reject when another person is comparable in size to the main subject, or is clearly visible on the same plane, such as standing nearby with a sharp, recognizable face. Typical group or two-person photos. Distant or blurry background people are ignored.\n<br> `strict` - Reject when any additional person is visible, including small, distant, background, or blurry / out-of-focus people.\n"
}
}
}
]
}
},
"additionalProperties": false
}The Ultimate AI Earring Virtual Try-On Top AI ear piercing simulator for virtual earring try-on and virtual piercing try-on Create realistic and dynamic earrings virtual try-on from a 2D image, no expensive 3D modelling required. Our advanced algorithms create lifelike virtual try-on earring SKUs with sophisticated lighting effects and physically accurate motions.
| Argument | Type | Description |
|---|---|---|
| polling | boolean | If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish. |
| request* | any |
{
"type": "object",
"required": [
"request"
],
"properties": {
"polling": {
"type": "boolean",
"default": true,
"description": "If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish."
},
"request": {
"anyOf": [
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_url",
"ref_file_urls"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/vto_sku_mask.jpg"
],
"description": "The reference mask url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"earring_scale": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Controls the earring’s size in centimeters. <br>Default: null (use engine default)"
},
"earring_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The anchor point of the earring image, used for alignment. <br>Type: list of 2 integers <br>Range: [x, y] (pixel coordinates) <br>Default: null (use engine default)"
},
"earring_is_right_ear": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the earring is worn in right ear, defaultly is worn in right ear."
},
"earring_occluded_type": {
"anyOf": [
{
"enum": [
0,
1,
2
],
"type": "number"
},
{
"type": "null"
}
],
"default": 0,
"examples": [
0
],
"description": "Which occluded type the earring is. 0 means auto-detect, 1 means occluded type, 2 means no."
},
"earring_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.5,
"examples": [
0.5
],
"description": "Shadow intensity applied to the earring (higher = darker shadow)."
},
"earring_wearing_location": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The target location of photo where the earring should be placed. <br>Type: list of 2 integers <br>Range: [x, y] (pixel coordinates) <br>Default: null (use engine default)"
},
"earring_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the earring image needs background removal."
},
"earring_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.5,
"examples": [
0.5
],
"description": "Ambient light adjustment intensity for the earring."
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
},
"ref_file_urls": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"https://example.com/vto_sku.jpg"
]
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
},
"srcmsk_file_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "Url of the source mask file to run task. The url should be publicly accessible."
},
"refmsk_file_urls": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"examples": [
[
"https://example.com/vto_sku_mask.jpg"
]
],
"description": "Url of the reference mask file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_url",
"ref_file_ids"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/vto_sku_mask.jpg"
],
"description": "The reference mask url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"earring_scale": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Controls the earring’s size in centimeters. <br>Default: null (use engine default)"
},
"earring_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The anchor point of the earring image, used for alignment. <br>Type: list of 2 integers <br>Range: [x, y] (pixel coordinates) <br>Default: null (use engine default)"
},
"earring_is_right_ear": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the earring is worn in right ear, defaultly is worn in right ear."
},
"earring_occluded_type": {
"anyOf": [
{
"enum": [
0,
1,
2
],
"type": "number"
},
{
"type": "null"
}
],
"default": 0,
"examples": [
0
],
"description": "Which occluded type the earring is. 0 means auto-detect, 1 means occluded type, 2 means no."
},
"earring_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.5,
"examples": [
0.5
],
"description": "Shadow intensity applied to the earring (higher = darker shadow)."
},
"earring_wearing_location": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The target location of photo where the earring should be placed. <br>Type: list of 2 integers <br>Range: [x, y] (pixel coordinates) <br>Default: null (use engine default)"
},
"earring_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the earring image needs background removal."
},
"earring_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.5,
"examples": [
0.5
],
"description": "Ambient light adjustment intensity for the earring."
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"ref_file_ids": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference file file to run task. File ID from upload file API."
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
},
"refmsk_file_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference mask file file to run task. File ID from upload file API."
},
"srcmsk_file_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "Url of the source mask file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_id",
"ref_file_urls"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/vto_sku_mask.jpg"
],
"description": "The reference mask url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"earring_scale": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Controls the earring’s size in centimeters. <br>Default: null (use engine default)"
},
"earring_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The anchor point of the earring image, used for alignment. <br>Type: list of 2 integers <br>Range: [x, y] (pixel coordinates) <br>Default: null (use engine default)"
},
"earring_is_right_ear": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the earring is worn in right ear, defaultly is worn in right ear."
},
"earring_occluded_type": {
"anyOf": [
{
"enum": [
0,
1,
2
],
"type": "number"
},
{
"type": "null"
}
],
"default": 0,
"examples": [
0
],
"description": "Which occluded type the earring is. 0 means auto-detect, 1 means occluded type, 2 means no."
},
"earring_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.5,
"examples": [
0.5
],
"description": "Shadow intensity applied to the earring (higher = darker shadow)."
},
"earring_wearing_location": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The target location of photo where the earring should be placed. <br>Type: list of 2 integers <br>Range: [x, y] (pixel coordinates) <br>Default: null (use engine default)"
},
"earring_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the earring image needs background removal."
},
"earring_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.5,
"examples": [
0.5
],
"description": "Ambient light adjustment intensity for the earring."
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"ref_file_urls": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"https://example.com/vto_sku.jpg"
]
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
},
"srcmsk_file_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the source mask file to run task. File ID from upload file API."
},
"refmsk_file_urls": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"examples": [
[
"https://example.com/vto_sku_mask.jpg"
]
],
"description": "Url of the reference mask file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_id",
"ref_file_ids"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/vto_sku_mask.jpg"
],
"description": "The reference mask url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"earring_scale": {
"anyOf": [
{
"type": "number",
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Controls the earring’s size in centimeters. <br>Default: null (use engine default)"
},
"earring_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The anchor point of the earring image, used for alignment. <br>Type: list of 2 integers <br>Range: [x, y] (pixel coordinates) <br>Default: null (use engine default)"
},
"earring_is_right_ear": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the earring is worn in right ear, defaultly is worn in right ear."
},
"earring_occluded_type": {
"anyOf": [
{
"enum": [
0,
1,
2
],
"type": "number"
},
{
"type": "null"
}
],
"default": 0,
"examples": [
0
],
"description": "Which occluded type the earring is. 0 means auto-detect, 1 means occluded type, 2 means no."
},
"earring_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.5,
"examples": [
0.5
],
"description": "Shadow intensity applied to the earring (higher = darker shadow)."
},
"earring_wearing_location": {
"anyOf": [
{
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The target location of photo where the earring should be placed. <br>Type: list of 2 integers <br>Range: [x, y] (pixel coordinates) <br>Default: null (use engine default)"
},
"earring_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the earring image needs background removal."
},
"earring_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.5,
"examples": [
0.5
],
"description": "Ambient light adjustment intensity for the earring."
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"ref_file_ids": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference file file to run task. File ID from upload file API."
},
"srcmsk_file_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the source mask file to run task. File ID from upload file API."
},
"refmsk_file_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference mask file file to run task. File ID from upload file API."
}
}
}
]
}
},
"additionalProperties": false
}Transform your look with stunning realism! Explore unique fabric styles with photo mode — whether it's the elegance of silky textures or the vibrance of bold prints, the AI Fabric API brings materials to life! Developers can craft immersive experiences that let users see and feel fabrics like never before. Plus, fresh fabric updates are always on the way!
| Argument | Type | Description |
|---|---|---|
| polling | boolean | If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish. |
| request* | any |
{
"type": "object",
"required": [
"request"
],
"properties": {
"polling": {
"type": "boolean",
"default": true,
"description": "If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish."
},
"request": {
"anyOf": [
{
"type": "object",
"required": [
"template_id",
"src_file_url"
],
"properties": {
"template_id": {
"type": "string",
"examples": [
"good_template_001"
],
"description": "ID of the template. List predefined templates first, and use the id of a template."
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"template_id",
"src_file_id"
],
"properties": {
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
},
"template_id": {
"type": "string",
"examples": [
"good_template_001"
],
"description": "ID of the template. List predefined templates first, and use the id of a template."
}
}
}
]
}
},
"additionalProperties": false
}List predefined templates.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Step into the future of fashion with our Hyper-Realistic AR Try-On for Headwear, powered by cutting-edge AI technology. This innovative solution transforms online shopping into an immersive experience, allowing customers to virtually try on headwear with unmatched precision and realism. From instant style discovery to true-to-life visualization, our AR technology ensures every hat and headband looks and feels authentic. Helping shoppers find their perfect fit and style before they buy. Elevate engagement, boost confidence, and redefine the way customers interact with your products.gender must be explicitly provided by the user. If missing, ask the user for clarification and set the parameter once received.
| Argument | Type | Description |
|---|---|---|
| polling | boolean | If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish. |
| request* | any |
{
"type": "object",
"required": [
"request"
],
"properties": {
"polling": {
"type": "boolean",
"default": true,
"description": "If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish."
},
"request": {
"anyOf": [
{
"type": "object",
"required": [
"gender",
"src_file_url",
"ref_file_url"
],
"properties": {
"style": {
"anyOf": [
{
"enum": [
"random",
"style_sporty_casual",
"style_urban_fashion",
"style_vacation_casual",
"style_warm_cozy",
"style_bohemian"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "random",
"examples": [
"random"
],
"description": "To control outfit and background style."
},
"gender": {
"enum": [
"female",
"male"
],
"type": "string",
"examples": [
"female"
],
"description": "Gender of the person in the image."
},
"ref_file_url": {
"type": "string",
"examples": [
"https://example.com/reference.jpg"
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"gender",
"src_file_url",
"ref_file_id"
],
"properties": {
"style": {
"anyOf": [
{
"enum": [
"random",
"style_sporty_casual",
"style_urban_fashion",
"style_vacation_casual",
"style_warm_cozy",
"style_bohemian"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "random",
"examples": [
"random"
],
"description": "To control outfit and background style."
},
"gender": {
"enum": [
"female",
"male"
],
"type": "string",
"examples": [
"female"
],
"description": "Gender of the person in the image."
},
"ref_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the reference file to run task. File ID from upload file API."
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"gender",
"src_file_id",
"ref_file_url"
],
"properties": {
"style": {
"anyOf": [
{
"enum": [
"random",
"style_sporty_casual",
"style_urban_fashion",
"style_vacation_casual",
"style_warm_cozy",
"style_bohemian"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "random",
"examples": [
"random"
],
"description": "To control outfit and background style."
},
"gender": {
"enum": [
"female",
"male"
],
"type": "string",
"examples": [
"female"
],
"description": "Gender of the person in the image."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
},
"ref_file_url": {
"type": "string",
"examples": [
"https://example.com/reference.jpg"
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"gender",
"src_file_id",
"ref_file_id"
],
"properties": {
"style": {
"anyOf": [
{
"enum": [
"random",
"style_sporty_casual",
"style_urban_fashion",
"style_vacation_casual",
"style_warm_cozy",
"style_bohemian"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "random",
"examples": [
"random"
],
"description": "To control outfit and background style."
},
"gender": {
"enum": [
"female",
"male"
],
"type": "string",
"examples": [
"female"
],
"description": "Gender of the person in the image."
},
"ref_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the reference file to run task. File ID from upload file API."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
}
}
}
]
}
},
"additionalProperties": false
}Luxurious Look and Feel with State-of-the-Art Virtual Try-On for Necklace Precise AI neck and clavicle tracking gives users an ultra-realistic AR try-on experience, recreating the luxurious look and feel of physical necklace sampling. Create realistic and dynamic necklace vitual try-on from a 2D image, no expensive 3D modelling required. Our advanced algorithms create lifelike virtual try-on necklace SKUs with sophisticated lighting effects and physically accurate motions.
| Argument | Type | Description |
|---|---|---|
| polling | boolean | If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish. |
| request* | any |
{
"type": "object",
"required": [
"request"
],
"properties": {
"polling": {
"type": "boolean",
"default": true,
"description": "If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish."
},
"request": {
"anyOf": [
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_url",
"ref_file_urls"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"necklace_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The anchor points of the necklace image, used for alignment. <br>Type: 2x2 list of integers <br>Range: [[x, y], [x, y]] (pixel coordinates) <br>Default: null (use engine default)"
},
"necklace_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.5,
"examples": [
0.5
],
"description": "Shadow intensity applied to the necklace (higher = darker shadow)."
},
"necklace_wearing_location": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The target locations of photo where the necklace should be placed. <br>Type: 2x2 list of integers <br>Range: [[x, y], [x, y]] (pixel coordinates) <br>Default: null (use engine default)"
},
"necklace_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the necklace image needs background removal."
},
"necklace_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.5,
"examples": [
0.5
],
"description": "Ambient light adjustment intensity for the necklace."
}
}
},
{
"type": "null"
}
],
"default": null,
"description": "Contain several object informations in this list."
}
}
}
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
},
"ref_file_urls": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"https://example.com/vto_sku.jpg"
]
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
},
"srcmsk_file_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "Url of the source mask file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_url",
"ref_file_ids"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"necklace_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The anchor points of the necklace image, used for alignment. <br>Type: 2x2 list of integers <br>Range: [[x, y], [x, y]] (pixel coordinates) <br>Default: null (use engine default)"
},
"necklace_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.5,
"examples": [
0.5
],
"description": "Shadow intensity applied to the necklace (higher = darker shadow)."
},
"necklace_wearing_location": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The target locations of photo where the necklace should be placed. <br>Type: 2x2 list of integers <br>Range: [[x, y], [x, y]] (pixel coordinates) <br>Default: null (use engine default)"
},
"necklace_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the necklace image needs background removal."
},
"necklace_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.5,
"examples": [
0.5
],
"description": "Ambient light adjustment intensity for the necklace."
}
}
},
{
"type": "null"
}
],
"default": null,
"description": "Contain several object informations in this list."
}
}
}
},
"ref_file_ids": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference file file to run task. File ID from upload file API."
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
},
"srcmsk_file_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "Url of the source mask file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_id",
"ref_file_urls"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"necklace_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The anchor points of the necklace image, used for alignment. <br>Type: 2x2 list of integers <br>Range: [[x, y], [x, y]] (pixel coordinates) <br>Default: null (use engine default)"
},
"necklace_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.5,
"examples": [
0.5
],
"description": "Shadow intensity applied to the necklace (higher = darker shadow)."
},
"necklace_wearing_location": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The target locations of photo where the necklace should be placed. <br>Type: 2x2 list of integers <br>Range: [[x, y], [x, y]] (pixel coordinates) <br>Default: null (use engine default)"
},
"necklace_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the necklace image needs background removal."
},
"necklace_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.5,
"examples": [
0.5
],
"description": "Ambient light adjustment intensity for the necklace."
}
}
},
{
"type": "null"
}
],
"default": null,
"description": "Contain several object informations in this list."
}
}
}
},
"ref_file_urls": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"https://example.com/vto_sku.jpg"
]
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
},
"srcmsk_file_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the source mask file to run task. File ID from upload file API."
}
}
},
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_id",
"ref_file_ids"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"necklace_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The anchor points of the necklace image, used for alignment. <br>Type: 2x2 list of integers <br>Range: [[x, y], [x, y]] (pixel coordinates) <br>Default: null (use engine default)"
},
"necklace_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.5,
"examples": [
0.5
],
"description": "Shadow intensity applied to the necklace (higher = darker shadow)."
},
"necklace_wearing_location": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The target locations of photo where the necklace should be placed. <br>Type: 2x2 list of integers <br>Range: [[x, y], [x, y]] (pixel coordinates) <br>Default: null (use engine default)"
},
"necklace_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the necklace image needs background removal."
},
"necklace_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.5,
"examples": [
0.5
],
"description": "Ambient light adjustment intensity for the necklace."
}
}
},
{
"type": "null"
}
],
"default": null,
"description": "Contain several object informations in this list."
}
}
}
},
"ref_file_ids": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference file file to run task. File ID from upload file API."
},
"srcmsk_file_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the source mask file to run task. File ID from upload file API."
}
}
}
]
}
},
"additionalProperties": false
}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.
| Argument | Type | Description |
|---|---|---|
| polling | boolean | If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish. |
| request* | any |
{
"type": "object",
"required": [
"request"
],
"properties": {
"polling": {
"type": "boolean",
"default": true,
"description": "If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish."
},
"request": {
"anyOf": [
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_url",
"ref_file_urls"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/vto_sku_mask.jpg"
],
"description": "The reference mask url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"ring_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The anchor point of the ring image, marking the 2 farthest points along the inner edge of the ring <br>Type: 2x2 list of integers <br>Range: 2 (x, y) pixel coordinates <br>Default: null (use engine default)"
},
"ring_wearing_finger": {
"anyOf": [
{
"enum": [
0,
1,
2,
3,
4
],
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Defines on which finger the ring is worn. <br>Default: null (use engine default) <br>Range: 0 ~ 4 [thumb to pinky]"
},
"ring_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.15,
"examples": [
0.15
],
"description": "Shadow intensity applied to the ring (higher = darker shadow)."
},
"ring_wearing_location": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Defines the placement of the ring on the selected finger in the user photo. <br>Range: 0.0 ~ 1.0(0 = base of the finger, 1 = first knuckle)"
},
"ring_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the ring image needs background removal."
},
"ring_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 1,
"examples": [
1
],
"description": "Ambient light adjustment intensity for the ring."
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
},
"ref_file_urls": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"https://example.com/vto_sku.jpg"
]
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
},
"srcmsk_file_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "Url of the source mask file to run task. The url should be publicly accessible."
},
"refmsk_file_urls": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"examples": [
[
"https://example.com/vto_sku_mask.jpg"
]
],
"description": "Url of the reference mask file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_url",
"ref_file_ids"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/vto_sku_mask.jpg"
],
"description": "The reference mask url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"ring_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The anchor point of the ring image, marking the 2 farthest points along the inner edge of the ring <br>Type: 2x2 list of integers <br>Range: 2 (x, y) pixel coordinates <br>Default: null (use engine default)"
},
"ring_wearing_finger": {
"anyOf": [
{
"enum": [
0,
1,
2,
3,
4
],
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Defines on which finger the ring is worn. <br>Default: null (use engine default) <br>Range: 0 ~ 4 [thumb to pinky]"
},
"ring_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.15,
"examples": [
0.15
],
"description": "Shadow intensity applied to the ring (higher = darker shadow)."
},
"ring_wearing_location": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Defines the placement of the ring on the selected finger in the user photo. <br>Range: 0.0 ~ 1.0(0 = base of the finger, 1 = first knuckle)"
},
"ring_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the ring image needs background removal."
},
"ring_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 1,
"examples": [
1
],
"description": "Ambient light adjustment intensity for the ring."
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"ref_file_ids": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference file file to run task. File ID from upload file API."
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
},
"refmsk_file_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference mask file file to run task. File ID from upload file API."
},
"srcmsk_file_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "Url of the source mask file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_id",
"ref_file_urls"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/vto_sku_mask.jpg"
],
"description": "The reference mask url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"ring_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The anchor point of the ring image, marking the 2 farthest points along the inner edge of the ring <br>Type: 2x2 list of integers <br>Range: 2 (x, y) pixel coordinates <br>Default: null (use engine default)"
},
"ring_wearing_finger": {
"anyOf": [
{
"enum": [
0,
1,
2,
3,
4
],
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Defines on which finger the ring is worn. <br>Default: null (use engine default) <br>Range: 0 ~ 4 [thumb to pinky]"
},
"ring_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.15,
"examples": [
0.15
],
"description": "Shadow intensity applied to the ring (higher = darker shadow)."
},
"ring_wearing_location": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Defines the placement of the ring on the selected finger in the user photo. <br>Range: 0.0 ~ 1.0(0 = base of the finger, 1 = first knuckle)"
},
"ring_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the ring image needs background removal."
},
"ring_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 1,
"examples": [
1
],
"description": "Ambient light adjustment intensity for the ring."
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"ref_file_urls": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"https://example.com/vto_sku.jpg"
]
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
},
"srcmsk_file_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the source mask file to run task. File ID from upload file API."
},
"refmsk_file_urls": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"examples": [
[
"https://example.com/vto_sku_mask.jpg"
]
],
"description": "Url of the reference mask file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_id",
"ref_file_ids"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/vto_sku_mask.jpg"
],
"description": "The reference mask url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"ring_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 2,
"minItems": 2
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "The anchor point of the ring image, marking the 2 farthest points along the inner edge of the ring <br>Type: 2x2 list of integers <br>Range: 2 (x, y) pixel coordinates <br>Default: null (use engine default)"
},
"ring_wearing_finger": {
"anyOf": [
{
"enum": [
0,
1,
2,
3,
4
],
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Defines on which finger the ring is worn. <br>Default: null (use engine default) <br>Range: 0 ~ 4 [thumb to pinky]"
},
"ring_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.15,
"examples": [
0.15
],
"description": "Shadow intensity applied to the ring (higher = darker shadow)."
},
"ring_wearing_location": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Defines the placement of the ring on the selected finger in the user photo. <br>Range: 0.0 ~ 1.0(0 = base of the finger, 1 = first knuckle)"
},
"ring_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the ring image needs background removal."
},
"ring_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 1,
"examples": [
1
],
"description": "Ambient light adjustment intensity for the ring."
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"ref_file_ids": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference file file to run task. File ID from upload file API."
},
"srcmsk_file_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the source mask file to run task. File ID from upload file API."
},
"refmsk_file_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference mask file file to run task. File ID from upload file API."
}
}
}
]
}
},
"additionalProperties": false
}Enhance your fashion experience with the online AR Scarf Virtual Try-On. Shoppers can instantly drape scarves over their outfits and see how patterns flow in real life. This interactive virtual scarf feature allows customers to explore different styles and colors online, replicating the in-store experience. Powered by high-fidelity AR simulation, users can enjoy detailed scarf visualisation anytime, anywhere.gender must be explicitly provided by the user. If missing, ask the user for clarification and set the parameter once received.
| Argument | Type | Description |
|---|---|---|
| polling | boolean | If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish. |
| request* | any |
{
"type": "object",
"required": [
"request"
],
"properties": {
"polling": {
"type": "boolean",
"default": true,
"description": "If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish."
},
"request": {
"anyOf": [
{
"type": "object",
"required": [
"gender",
"src_file_url",
"ref_file_url"
],
"properties": {
"style": {
"anyOf": [
{
"enum": [
"random",
"style_french_elegance",
"style_light_luxury",
"style_cottagecore",
"style_modern_chic",
"style_bohemian"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "random",
"examples": [
"random"
],
"description": "To control outfit and background style."
},
"gender": {
"enum": [
"female",
"male"
],
"type": "string",
"examples": [
"female"
],
"description": "Gender of the person in the image."
},
"ref_file_url": {
"type": "string",
"examples": [
"https://example.com/reference.jpg"
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"gender",
"src_file_url",
"ref_file_id"
],
"properties": {
"style": {
"anyOf": [
{
"enum": [
"random",
"style_french_elegance",
"style_light_luxury",
"style_cottagecore",
"style_modern_chic",
"style_bohemian"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "random",
"examples": [
"random"
],
"description": "To control outfit and background style."
},
"gender": {
"enum": [
"female",
"male"
],
"type": "string",
"examples": [
"female"
],
"description": "Gender of the person in the image."
},
"ref_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the reference file to run task. File ID from upload file API."
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"gender",
"src_file_id",
"ref_file_url"
],
"properties": {
"style": {
"anyOf": [
{
"enum": [
"random",
"style_french_elegance",
"style_light_luxury",
"style_cottagecore",
"style_modern_chic",
"style_bohemian"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "random",
"examples": [
"random"
],
"description": "To control outfit and background style."
},
"gender": {
"enum": [
"female",
"male"
],
"type": "string",
"examples": [
"female"
],
"description": "Gender of the person in the image."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
},
"ref_file_url": {
"type": "string",
"examples": [
"https://example.com/reference.jpg"
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"gender",
"src_file_id",
"ref_file_id"
],
"properties": {
"style": {
"anyOf": [
{
"enum": [
"random",
"style_french_elegance",
"style_light_luxury",
"style_cottagecore",
"style_modern_chic",
"style_bohemian"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "random",
"examples": [
"random"
],
"description": "To control outfit and background style."
},
"gender": {
"enum": [
"female",
"male"
],
"type": "string",
"examples": [
"female"
],
"description": "Gender of the person in the image."
},
"ref_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the reference file to run task. File ID from upload file API."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
}
}
}
]
}
},
"additionalProperties": false
}Step into the future of shopping with our AR Shoes Virtual Try-On. Instantly see how your favourite styles look and fit right from your screen. Powered by cutting-edge AI technology, this experience delivers a perfect visual fit, helping you shop with confidence and reduce returns. Explore endless styles and colours from the comfort of home. Our high-fidelity AR simulation brings every detail to life so you can enjoy the thrill of an in-store experience anytime, anywhere. Try it today and find the perfect pair that matches your style.gender must be explicitly provided by the user. If missing, ask the user for clarification and set the parameter once received.
| Argument | Type | Description |
|---|---|---|
| polling | boolean | If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish. |
| request* | any |
{
"type": "object",
"required": [
"request"
],
"properties": {
"polling": {
"type": "boolean",
"default": true,
"description": "If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish."
},
"request": {
"anyOf": [
{
"type": "object",
"required": [
"src_file_url",
"ref_file_url"
],
"properties": {
"ref_file_url": {
"type": "string",
"examples": [
"https://example.com/reference.jpg"
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"src_file_url",
"ref_file_id"
],
"properties": {
"ref_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the reference file to run task. File ID from upload file API."
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"src_file_id",
"ref_file_url"
],
"properties": {
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
},
"ref_file_url": {
"type": "string",
"examples": [
"https://example.com/reference.jpg"
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"src_file_id",
"ref_file_id"
],
"properties": {
"ref_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the reference file to run task. File ID from upload file API."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
}
}
}
]
}
},
"additionalProperties": false
}Virtually Try-On AR Watches with Ease! Only One 2D Image Needed. With just a single 2D image upload, users can instantly try on top-notch watches virtually using our innovative AR-Watches App. This unique feature sets us apart in the world of e-commerce, making it easier than ever for customers to experience your products.
| Argument | Type | Description |
|---|---|---|
| polling | boolean | If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish. |
| request* | any |
{
"type": "object",
"required": [
"request"
],
"properties": {
"polling": {
"type": "boolean",
"default": true,
"description": "If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish."
},
"request": {
"anyOf": [
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_url",
"ref_file_urls"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/vto_sku_mask.jpg"
],
"description": "The reference mask url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"watch_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 4,
"minItems": 4
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "First 2 points mark the strap end when worn. Remaining 2 points mark the upper & lower edges of watch case. <br>Type: 4x2 list of integers <br>Range: 4 (x, y) pixel coordinates <br>Default: null (use engine default)"
},
"watch_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.3,
"examples": [
0.3
],
"description": "Shadow intensity applied to the watch (higher = darker shadow)."
},
"watch_wearing_location": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": -0.3
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Defines the placement of the watch on the wrist in the user photo. <br>Range: -0.3 ~ 1.0 (0 = closest to the wrist joint) <br> (smaller number = placed close to the palm <br> larger number = placed further away from the wrist) <br>Default: null (use engine default)"
},
"watch_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the watch image needs background removal."
},
"watch_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 1,
"examples": [
1
],
"description": "Ambient light adjustment intensity for the watch."
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
},
"ref_file_urls": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"https://example.com/vto_sku.jpg"
]
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
},
"srcmsk_file_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "Url of the source mask file to run task. The url should be publicly accessible."
},
"refmsk_file_urls": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"examples": [
[
"https://example.com/vto_sku_mask.jpg"
]
],
"description": "Url of the reference mask file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_url",
"ref_file_ids"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/vto_sku_mask.jpg"
],
"description": "The reference mask url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"watch_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 4,
"minItems": 4
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "First 2 points mark the strap end when worn. Remaining 2 points mark the upper & lower edges of watch case. <br>Type: 4x2 list of integers <br>Range: 4 (x, y) pixel coordinates <br>Default: null (use engine default)"
},
"watch_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.3,
"examples": [
0.3
],
"description": "Shadow intensity applied to the watch (higher = darker shadow)."
},
"watch_wearing_location": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": -0.3
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Defines the placement of the watch on the wrist in the user photo. <br>Range: -0.3 ~ 1.0 (0 = closest to the wrist joint) <br> (smaller number = placed close to the palm <br> larger number = placed further away from the wrist) <br>Default: null (use engine default)"
},
"watch_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the watch image needs background removal."
},
"watch_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 1,
"examples": [
1
],
"description": "Ambient light adjustment intensity for the watch."
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"ref_file_ids": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference file file to run task. File ID from upload file API."
},
"src_file_url": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "Url of the file to run task. The url should be publicly accessible."
},
"refmsk_file_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference mask file file to run task. File ID from upload file API."
},
"srcmsk_file_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "Url of the source mask file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_id",
"ref_file_urls"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/vto_sku_mask.jpg"
],
"description": "The reference mask url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"watch_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 4,
"minItems": 4
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "First 2 points mark the strap end when worn. Remaining 2 points mark the upper & lower edges of watch case. <br>Type: 4x2 list of integers <br>Range: 4 (x, y) pixel coordinates <br>Default: null (use engine default)"
},
"watch_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.3,
"examples": [
0.3
],
"description": "Shadow intensity applied to the watch (higher = darker shadow)."
},
"watch_wearing_location": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": -0.3
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Defines the placement of the watch on the wrist in the user photo. <br>Range: -0.3 ~ 1.0 (0 = closest to the wrist joint) <br> (smaller number = placed close to the palm <br> larger number = placed further away from the wrist) <br>Default: null (use engine default)"
},
"watch_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the watch image needs background removal."
},
"watch_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 1,
"examples": [
1
],
"description": "Ambient light adjustment intensity for the watch."
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"ref_file_urls": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"https://example.com/vto_sku.jpg"
]
],
"description": "Url of the reference file to run task. The url should be publicly accessible."
},
"srcmsk_file_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the source mask file to run task. File ID from upload file API."
},
"refmsk_file_urls": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"examples": [
[
"https://example.com/vto_sku_mask.jpg"
]
],
"description": "Url of the reference mask file to run task. The url should be publicly accessible."
}
}
},
{
"type": "object",
"required": [
"source_info",
"object_infos",
"src_file_id",
"ref_file_ids"
],
"properties": {
"source_info": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/selfie.jpg"
],
"description": "The source url or File ID."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/src_mask.jpg"
],
"description": "The source mask url or File ID."
}
},
"description": "Contain source photo informations."
},
"src_file_id": {
"type": "string",
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of file to run task. File ID from upload file API."
},
"object_infos": {
"type": "array",
"items": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"examples": [
"https://example.com/vto_sku.jpg"
],
"description": "The reference url or File ID. Indicate which reference product image should be matched."
},
"mask_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"https://example.com/vto_sku_mask.jpg"
],
"description": "The reference mask url or File ID. Indicate which reference product image should be matched."
},
"parameter": {
"anyOf": [
{
"type": "object",
"properties": {
"watch_anchor_point": {
"anyOf": [
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 2,
"minItems": 2
},
"maxItems": 4,
"minItems": 4
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "First 2 points mark the strap end when worn. Remaining 2 points mark the upper & lower edges of watch case. <br>Type: 4x2 list of integers <br>Range: 4 (x, y) pixel coordinates <br>Default: null (use engine default)"
},
"watch_shadow_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 0.3,
"examples": [
0.3
],
"description": "Shadow intensity applied to the watch (higher = darker shadow)."
},
"watch_wearing_location": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": -0.3
},
{
"type": "null"
}
],
"default": null,
"examples": [
null
],
"description": "Defines the placement of the watch on the wrist in the user photo. <br>Range: -0.3 ~ 1.0 (0 = closest to the wrist joint) <br> (smaller number = placed close to the palm <br> larger number = placed further away from the wrist) <br>Default: null (use engine default)"
},
"watch_need_remove_background": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": true,
"examples": [
true
],
"description": "Whether the watch image needs background removal."
},
"watch_ambient_light_intensity": {
"anyOf": [
{
"type": "number",
"maximum": 1,
"minimum": 0
},
{
"type": "null"
}
],
"default": 1,
"examples": [
1
],
"description": "Ambient light adjustment intensity for the watch."
}
}
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"ref_file_ids": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference file file to run task. File ID from upload file API."
},
"srcmsk_file_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
],
"description": "ID of the source mask file to run task. File ID from upload file API."
},
"refmsk_file_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"examples": [
[
"pfNK5PuRe0MrwLHcGA3DOmB1ahwfXTbYHjv+KoBIxbE="
]
],
"description": "ID of the reference mask file file to run task. File ID from upload file API."
}
}
}
]
}
},
"additionalProperties": false
}Interactive drag-and-drop widget for uploading images (JPEG, PNG) or videos (MP4). Returns file IDs for YouCam AI tools (AI-Fabric, AI-Cloth, AI-Makeup-Vto, AI-Hairstyle-Generator, AI-Skin-Analysis, etc.). /n Use when the user wants to upload or select an image/video (e.g. upload, drag & drop, choose file, pick image/video), or before any AI-* tool requiring src_file_id or ref_file_id when no file ID or URL is available. /n Also use as the mandatory fallback whenever Get-Upload-API-Info cannot complete the upload for any reason (including network restrictions, host_not_allowed, or other failures). Uploads directly from the browser, bypassing sandbox egress restrictions.
| Argument | Type | Description |
|---|---|---|
| task_type | any | Pre-select a task type. If omitted, the user picks one from the dropdown. |
{
"type": "object",
"properties": {
"task_type": {
"anyOf": [
{
"enum": [
"AI-Bracelet-Virtual-Try-On",
"AI-Earrings-Virtual-Try-On",
"AI-Necklace-Virtual-Try-On",
"AI-Ring-Virtual-Try-On",
"AI-Watch-Virtual-Try-On",
"AI-Abs-Filter",
"AI-Aging-Simulation",
"AI-Avatar-Generator",
"AI-Nail-Transfer",
"AI-Smile",
"AI-Studio-Generator",
"AI-Bag-Virtual-Try-On",
"AI-Beard-Style-Generator",
"AI-Photo-Background-Blur",
"AI-Photo-Background-Change",
"AI-Video-Background-Replace",
"AI-Body-Reshape",
"AI-Breast-Augmentation-Simulator",
"AI-Clothes-Virtual-Try-On",
"AI-Photo-Colorize",
"AI-Color-Correction",
"AI-Photo-Enhance",
"AI-Eye-Color-Lens-Virtual-Try-On",
"AI-Fabric-Virtual-Try-On",
"AI-Face-Attributes-and-Ratio-Analyzer",
"AI-Face-Lift",
"AI-Face-Reshape",
"AI-Face-Swap",
"AI-Video-Face-Swap",
"AI-Fitzpatrick-Skin-Type-Analysis",
"AI-Object-Removal-Pro",
"AI-Bangs-Filter-Virtual-Try-On",
"AI-Hair-Color-Virtual-Try-On",
"AI-Wavy-Hair-Virtual-Try-On",
"AI-Hair-Density-Detection",
"AI-Hair-Extension-Virtual-Try-On",
"AI-Hair-Frizziness-Detection",
"AI-Hair-Length-Detection",
"AI-Hair-Style-Virtual-Try-On",
"AI-Hair-Type-Detection",
"AI-Hair-Volume-Virtual-Try-On",
"AI-Hat-Virtual-Try-On",
"AI-Headshot-Generator",
"AI-Image-Generator-Image-to-Image",
"AI-Video-Generator-Image-to-Video",
"AI-Photo-Lighting",
"AI-Look-Virtual-Try-On",
"AI-Makeup-Virtual-Try-On",
"AI-Makeup-Transfer",
"AI-Nail-Virtual-Try-On",
"AI-Video-Object-Removal",
"AI-Replace",
"AI-Image-Extender",
"AI-Scarf-Virtual-Try-On",
"AI-Shoes-Virtual-Try-On",
"AI-Skin-Analysis",
"AI-Skin-simulation",
"AI-Facial-Color-Tones-Analyzer",
"AI-Photo-Background-Removal",
"AI-Teeth-Whitening",
"AI-Image-Generator-Text-to-Image",
"AI-Video-Generator-Text-to-Video",
"AI-Video-Enhancer",
"AI-Video-Style-Transfer",
"AI-Watermark-Removal"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Pre-select a task type. If omitted, the user picks one from the dropdown."
}
},
"additionalProperties": false
}Check the unit consumption for each API. The values are consistent with those listed at https://yce.perfectcorp.com/ai-api/api-pricing.
| Argument | Type | Description |
|---|---|---|
| request* | object |
{
"type": "object",
"required": [
"request"
],
"properties": {
"request": {
"type": "object",
"properties": {
"page_size": {
"anyOf": [
{
"type": "integer",
"maximum": 20,
"minimum": 1
},
{
"type": "null"
}
],
"default": null,
"examples": [
20
]
},
"starting_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"MjA"
]
}
}
}
},
"additionalProperties": false
}Retrieves the current status and results of a previously initiated AI processing task. Use this tool when you need to check on a task that was started earlier but hasn't completed yet, or when a user returns to inquire about a task they initiated previously. WHEN TO USE THIS TOOL: - When a user provides a task_id from a previous session and wants to check if their result is ready - When a user asks about a task they started earlier (e.g., 'Is my hairstyle ready?', 'Check my previous request') - When resuming a conversation where a task was left processing - When a task exceeded the initial polling timeout and the user wants to see if it has completed
| Argument | Type | Description |
|---|---|---|
| polling | boolean | If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish. |
| task_id* | string | ID of this task. |
| task_type* | string | The type of the task. |
| is_preprocess | boolean | Whether this is called from preprocess tool. |
{
"type": "object",
"required": [
"task_id",
"task_type"
],
"properties": {
"polling": {
"type": "boolean",
"default": true,
"description": "If true (default), keep polling until the task finishes, returning the final result. If false, return immediately without waiting for the task to finish."
},
"task_id": {
"type": "string",
"description": "ID of this task."
},
"task_type": {
"enum": [
"AI-Bracelet-Virtual-Try-On",
"AI-Earrings-Virtual-Try-On",
"AI-Necklace-Virtual-Try-On",
"AI-Ring-Virtual-Try-On",
"AI-Watch-Virtual-Try-On",
"AI-Abs-Filter",
"AI-Aging-Simulation",
"AI-Avatar-Generator",
"AI-Nail-Transfer",
"AI-Smile",
"AI-Studio-Generator",
"AI-Bag-Virtual-Try-On",
"AI-Beard-Style-Generator",
"AI-Photo-Background-Blur",
"AI-Photo-Background-Change",
"AI-Video-Background-Replace",
"AI-Body-Reshape",
"AI-Breast-Augmentation-Simulator",
"AI-Clothes-Virtual-Try-On",
"AI-Photo-Colorize",
"AI-Color-Correction",
"AI-Photo-Enhance",
"AI-Eye-Color-Lens-Virtual-Try-On",
"AI-Fabric-Virtual-Try-On",
"AI-Face-Attributes-and-Ratio-Analyzer",
"AI-Face-Lift",
"AI-Face-Reshape",
"AI-Face-Swap",
"AI-Video-Face-Swap",
"AI-Fitzpatrick-Skin-Type-Analysis",
"AI-Object-Removal-Pro",
"AI-Bangs-Filter-Virtual-Try-On",
"AI-Hair-Color-Virtual-Try-On",
"AI-Wavy-Hair-Virtual-Try-On",
"AI-Hair-Density-Detection",
"AI-Hair-Extension-Virtual-Try-On",
"AI-Hair-Frizziness-Detection",
"AI-Hair-Length-Detection",
"AI-Hair-Style-Virtual-Try-On",
"AI-Hair-Type-Detection",
"AI-Hair-Volume-Virtual-Try-On",
"AI-Hat-Virtual-Try-On",
"AI-Headshot-Generator",
"AI-Image-Generator-Image-to-Image",
"AI-Video-Generator-Image-to-Video",
"AI-Photo-Lighting",
"AI-Look-Virtual-Try-On",
"AI-Makeup-Virtual-Try-On",
"AI-Makeup-Transfer",
"AI-Nail-Virtual-Try-On",
"AI-Video-Object-Removal",
"AI-Replace",
"AI-Image-Extender",
"AI-Scarf-Virtual-Try-On",
"AI-Shoes-Virtual-Try-On",
"AI-Skin-Analysis",
"AI-Skin-simulation",
"AI-Facial-Color-Tones-Analyzer",
"AI-Photo-Background-Removal",
"AI-Teeth-Whitening",
"AI-Image-Generator-Text-to-Image",
"AI-Video-Generator-Text-to-Video",
"AI-Video-Enhancer",
"AI-Video-Style-Transfer",
"AI-Watermark-Removal"
],
"type": "string",
"description": "The type of the task."
},
"is_preprocess": {
"type": "boolean",
"default": false,
"description": "Whether this is called from preprocess tool."
}
},
"additionalProperties": false
}View the unit usage history for this account, such as units consumed or granted per task/order.
| Argument | Type | Description |
|---|---|---|
| request* | object |
{
"type": "object",
"required": [
"request"
],
"properties": {
"request": {
"type": "object",
"properties": {
"page_size": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"examples": [
20
]
},
"starting_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"examples": [
"73a3c9e69b89"
]
}
}
}
},
"additionalProperties": false
}Get the current unit balance for this account, including each unit's type, amount, and expiry.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Returns the upload API endpoint and example request/response for uploading images (JPEG, PNG) or videos (MP4) to YouCam AI./n Use when the user wants to upload an image/video via the API. If upload cannot be completed for any reason (including network restrictions, host_not_allowed, or other errors), do not retry. Immediately use the File Upload Widget instead. Do not ask the user for a public URL.
| Argument | Type | Description |
|---|---|---|
| task_type* | string | The type of the AI task to upload file for. |
{
"type": "object",
"required": [
"task_type"
],
"properties": {
"task_type": {
"enum": [
"AI-Bracelet-Virtual-Try-On",
"AI-Earrings-Virtual-Try-On",
"AI-Necklace-Virtual-Try-On",
"AI-Ring-Virtual-Try-On",
"AI-Watch-Virtual-Try-On",
"AI-Abs-Filter",
"AI-Aging-Simulation",
"AI-Avatar-Generator",
"AI-Nail-Transfer",
"AI-Smile",
"AI-Studio-Generator",
"AI-Bag-Virtual-Try-On",
"AI-Beard-Style-Generator",
"AI-Photo-Background-Blur",
"AI-Photo-Background-Change",
"AI-Video-Background-Replace",
"AI-Body-Reshape",
"AI-Breast-Augmentation-Simulator",
"AI-Clothes-Virtual-Try-On",
"AI-Photo-Colorize",
"AI-Color-Correction",
"AI-Photo-Enhance",
"AI-Eye-Color-Lens-Virtual-Try-On",
"AI-Fabric-Virtual-Try-On",
"AI-Face-Attributes-and-Ratio-Analyzer",
"AI-Face-Lift",
"AI-Face-Reshape",
"AI-Face-Swap",
"AI-Video-Face-Swap",
"AI-Fitzpatrick-Skin-Type-Analysis",
"AI-Object-Removal-Pro",
"AI-Bangs-Filter-Virtual-Try-On",
"AI-Hair-Color-Virtual-Try-On",
"AI-Wavy-Hair-Virtual-Try-On",
"AI-Hair-Density-Detection",
"AI-Hair-Extension-Virtual-Try-On",
"AI-Hair-Frizziness-Detection",
"AI-Hair-Length-Detection",
"AI-Hair-Style-Virtual-Try-On",
"AI-Hair-Type-Detection",
"AI-Hair-Volume-Virtual-Try-On",
"AI-Hat-Virtual-Try-On",
"AI-Headshot-Generator",
"AI-Image-Generator-Image-to-Image",
"AI-Video-Generator-Image-to-Video",
"AI-Photo-Lighting",
"AI-Look-Virtual-Try-On",
"AI-Makeup-Virtual-Try-On",
"AI-Makeup-Transfer",
"AI-Nail-Virtual-Try-On",
"AI-Video-Object-Removal",
"AI-Replace",
"AI-Image-Extender",
"AI-Scarf-Virtual-Try-On",
"AI-Shoes-Virtual-Try-On",
"AI-Skin-Analysis",
"AI-Skin-simulation",
"AI-Facial-Color-Tones-Analyzer",
"AI-Photo-Background-Removal",
"AI-Teeth-Whitening",
"AI-Image-Generator-Text-to-Image",
"AI-Video-Generator-Text-to-Video",
"AI-Video-Enhancer",
"AI-Video-Style-Transfer",
"AI-Watermark-Removal"
],
"type": "string",
"description": "The type of the AI task to upload file for."
}
},
"additionalProperties": false
}Upload base64-encoded media files to the YouCam API and return file_id(s). If task_type is omitted, files are uploaded via the generic file API (POST /s2s/v2.0/file) rather than a task-specific upload path.
| Argument | Type | Description |
|---|---|---|
| files* | array | |
| task_type* | any |
{
"type": "object",
"required": [
"files",
"task_type"
],
"properties": {
"files": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true
}
},
"task_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}