Name: cuuupid IDM-VTON Virtual Clothing Try-On API
Brand: magicapi
SKU: api-magicapi-virtual-clothing-try-on-api
Availability: InStock
Rating: 5.00 (1 reviews)
Author: API Market

Shashank Agarwal

# 👗 Virtual Clothing Try-On API (cuuupid IDM-VTON)

## Overview
IDM-VTON is a virtual try-on model. Its developer describes it as a clothing try-on model for photos taken "in the wild". The model is published under a non-commercial license (CC BY-NC-SA 4.0).

Send a garment image (`garm_img`), a photo of a person (`human_img`) and a short garment description (`garment_des`). The model renders the person wearing that garment and returns the URL of one image. `category` tells it whether the garment is an upper-body piece, a lower-body piece or a dress.

## Features
- **Garment from any photo**: `garm_img` can be a product image or a photo of someone wearing the garment.
- **Garment categories**: `upper_body` (default), `lower_body` or `dresses`. The garment should match the category.
- **Optional mask**: pass `mask_img` to mark the area to replace; its developer notes this makes the request faster.
- **Mask preview**: set `mask_only` to `true` to get back only the mask instead of the try-on image.
- **Non 3:4 photos**: the model expects a 3:4 person photo; set `crop` to `true` for other aspect ratios.
- **DressCode variant**: `force_dc` switches to the DressCode version of the model (used automatically when `category` is `dresses`).
- **Quality and repeatability**: `steps` from 1 to 40 (default 30) and a fixed `seed` (default 42).

## Use Cases
1. **Product page previews**: show a catalog garment on a model photo without a new photo shoot.
2. **Outfit comparison**: render several tops or dresses on the same person photo.
3. **Design mockups**: see how a new garment design looks on a person.
4. **Styling content**: create try-on images for lookbooks and social posts.

## Visual Examples
### Example Input
The request sends a garment photo, a person photo and the description "cute pink top", with `steps` 30 and `seed` 42 (the default `category` `upper_body` applies).

Garment image (`garm_img`):

![Garment input: a pink sweater](https://blog.api.market/wp-content/uploads/2026/10/docs-0ef87a0e895c-sweater.webp)

Person image (`human_img`):

![Person input photo](https://blog.api.market/wp-content/uploads/2026/10/docs-7963a4d044f9-KakaoTalk_Photo_2024-04-04-21-44-45.png)

```json
{
  "seed": 42,
  "steps": 30,
  "garm_img": "https://blog.api.market/wp-content/uploads/2026/10/docs-0ef87a0e895c-sweater.webp",
  "human_img": "https://blog.api.market/wp-content/uploads/2026/10/docs-7963a4d044f9-KakaoTalk_Photo_2024-04-04-21-44-45.png",
  "garment_des": "cute pink top"
}
```

### Example Output
![IDM-VTON output: the person wearing the pink top](https://blog.api.market/wp-content/uploads/2026/10/docs-c2d6ea786966-output.jpg)

This request returned one image and was billed 1 API unit ($0.07).

## Input Parameters
| Field | Type | Required | Default | Allowed values | Description |
| --- | --- | --- | --- | --- | --- |
| `garm_img` | string (URL) | Yes |  |  | Garment image URL (jpeg, png, gif or webp). Should match `category`; can be a product image or a photo of someone wearing it. |
| `garment_des` | string | No | none |  | Short description of the garment, for example "Short Sleeve Round Neck T-shirt". |
| `human_img` | string (URL) | Yes |  |  | Image URL of the person (jpeg, png, gif or webp). If the photo is not 3:4, set `crop` to `true`. |
| `mask_img` | string (URL) | No | none |  | Mask image URL marking the area to replace. Optional, but makes the request faster. |
| `category` | string | No | `upper_body` | `upper_body`, `lower_body`, `dresses` | Category of the garment. |
| `crop` | boolean | No | `false` |  | Crop the person image. Set to `true` if the image is not 3:4. |
| `force_dc` | boolean | No | `false` |  | Use the DressCode version of IDM-VTON. Defaults to `false`, except when `category` is `dresses`. |
| `mask_only` | boolean | No | `false` |  | Return only the mask instead of the try-on image. |
| `steps` | integer | No | `30` | `1` to `40` | Number of generation steps. Higher values take longer. |
| `seed` | integer | No | `42` |  | Random seed. The same seed and inputs give the same result. |

## Pricing
- **Pay As You Go (PAYG) pricing**: you only pay for what you use.
- **Price**: $0.07 per API unit.
- **1 API unit = 1 successful request that finishes within 45 seconds of processing.** A request that takes longer is billed 1 unit for each started 45 seconds of processing time (for example, 50 seconds of processing = 2 units = $0.14). Higher `steps` values take longer.
- Each request returns one image (the try-on result, or the mask when `mask_only` is `true`).
- The example request below costs $0.07 (1 unit) when it finishes within 45 seconds.
- **Failed or cancelled predictions are not billed.**
- **GET requests to check prediction status** are free and don't count toward API unit usage.
- **No monthly subscription fee.**

## API Documentation

### Base URL
All API requests go to: `https://prod.api.market/api/v1/magicapi/virtual-clothing-try-on-api`

### Authentication
Send your api.market API key in the `x-api-market-key` header:
```
x-api-market-key: YOUR_API_MARKET_KEY
```

### Asynchronous Processing
**IMPORTANT**: This API is asynchronous. The flow is:
1. Send a POST request to `/predictions`. A successful request returns **201 Created** with a prediction `id` and a `status` of `starting` or `processing`.
2. Poll GET `/predictions/{id}` with that ID.
3. Keep polling while `status` is `starting` or `processing`.
4. Stop when `status` is `succeeded` (read `output`), `failed` or `canceled` (read `error`).

A polling interval of 1 second and an overall timeout of 600 seconds (10 minutes) work well.

### Endpoints

#### Create a Prediction
```bash
curl -X POST "https://prod.api.market/api/v1/magicapi/virtual-clothing-try-on-api/predictions" \
  -H "Content-Type: application/json" \
  -H "x-api-market-key: YOUR_API_MARKET_KEY" \
  -d '{
    "version": "0513734a452173b8173e907e3a59d19a36266e55b48528559432bd21c7d7e985",
    "input": {
      "seed": 42,
      "steps": 30,
      "garm_img": "https://blog.api.market/wp-content/uploads/2026/10/docs-0ef87a0e895c-sweater.webp",
      "human_img": "https://blog.api.market/wp-content/uploads/2026/10/docs-7963a4d044f9-KakaoTalk_Photo_2024-04-04-21-44-45.png",
      "garment_des": "cute pink top"
    }
  }'
```

Response (201 Created):
```json
{
  "id": "ufawqhfynnddngldkgtslldrkq",
  "version": "0513734a452173b8173e907e3a59d19a36266e55b48528559432bd21c7d7e985",
  "status": "starting",
  "created_at": "2026-10-22T09:00:00.000Z"
}
```

#### Check Prediction Status
```bash
curl -X GET "https://prod.api.market/api/v1/magicapi/virtual-clothing-try-on-api/predictions/{id}" \
  -H "x-api-market-key: YOUR_API_MARKET_KEY"
```

Response when the prediction has finished (200 OK):
```json
{
  "id": "ufawqhfynnddngldkgtslldrkq",
  "status": "succeeded",
  "output": "https://blog.api.market/wp-content/uploads/2026/10/docs-c2d6ea786966-output.jpg",
  "error": null,
  "created_at": "2026-10-22T09:00:00.000Z",
  "started_at": "2026-10-22T09:00:01.000Z",
  "completed_at": "2026-10-22T09:00:20.000Z"
}
```

`output` is a single image URL (a string): the try-on image, or the mask when `mask_only` is `true`.

### Status Codes
- **201 Created**: prediction created (POST `/predictions`). This is the normal success response.
- **200 OK**: prediction details returned (GET `/predictions/{id}`).
- **400 Bad Request**: invalid input, for example a missing `garm_img` or `human_img`, a `category` that is not in the list or `steps` above 40.
- **401 Unauthorized**: missing or invalid API key.
- **404 Not Found**: no prediction with that ID.
- **429 Too Many Requests**: rate limit exceeded.
- **500 Internal Server Error** or **503 Service Unavailable**: temporary server problem; retry later.

## Rate Limits
Requests are rate limited to keep usage fair. If you receive a 429 response, wait and retry with exponential backoff.

## Error Handling
- Check the HTTP status code of every request and read the response body for the error message.
- A prediction can also end with `status` set to `failed`; the `error` field then explains why. Failed predictions are not billed.
- Retry 429, 500 and 503 responses with exponential backoff. Fix the input before retrying a 400.

## Implementation Guide
### Example Code

#### JavaScript
```javascript
const apiKey = "YOUR_API_MARKET_KEY";
const baseUrl = "https://prod.api.market/api/v1/magicapi/virtual-clothing-try-on-api";

async function createAndWaitForPrediction(input) {
  const response = await fetch(`${baseUrl}/predictions`, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "x-api-market-key": apiKey
    },
    body: JSON.stringify({ version: "0513734a452173b8173e907e3a59d19a36266e55b48528559432bd21c7d7e985", input })
  });

  if (response.status !== 201) {
    throw new Error(`API error: ${response.status} ${await response.text()}`);
  }

  const prediction = await response.json();
  return pollForResults(prediction.id);
}

const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));

async function pollForResults(predictionId) {
  const maxTimeout = 600000;
  const pollInterval = 1000;
  const startTime = Date.now();

  while (Date.now() - startTime < maxTimeout) {
    const response = await fetch(`${baseUrl}/predictions/${predictionId}`, {
      headers: { "x-api-market-key": apiKey }
    });

    if (!response.ok) {
      throw new Error(`API error: ${response.status} ${await response.text()}`);
    }

    const prediction = await response.json();

    if (prediction.status === "succeeded") {
      return prediction.output;
    }

    if (prediction.status === "failed" || prediction.status === "canceled") {
      throw new Error(`Prediction ${prediction.status}: ${prediction.error || "Unknown error"}`);
    }

    await delay(pollInterval);
  }

  throw new Error("Prediction timed out after 10 minutes");
}

createAndWaitForPrediction({
    "seed": 42,
    "steps": 30,
    "garm_img": "https://blog.api.market/wp-content/uploads/2026/10/docs-0ef87a0e895c-sweater.webp",
    "human_img": "https://blog.api.market/wp-content/uploads/2026/10/docs-7963a4d044f9-KakaoTalk_Photo_2024-04-04-21-44-45.png",
    "garment_des": "cute pink top"
  }).then((output) => console.log(output));
```

#### Python
```python
import time
import requests

API_KEY = "YOUR_API_MARKET_KEY"
BASE_URL = "https://prod.api.market/api/v1/magicapi/virtual-clothing-try-on-api"


def create_and_wait_for_prediction(input_data):
    headers = {"Content-Type": "application/json", "x-api-market-key": API_KEY}
    response = requests.post(
        f"{BASE_URL}/predictions",
        headers=headers,
        json={"version": "0513734a452173b8173e907e3a59d19a36266e55b48528559432bd21c7d7e985", "input": input_data},
    )

    if response.status_code != 201:
        raise Exception(f"API error: {response.status_code} {response.text}")

    return poll_for_results(response.json()["id"])


def poll_for_results(prediction_id):
    max_timeout = 600
    poll_interval = 1
    headers = {"x-api-market-key": API_KEY}
    start_time = time.time()

    while time.time() - start_time < max_timeout:
        response = requests.get(f"{BASE_URL}/predictions/{prediction_id}", headers=headers)

        if response.status_code != 200:
            raise Exception(f"API error: {response.status_code} {response.text}")

        prediction = response.json()

        if prediction["status"] == "succeeded":
            return prediction["output"]

        if prediction["status"] in ("failed", "canceled"):
            raise Exception(f"Prediction {prediction['status']}: {prediction.get('error') or 'Unknown error'}")

        time.sleep(poll_interval)

    raise Exception("Prediction timed out after 10 minutes")


print(create_and_wait_for_prediction({
    "seed": 42,
    "steps": 30,
    "garm_img": "https://blog.api.market/wp-content/uploads/2026/10/docs-0ef87a0e895c-sweater.webp",
    "human_img": "https://blog.api.market/wp-content/uploads/2026/10/docs-7963a4d044f9-KakaoTalk_Photo_2024-04-04-21-44-45.png",
    "garment_des": "cute pink top"
}))
```

## FAQ
- **What images work best?**
  - A clear garment image that matches `category`, and a person photo in 3:4 format. For other aspect ratios set `crop` to `true`.
- **Can I try on trousers or dresses?**
  - Yes. Set `category` to `lower_body` for trousers and skirts or `dresses` for dresses. Dresses use the DressCode version of the model automatically.
- **Do I need to send a mask?**
  - No. `mask_img` is optional. Its developer notes that a mask makes the request faster. Set `mask_only` to `true` to see the mask the model would use.
- **Can I use the results commercially?**
  - The model is published under the CC BY-NC-SA 4.0 license, which is a non-commercial license. Check that license before using results commercially.
- **How much does one request cost?**
  - $0.07 when it finishes within 45 seconds of processing; each further started 45 seconds adds $0.07.
- **Is the 201 response from POST an error?**
  - No. 201 Created means the prediction was accepted. Use the returned `id` to poll GET `/predictions/{id}` until `status` is `succeeded`, `failed` or `canceled`.

## Contact Us
If you have any questions, reach out to us through the chat on the bottom right of the page.


Put a garment from a product photo onto a person photo with IDM-VTON: tops, bottoms and dresses, with an optional mask. $0.07 per request, pay as you go.