Virtual Try-On API

REST API and MCP service documentation generated from server-side API definitions. Responses shown here are the direct payload returned by each API execution.

API selector
Creative playground

Create with Virtual Try-On API

Configure the request visually. The api request remains available in Developer Details.

Source Image*Required

Public URL of the wearable product image. The image must be between 300 and 4096 pixels in both width and height. The width-to-height ratio must be between 0.4 and 2.5.

jpg, png, webp · Max 20 megabytes · 1 image · 300–4096 px wide and high · width/height ≥ 0.4 · width/height ≤ 2.5

0/1
Original Product Image*Required

Public URL of the person or model image.

jpg, png, webp · Max 20 megabytes · 1 image

0/1
Replacement Mask*Required

Public URL of the black-and-white target wear-area mask. Required because this API accepts custom target images rather than saved upstream materials.

jpg, png, webp · Max 20 megabytes · 1 image

0/1

Video settings

Product Category

Product category. Supported values: footwear (shoes), luggage (bags), eyewear (glasses), necklace, hat, earring, ring, wristband, watch, headwear, belt, other.

Choose how many images to generate.

Technical details
Usage estimate unavailable

Preview

Your result will appear here.

The final credit cost appears when your result is ready.