Try-On Diffusion Serverless API

Outfitting Fusion based Latent Diffusion for Controllable Virtual Try-on

POST /v2/try-on-diffusion · 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    "try-on-diffusion",
 9    model_image="https://segmind-sd-models.s3.amazonaws.com/display_images/model.png",
10    cloth_image="https://segmind-sd-models.s3.amazonaws.com/display_images/cloth.jpg",
11    category="Upper body",
12    num_inference_steps=35,
13    guidance_scale=2,
14    seed=12467,
15    base64=False,
16)
17print(result["status"])                      # COMPLETED
18print(result.get("output"))                  # model output (e.g. media URL)
19print(result["metrics"]["inference_time"])   # server compute seconds
20
21# --- Or submit + poll manually (track request_id, control the cadence) ---
22from segmind import SegmindClient, InferenceFailed, InferenceTimeout
23
24client = SegmindClient()                      # reads SEGMIND_API_KEY
25payload = {
26    "model_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/model.png",
27    "cloth_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/cloth.jpg",
28    "category": "Upper body",
29    "num_inference_steps": 35,
30    "guidance_scale": 2,
31    "seed": 12467,
32    "base64": False,
33}
34job = client.submit_async("try-on-diffusion", **payload)
35print(job.request_id)                         # available immediately
36try:
37    result = job.wait(timeout=600, interval=1.0)
38except InferenceTimeout as e:
39    print("still running:", e.request_id)
40except InferenceFailed as e:
41    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/try-on-diffusion

Parameters

categoryrequired
string

What type of clothes

Default: "Upper body"
Allowed values :
"Upper body""Lower body""Dress"
cloth_imagerequired
string (uri)

Cloth Image

model_imagerequired
string (uri)

Input Image.

base64optional
boolean

Base64 encoding of the output image.

Default: false
guidance_scaleoptional
number

Scale for classifier-free guidance

Default: 2Range: 1 - 25
num_inference_stepsoptional
integer

Number of denoising steps.

Default: 25Range: 20 - 100
seedoptional
integer

Seed for image generation.

Default: -1Range: -1 - 999999999999999

Response Type

Returns: Media File

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/try-on-diffusion

    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