Generate a Try-On

curl -X POST "$BASE_URL/try-on/generate" \
  -H "x-api-key: $SOULDI_API_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "garment_image_urls": ["https://shop.example.com/tee.jpg"],
    "reference_job_id": null,
    "base_image_variant": null
  }'

const res = await fetch(`${BASE_URL}/try-on/generate`, {
  method: "POST",
  headers: {
    "x-api-key": SOULDI_API_KEY,
    Authorization: `Bearer ${accessToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    garment_image_urls: ["https://shop.example.com/tee.jpg"],
    reference_job_id: null,
    base_image_variant: null,
  }),
});

const { job_id, status } = await res.json();

import requests

res = requests.post(
    f"{BASE_URL}/try-on/generate",
    headers={
        "x-api-key": SOULDI_API_KEY,
        "Authorization": f"Bearer {access_token}",
    },
    json={
        "garment_image_urls": ["https://shop.example.com/tee.jpg"],
        "reference_job_id": None,
        "base_image_variant": None,
    },
)
job = res.json()

{
  "job_id": "f3c8a1d2-7b44-4e91-9c0a-1e2d3f4a5b6c",
  "status": "pending",
  "generated_image_url": null
}

curl -N "$BASE_URL/try-on/$JOB_ID/stream" \
  -H "x-api-key: $SOULDI_API_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Accept: text/event-stream"

import { fetchEventSource } from "@microsoft/fetch-event-source";

await fetchEventSource(`${BASE_URL}/try-on/${jobId}/stream`, {
  headers: {
    "x-api-key": SOULDI_API_KEY,
    Authorization: `Bearer ${accessToken}`,
    Accept: "text/event-stream",
  },
  openWhenHidden: true,
  onmessage(ev) {
    const job = JSON.parse(ev.data);
    if (job.status === "completed") {
      showResult(job.generated_image_url);
    } else if (job.status === "failed") {
      showError();
    }
  },
  onerror(err) {
    // Throw to stop, or return to let the library retry with backoff.
    throw err;
  },
});

// EventSource can't set custom headers, so it suits same-origin proxies only.
const es = new EventSource(`${BASE_URL}/try-on/${jobId}/stream`);
es.onmessage = (ev) => {
  const job = JSON.parse(ev.data);
  if (job.status === "completed") {
    showResult(job.generated_image_url);
    es.close();
  } else if (job.status === "failed") {
    es.close();
  }
};

: heartbeat

data: {"job_id":"f3c8a1d2-...","status":"processing","generated_image_url":null}

: heartbeat

data: {"job_id":"f3c8a1d2-...","status":"completed","generated_image_url":"https://storage.souldi.../result.png?token=..."}

curl "$BASE_URL/try-on/$JOB_ID" \
  -H "x-api-key: $SOULDI_API_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

async function pollJob(jobId, { intervalMs = 3000, maxAttempts = 20 } = {}) {
  for (let attempt = 0; attempt < maxAttempts; attempt++) {
    const res = await fetch(`${BASE_URL}/try-on/${jobId}`, {
      headers: {
        "x-api-key": SOULDI_API_KEY,
        Authorization: `Bearer ${accessToken}`,
      },
    });
    const job = await res.json();
    if (job.status === "completed") return job.generated_image_url;
    if (job.status === "failed") throw new Error("Generation failed");
    await new Promise((r) => setTimeout(r, intervalMs));
  }
  throw new Error("Timed out waiting for the job");
}

import time, requests

def poll_job(job_id, interval=3, max_attempts=20):
    for _ in range(max_attempts):
        res = requests.get(
            f"{BASE_URL}/try-on/{job_id}",
            headers={
                "x-api-key": SOULDI_API_KEY,
                "Authorization": f"Bearer {access_token}",
            },
        )
        job = res.json()
        if job["status"] == "completed":
            return job["generated_image_url"]
        if job["status"] == "failed":
            raise RuntimeError("Generation failed")
        time.sleep(interval)
    raise TimeoutError("Timed out waiting for the job")

{
  "job_id": "f3c8a1d2-7b44-4e91-9c0a-1e2d3f4a5b6c",
  "status": "completed",
  "generated_image_url": "https://storage.souldi.../result.png?token=..."
}