IDM VTON Serverless API

Best-in-class clothing virtual try on in the wild

~10.76s
POST /v2/idm-vton · submit + poll
 1# pip install "segmind>=1.1.0"
 2# export SEGMIND_API_KEY="YOUR_API_KEY"
 3import segmind
 4
 5# Async (v2): submit to the queue and block until COMPLETED.
 6# run() returns the final result dict (600s deadline, 1.0s poll by default).
 7result = segmind.run(
 8    "idm-vton",
 9    crop=False,
10    seed=42,
11    steps=30,
12    category="upper_body",
13    force_dc=False,
14    human_img="https://segmind-sd-models.s3.amazonaws.com/display_images/idm-ip.png",
15    garm_img="https://segmind-sd-models.s3.amazonaws.com/display_images/idm-viton-dress.png",
16    mask_only=False,
17    garment_des="Green colour semi Formal Blazer",
18)
19print(result["status"])                      # COMPLETED
20print(result.get("output"))                  # model output (e.g. media URL)
21print(result["metrics"]["inference_time"])   # server compute seconds
22
23# --- Or submit + poll manually (track request_id, control the cadence) ---
24from segmind import SegmindClient, InferenceFailed, InferenceTimeout
25
26client = SegmindClient()                      # reads SEGMIND_API_KEY
27payload = {
28    "crop": False,
29    "seed": 42,
30    "steps": 30,
31    "category": "upper_body",
32    "force_dc": False,
33    "human_img": "https://segmind-sd-models.s3.amazonaws.com/display_images/idm-ip.png",
34    "garm_img": "https://segmind-sd-models.s3.amazonaws.com/display_images/idm-viton-dress.png",
35    "mask_only": False,
36    "garment_des": "Green colour semi Formal Blazer",
37}
38job = client.submit_async("idm-vton", **payload)
39print(job.request_id)                         # available immediately
40try:
41    result = job.wait(timeout=600, interval=1.0)
42except InferenceTimeout as e:
43    print("still running:", e.request_id)
44except InferenceFailed as e:
45    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/idm-vton

Parameters

garm_imgrequired
string (uri)

Garment, should match the category, can be a product image or even a photo of someone

Default: "https://segmind-sd-models.s3.amazonaws.com/display_images/idm-viton-dress.png"
human_imgrequired
string (uri)

Model, if this is not 3:4 check crop

Default: "https://segmind-sd-models.s3.amazonaws.com/display_images/idm-ip.png"
categoryoptional
string

An enumeration.

Default: "upper_body"
Allowed values :
"upper_body""lower_body""dresses"
cropoptional
boolean

Use cropping? (check this if your image is not 3:4)

Default: false
force_dcoptional
boolean

Use the DressCode version of IDM-VTON (this is default false, except if category=dresses)

Default: false
garment_desoptional
string

Description of garment e.g. Short Sleeve Round Neck T-shirt

Default: "Green colour semi Formal Blazer"
mask_imgoptional
string (uri)

Mask image, optional (but faster)

Default: null
mask_onlyoptional
boolean

Return only the mask

Default: false
seedoptional
integer
Default: 42
stepsoptional
integer
Default: 30Range: 1 - 40

Response Type

Returns: Image

Asynchronous requests (v2)

Use Async for video, long-running (>~60s), or high-concurrency workloads; Sync is simplest for fast image & LLM calls. Async submits a request and you poll it to completion.

  1. 1
    POST /v2/idm-vton

    Submitreturns request_id, status_url, response_url

  2. 2
    GET /v2/requests/{id}/status

    Polluntil COMPLETED or FAILED

  3. 3
    GET /v2/requests/{id}

    Resultfinal response body

Status states

QUEUEDAccepted, waiting for a worker
PROCESSINGRunning on a worker
COMPLETEDDone — result body is ready
FAILEDErrored (incl. content/RAI blocks)
  • A FAILED request is served as HTTP 422 — the body still carries the error detail.
  • An unknown or expired request_id returns HTTP 404.
  • Results are retained for 1 hour, then expire.
  • Content / RAI blocks surface as FAILED, not a separate state.
  • Track completion by polling the status endpoint.

Common Error Codes

The API returns standard HTTP status codes. Detailed error messages are provided in the response body.

400

Bad Request

Invalid parameters or request format

401

Unauthorized

Missing or invalid API key

403

Forbidden

Insufficient permissions

404

Not Found

Model or endpoint not found

406

Insufficient Credits

Not enough credits to process request

429

Rate Limited

Too many requests

500

Server Error

Internal server error

502

Bad Gateway

Service temporarily unavailable

504

Timeout

Request timed out