# try-on API

> تجربة افتراضية تضع صورة قطعة ملابس على صورة شخص، مع إمكانية اختيار نوع الملابس

يرسم شخصًا يرتدي قطعة ملابس محددة. يتطلب `human_image_url` و`garment_image_url` و`cloth_type`، التي يمكن أن تكون upper أو lower أو overall أو inner أو outer. يستخدم حجم الإخراج إعدادات مسبقة مثل portrait_4_3 أو square_hd. يمكن ضبط `num_inference_steps` (من 1 إلى 50) و`guidance_scale` وseed.

- Model id: `cat-vton`
- Made by: Open model
- Category: Image Editing
- Output: image
- Estimated price per run: $0.018 / run (cheapest run $0.018 (18 API credits))
- Run: `POST https://api.doitong.com/v1/run/cat-vton`
- Quote: `POST https://api.doitong.com/v1/quote/cat-vton`
- Docs page: https://doitong.com/ar/developers/models/cat-vton

## Pricing

Price: **$0.018 / run**. Estimated from the typical cost of one run. The quote is exactly what the run charges.

The full example input below costs $0.018 = 18 API credits (1 request × 18 API credits).

Prices are the upstream price in USD, paid from the API balance in API credits (1000 API credits = 1 USD). `POST https://api.doitong.com/v1/quote/cat-vton` with the same JSON body returns the exact price for that input; the quote is exactly what a run charges. Invalid input is never charged and failed or canceled requests are refunded automatically.

## Input parameters

| Parameter | Canonical name | Type | Required | Default | Allowed values / range | Description |
|---|---|---|---|---|---|---|
| `human_image_url` |  | string (image URL) | yes |  |  | عنوان URL يشير إلى صورة الشخص. |
| `garment_image_url` |  | string (image URL) | yes |  |  | عنوان URL يشير إلى صورة الملابس. |
| `cloth_type` |  | enum (string) | yes |  | `upper`, `lower`, `overall`, `inner`, `outer` | فئة الملابس للتجربة: يعني upper ملابس الجزء العلوي من الجسم؛ ويعني lower ملابس الجزء السفلي؛ ويعني overall ملابس الجسم بالكامل؛ ويعني inner طبقة داخلية، مثل قميص أسفل سترة؛ ويعني outer طبقة خارجية، مثل سترة تغطي قميصًا. |
| `image_size` |  | object {width, height} \| enum (string) | no | `portrait_4_3` | `square_hd`, `square`, `portrait_4_3`, `portrait_16_9`, `landscape_4_3`, `landscape_16_9` | أبعاد الصورة المُولّدة. |
| `num_inference_steps` |  | integer | no | `30` | 1 – 50 | عدد خطوات الاستدلال المطلوب تنفيذها. |
| `guidance_scale` |  | number | no | `2.5` | 0 – 20 | قوة الالتزام بالموجّه لاختيار الصورة، معبَّر عنها بصيغة CFG (Classifier Free Guidance). |
| `seed` |  | integer \| null | no |  |  | بذرة لقابلية إعادة إنتاج الصورة. يتطلب إعادة إنتاج صورة إبقاء البذرة والمدخل وإصدار النموذج دون تغيير؛ وفي هذه الظروف تكون النتيجة مطابقة في كل عملية. |
| `enable_safety_checker` |  | boolean | no | `true` |  | يمكن تخفيف الفحص بضبط القيمة على false، شريطة أن يكون المستدعي مخولًا بذلك. |

File parameters (`human_image_url`, `garment_image_url`) take a public `https://` URL, a `data:` URI up to 10 MB, or the `file_url` of an upload from `POST /files`.

## Example input

Required parameters only:

```json
{
  "human_image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
  "garment_image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
  "cloth_type": "upper"
}
```

A fuller example:

```json
{
  "human_image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
  "garment_image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
  "cloth_type": "upper"
}
```

## Run it

Set `DOITONG_API_KEY` to a key from https://doitong.com/developers/dashboard#keys. `?wait=20` returns the finished request in the same call when it is ready within 20 seconds; otherwise poll `GET /requests/{id}` (it also accepts `?wait=`), or pass `webhook_url`.

### curl

```bash
# Run the model; wait up to 20 s for the finished result in the same call
curl -X POST "https://api.doitong.com/v1/run/cat-vton?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "human_image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "garment_image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "cloth_type": "upper"
  }'

# Still "queued" or "running"? Poll with the id from the response:
curl "https://api.doitong.com/v1/requests/REQUEST_ID?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY"
```

### JavaScript

```javascript
const API = "https://api.doitong.com/v1";
const headers = {
  "Authorization": "Bearer " + process.env.DOITONG_API_KEY,
  "Content-Type": "application/json",
};

// Run the model; wait up to 20 s for the finished result in the same call
let res = await fetch(API + "/run/cat-vton?wait=20", {
  method: "POST",
  headers,
  body: JSON.stringify({
    "human_image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "garment_image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "cloth_type": "upper"
  }),
});
let request = await res.json();
if (!res.ok) throw new Error(request.error.code + ": " + request.error.message);

// Not finished yet: long-poll until it is
while (request.status === "queued" || request.status === "running") {
  res = await fetch(API + "/requests/" + request.id + "?wait=20", { headers });
  request = await res.json();
}
if (request.status !== "succeeded") throw new Error(JSON.stringify(request.error));
console.log(request.outputs.map((o) => o.url), request.cost.credits + " API credits ($" + request.cost.usd + ")");
```

### Python

```python
import os
import requests

API = "https://api.doitong.com/v1"
headers = {"Authorization": "Bearer " + os.environ["DOITONG_API_KEY"]}

payload = {
    "human_image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "garment_image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "cloth_type": "upper",
}

# Run the model; wait up to 20 s for the finished result in the same call
r = requests.post(API + "/run/cat-vton", params={"wait": 20}, json=payload, headers=headers)
request = r.json()
if not r.ok:
    raise RuntimeError(request["error"]["code"] + ": " + request["error"]["message"])

# Not finished yet: long-poll until it is
while request["status"] in ("queued", "running"):
    request = requests.get(API + "/requests/" + request["id"], params={"wait": 20}, headers=headers).json()
if request["status"] != "succeeded":
    raise RuntimeError(request["error"])
print([o["url"] for o in request["outputs"]], request["cost"]["credits"], "API credits", "$" + request["cost"]["usd"])
```

### MCP

The MCP server at `https://api.doitong.com/v1/mcp` exposes the tools `search_models`, `get_model`, `quote`, `run`, `get_request`, `cancel_request`, `list_requests`, `create_upload` and `get_account`. A `run` call for this model:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "run",
    "arguments": {
      "model_id": "cat-vton",
      "input": {
        "human_image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
        "garment_image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
        "cloth_type": "upper"
      },
      "wait_seconds": 20
    }
  }
}
```

## Response

Every call returns a request object. `status` is one of `queued`, `running`, `succeeded`, `failed`, `canceled`. `outputs` lists the generated files with URLs on our storage (kept forever, or 7 days with `?storage=temporary`; `storage` says which); `output` is the model's own result object with the same URLs.

```json
{
  "id": "req_8k2m4q7x1z9c3v5b6n0p2r4t",
  "object": "request",
  "model": "cat-vton",
  "status": "succeeded",
  "created_at": "2026-10-20T12:00:00Z",
  "started_at": "2026-10-20T12:00:02Z",
  "completed_at": "2026-10-20T12:00:09Z",
  "queue_position": null,
  "cost": {
    "credits": 18,
    "usd": "0.018",
    "charged": 18,
    "refunded": 0
  },
  "input": {
    "human_image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "garment_image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "cloth_type": "upper"
  },
  "output": {
    "image": {
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.jpeg",
      "content_type": "image/jpeg",
      "file_name": "0-output.jpeg",
      "file_size": 1843200,
      "width": 1024,
      "height": 768
    }
  },
  "outputs": [
    {
      "type": "image",
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.jpeg",
      "content_type": "image/jpeg",
      "file_size": 1843200,
      "width": 1024,
      "height": 768,
      "stored": true
    }
  ],
  "error": null,
  "metrics": {
    "inference_seconds": 6.8
  },
  "urls": {
    "self": "https://api.doitong.com/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t",
    "cancel": "https://api.doitong.com/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t/cancel"
  }
}
```

### Output fields (`output`)

| Field | Type | Description |
|---|---|---|
| `image` | object {url, content_type, file_name, file_size, width, height} | الصورة المُنتجة كمخرج. |

## Related models

- [FLUX.1 Kontext \[pro\]](https://doitong.com/developers/models/flux-pro/kontext.md) (`flux-pro/kontext`): $0.04 / image
- [GPT Image 2.5 Edit](https://doitong.com/developers/models/openai/gpt-image-2.5/flare/edit.md) (`openai/gpt-image-2.5/flare/edit`): from $0.12 / image
- [Nano Banana 2 Edit](https://doitong.com/developers/models/nano-banana-2/edit.md) (`nano-banana-2/edit`): from $0.06 / image
- [Nano Banana Pro Edit](https://doitong.com/developers/models/nano-banana-pro/edit.md) (`nano-banana-pro/edit`): from $0.15 / image
- [Qwen Image 3 Edit](https://doitong.com/developers/models/alibaba/qwen-image-3/edit.md) (`alibaba/qwen-image-3/edit`): from $0.04 / image
- [Seedream 5.0 Pro Edit](https://doitong.com/developers/models/bytedance/seedream/v5/pro/edit.md) (`bytedance/seedream/v5/pro/edit`): from $0.0675 / run of output image
- [Bernini-R Edit Image](https://doitong.com/developers/models/bernini-r/edit-image.md) (`bernini-r/edit-image`): $0.03 / megapixel of output image
- [Boogu Image · Edit](https://doitong.com/developers/models/boogu-image/edit.md) (`boogu-image/edit`): $0.08 / image

## Links

- HTML page: https://doitong.com/developers/models/cat-vton
- All models and guides for AI agents: https://doitong.com/developers/llms.txt
- OpenAPI 3.1 with this model's typed request body: https://doitong.com/developers/openapi.json?model=cat-vton
- Errors: https://doitong.com/developers/docs/errors
- Model details as JSON: https://api.doitong.com/v1/models/cat-vton