المصادقة
أنشئ مفتاح واجهة برمجة التطبيقات وأرسل السر الكامل كشهادة من نوع Bearer. ويُعرض السر مرة واحدة فقط.
Authorization: Bearer fd_live_xxxإرسال مهمة محاكاة افتراضية للارتداء
أرسل صورة قطعة الملابس وصورة النموذج. ويعيد الطلب الناجح رمز حالة HTTP 202 مع معرف المهمة.
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"
}'| المعلَّمة | القيم المدعومة | القيمة الافتراضية |
|---|---|---|
| imageCount | 1, 2, 4 | 1 |
| resolution | 2K, 4K | 2K |
| ratio | 1:1, 3:4, 4:3, 9:16, 16:9 | 3:4 |
| mode | FAST, REFINE | FAST |
يجب أن تكون كلتا الصورتين عبارة عن روابط HTTPS عامة، وأن تُرجع نوع محتوى صوريًّا، وألا يتجاوز حجم كلٍّ منهما ٢٠ ميغابايت.
يؤدي كل طلب مقبول إلى إنشاء مهمة جديدة وفرض رسوم عليها. ولا تحتوي هذه النسخة على حماية ضد التكرار (idempotency)، لذا لا تُعدّ إرسال الطلب تلقائيًّا عند حدوث وقت انتظار (timeout) ما لم تكن الرسوم المكررة مقبولة.
الاستعلام عن مهمة
استخدم معرف المهمة الذي أعادته نقطة النهاية الخاصة بالإرسال. ويمكن لمفتاح واجهة برمجة التطبيقات قراءة المهام التي يملكها المستخدم الحالي وفريقه الحالي فقط.
curl \
-H "Authorization: Bearer fd_live_xxx" \
"https://www.fashiondiffusion.ai/api/public/v1/tasks/{taskId}"حالات المهمة هي: QUEUED، RUNNING، SUCCEEDED، وFAILED. وتُرجع الاستجابات الناجحة روابط الصور الناتجة في الحقل "outputs".
سرد المهام
سرد مهام المحاكاة الافتراضية للارتداء التي أرسلها المستخدم الحالي عبر واجهة برمجة التطبيقات العامة. وتشمل القائمة المهام المرسلة باستخدام أيٍّ من مفاتيح واجهة برمجة التطبيقات الخاصة بهذا المستخدم.
curl \
-H "Authorization: Bearer fd_live_xxx" \
"https://www.fashiondiffusion.ai/api/public/v1/tasks?limit=20&createdAfter=2026-08-01T00%3A00%3A00Z"يقبل المعلَّمة limit قيمة بين ١ و١٠٠، والقيمة الافتراضية هي ٢٠. واستخدم القيمة nextCursor كمعلَّمة cursor في الطلب التالي. أما المعلَّمة createdAfter فهي اختيارية وتكون على هيئة طابع زمني وفق معيار ISO 8601.
الأخطاء
تستخدم الأخطاء غلافًا موحدًا. كما يُعاد معرّف الطلب أيضًا في رأس الاستجابة X-Request-Id.
{
"error": {
"code": "VALIDATION_ERROR",
"message": "garmentImageUrl: Invalid url",
"requestId": "request-uuid"
}
}