Dressroom API

Quickstart

1. 1Create an API key in the API Dashboard, then contact our team to get credits added.
2. 2Every call takes an externalUserId — your own id for the end user whose wardrobe you're building. Same id, same wardrobe, every time.
3. 3Add pieces with detect, scrape, or upload, let your UI accept/reject, then PUT inventory to save.

That's the whole Dressroom API — building and maintaining a wardrobe. Styling a look from it is a separate feature (the same StyleMe Try-On step ZukMe Marketplace and Your Own Inventory use); see Styling from this wardrobe.

User experience flow

A plain walkthrough of what your user experiences in your own UI — no implementation detail. Each beat notes which call powers it.

Building a wardrobe

Styling a look from the saved wardrobe is a separate feature — see Styling from this wardrobe.

Base URL

https://zukme.com

All endpoints below are relative to this base URL.

Authentication

Every request needs your API key as a bearer token — create and manage keys in the API Dashboard. The raw key is shown once; only its hash is stored.

Authorization: Bearer zk_live_<your key>

Missing, malformed, or revoked key → 401:

{ "error": "Invalid or missing API key. Pass it as \"Authorization: Bearer zk_live_...\"." }

Rate limits

30 requests per minute per key (submit and poll both count). Over the limit → 429:

{ "error": "Rate limit exceeded.", "retryAfterSeconds": 12 }

Credits

Each successful submission costs 1 credit, deducted at submit and refunded automatically if generation fails. Polling is always free. Detect and scrape cost 1 credit each; upload is free. Studio photo (optional) costs 1 credit per piece. A new API key starts with 0 credits — API and embed-widget usage spends from your account's bonus credit balance only, never your app subscription's monthly quota. Contact our team to get bonus credits added before building against this in production. Check your balance in the API Dashboard.

Errors

Example 402 body:

{
  "error": "CREDITS_EXHAUSTED",
  "code": "CREDITS_EXHAUSTED",
  "looks": 0,
  "bonus": 0,
  "total": 0
}

Step 1 — Add pieces

Every call below takes externalUserId (required) and an optional dressroomId, for a user with more than one wardrobe. Same pair → same wardrobe, always.

{ "ok": true, "drafts": [ { "id": "...", "name": "Cream Wool Blazer", "category": "outerwear", "imageUrl": "https://…" } ] }

{ "ok": true, "product": { "id": "...", "name": "...", "category": "outerwear", "imageUrl": "https://…" } }

Neither detect nor scrape saves anything — save what your UI keeps with PUT inventory below.

Optional — Studio photo

Takes an imageUrl already returned by detect, scrape, or upload and re-renders it — useful for a rough crop from a busy wardrobe photo, or a low-quality scraped product shot. Entirely optional: skip it and save the original photo with PUT inventory instead. Async: submit, then poll, same pattern as every other generation call.

{ "ok": true, "jobId": "..." }
// poll: { "action": "poll", "jobId": "..." }
// → { "ok": true, "status": "done", "imageUrl": "https://..." }

The returned imageUrl replaces the original for that piece — pass it along instead when you PUT inventory to save.

Step 2 — Save & read

{ "ok": true, "count": 4, "products": [ { "id": "p1", "name": "Linen blazer", "category": "outerwear", "imageUrl": "https://…" } ] }

products in the response is the true saved state, not an echo of what you sent — an item with an unreachable image is dropped silently, so always read this back rather than assume.

Styling from this wardrobe

Not part of building a wardrobe — this is the same StyleMe Try-On step ZukMe Marketplace and Your Own Inventory use, sourced from this wardrobe instead of a catalog. Input: a StyleMe reading and a photo. Output: a rendered look, matched from the wardrobe you just saved. Async: submit, then poll.

{ "ok": true, "jobId": "..." }
// poll: { "action": "poll", "jobId": "..." }
// → { "ok": true, "status": "done", "imageUrl": "https://...", "outfitBreakdown": [...] }

Each outfitBreakdown entry has a type: "matched" is a real piece from their wardrobe, worn exactly as photographed. A category with nothing good in their wardrobe gets "invented" instead of being left empty — an AI-designed piece, optionally paired with a real bestMatch "shop similar" suggestion that is never the piece actually rendered.

Callbacks (webhooks)

dressroom/tryon accept an optional callbackUrl on submit. When the job finishes (success or failure), we POST the same payload a completed poll would return — in addition to, never instead of, polling. Best-effort delivery with no retries, so keep polling as your source of truth.

// what we POST to callbackUrl on success:
{ "jobId": "...", "status": "done", "imageUrl": "https://...", "outfitBreakdown": [...] }

// on failure:
{ "jobId": "...", "status": "error", "error": "..." }

callbackUrl must be a public http(s) URL — localhost and private network addresses are rejected.

Full example

Building the wardrobe — the Dressroom API itself:

const KEY = process.env.ZUKME_API_KEY;
const BASE = "https://zukme.com/api/v1/dressroom";
const externalUserId = "customer-42";

async function call(path, body) {
  const res = await fetch(`${BASE}${path}`, {
    method: "POST",
    headers: { Authorization: `Bearer ${KEY}`, "Content-Type": "application/json" },
    body: JSON.stringify({ externalUserId, ...body }),
  });
  return res.json();
}

// 1. Scan a photo
const { drafts } = await call("/detect", { imageBase64 });

// 2. Your UI shows drafts for accept/reject — say the user kept all of them

// 3. Save
const { products } = await fetch(`${BASE}/inventory`, {
  method: "PUT",
  headers: { Authorization: `Bearer ${KEY}`, "Content-Type": "application/json" },
  body: JSON.stringify({ externalUserId, products: drafts }),
}).then((r) => r.json());

Styling from it — a separate call into the StyleMe Try-On step (see StyleMe reading for how to get a reading first):

const submitted = await call("/tryon", { reading, photoBase64, occasion: "Weekend brunch" });

let result;
while (true) {
  result = await call("/tryon", { action: "poll", jobId: submitted.jobId });
  if (result.status === "done" || result.status === "error") break;
  await new Promise((r) => setTimeout(r, 2500));
}

console.log(result); // { ok: true, status: "done", imageUrl: "...", outfitBreakdown: [...] }