在應用程式中更快創作

更順暢的行動體驗

API

公開 API 文件

使用 Fashion Diffusion 公開 API 提交虛擬試穿任務並查詢其結果。

身份驗證

建立 API 金鑰,並將完整密鑰以 Bearer 憑證方式傳送。密鑰僅會顯示一次。

Authorization: Bearer fd_live_xxx

提交虛擬試穿任務

上傳服飾圖片與模特兒圖片。成功請求將回傳 HTTP 202 狀態碼及任務 ID。

curl -X POST \
  "https://www.fashiondiffusion.ai/api/public/v1/virtual-try-on/tasks" \
  -H "Authorization: Bearer fd_live_xxx" \
  -H "Content-Type: application/json" \
  --data-raw '{
    "garmentImageUrl": "https://cdn.example.com/garment.jpg",
    "modelImageUrl": "https://cdn.example.com/model.jpg",
    "imageCount": 1,
    "resolution": "2K",
    "ratio": "3:4",
    "mode": "FAST",
    "prompt": "Keep the garment shape and fabric texture"
  }'
參數支援的值預設值
imageCount1, 2, 41
resolution2K, 4K2K
ratio1:1, 3:4, 4:3, 9:16, 16:93:4
modeFAST, REFINEFAST

兩張圖片均須為公開的 HTTPS 網址、回傳圖片內容類型(Content-Type),且檔案大小不得超過 20 MB。

每次成功接受的請求皆會建立並計費一個新任務。此版本未提供冪等性保護,因此除非可接受重複扣款,否則請勿自動重試逾時的提交請求。

查詢任務

使用提交端點所回傳的任務 ID。單一 API 金鑰僅能讀取其所屬使用者及其當前團隊擁有的任務。

curl \
  -H "Authorization: Bearer fd_live_xxx" \
  "https://www.fashiondiffusion.ai/api/public/v1/tasks/{taskId}"

任務狀態包括 QUEUED(排隊中)、RUNNING(執行中)、SUCCEEDED(成功)與 FAILED(失敗)。成功任務之輸出圖片網址將於 outputs 欄位中回傳。

列出任務

列出目前使用者透過公開 API 提交的所有虛擬試穿任務。凡使用該使用者任一 API 金鑰所提交的任務皆包含在內。

curl \
  -H "Authorization: Bearer fd_live_xxx" \
  "https://www.fashiondiffusion.ai/api/public/v1/tasks?limit=20&createdAfter=2026-08-01T00%3A00%3A00Z"

limit 可接受 1 至 100 的整數,預設值為 20;請於下一次請求中將 nextCursor 作為 cursor 使用;createdAfter 為選填的 ISO 8601 時間戳記。

錯誤

錯誤訊息採用統一的封裝格式。請求 ID 同時亦會於回應標頭 X-Request-Id 中回傳。

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "garmentImageUrl: Invalid url",
    "requestId": "request-uuid"
  }
}