Virtual try-on API

Authentication

Send the key in the Authorization header. Test keys start with hk_test_ and live keys with hk_live_.

Authorization: Bearer hk_live_xxxxxxxxxxxxxxxx

Create a try-on

POST https://houshstyle.ir/api/v1/try-on/ — multipart/form-data, or JSON with image URLs

curl -X POST https://houshstyle.ir/api/v1/try-on/ \
  -H "Authorization: Bearer $HUSH_KEY" \
  -F person_image=@person.jpg \
  -F garment_image=@dress.jpg \
  -F garment_type=w_gown \
  -F garment_image_2=@heels.jpg \
  -F garment_type_2=w_heels \
  -F resolution=hd \
  -F webhook_url=https://your-app.com/hooks/tryon

Response (202):

{"id": "8b1c…", "status": "queued", "result_url": null, "credits_charged": 2, ...}

Get the result

GET https://houshstyle.ir/api/v1/try-on/{id}/

Statuses: queued, processing, completed, failed. When completed, result_url is the final image. If a try-on fails, the credit is refunded automatically (refunded=true).

Python example

import requests, time
H = {"Authorization": "Bearer hk_live_..."}
r = requests.post("https://houshstyle.ir/api/v1/try-on/", headers=H,
    files={"person_image": open("me.jpg", "rb"), "garment_image": open("dress.jpg", "rb")},
    data={"garment_type": "w_cocktail"})
job = r.json()
while job["status"] in ("queued", "processing"):
    time.sleep(2)
    job = requests.get(f"https://houshstyle.ir/api/v1/try-on/{job['id']}/", headers=H).json()
print(job["result_url"])

JavaScript (Node) example

const fd = new FormData();
fd.append("person_image_url", "https://cdn.example.com/u/123.jpg");
fd.append("garment_id", "42");
const res = await fetch("https://houshstyle.ir/api/v1/try-on/", {
  method: "POST", headers: { Authorization: `Bearer ${process.env.HUSH_KEY}` }, body: fd });
console.log(await res.json());

PHP example

$ch = curl_init("https://houshstyle.ir/api/v1/try-on/");
curl_setopt_array($ch, [CURLOPT_POST => true, CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("HUSH_KEY")],
  CURLOPT_POSTFIELDS => ["person_image" => new CURLFile("me.jpg"), "garment_image" => new CURLFile("coat.jpg"),
                         "garment_type" => "m_blazer"]]);
echo curl_exec($ch);

Webhook

When processing finishes, a POST with a JSON body and the following headers is sent to webhook_url:

X-Hush-Timestamp: 1760780000
X-Hush-Signature: sha256=HMAC_SHA256(webhook_secret, timestamp + "." + raw_body)

{"event": "tryon.completed", "data": {"id": "...", "status": "completed", "result_url": "..."}}

# Python verify
import hmac, hashlib
expected = hmac.new(SECRET.encode(), ts.encode() + b"." + body, hashlib.sha256).hexdigest()
assert hmac.compare_digest("sha256=" + expected, signature)

Other endpoints

• GET /api/v1/usage/ — Remaining credit and this month's usage
• GET /api/v1/garments/ — Garments available to try on (public + your products)
• GET /api/v1/try-on/list/ — Latest 50 try-ons

Error codes

Garment and accessory types (garment_type)

u_ keys are unisex. Old English names (such as cocktail dress) are still accepted.

Clothing — Women

Clothing — Men

Sets & one-pieces — Women

Sets & one-pieces — Men

Sets & one-pieces — Unisex

Accessories — Women

Accessories — Men

Accessories — Unisex