مرجع API
رفع صورة مرجعية
/v1/image-assetsالجزء الأول والوحيد من multipart هو file مع اسم ملف؛ JPEG/PNG/WebP غير متحرك، بحد 10 MiB عند الرفع وبعد إعادة الترميز كلٌّ على حدة.
المصادقة والصلاحيات
استخدم مفتاح GloopAPI الحالي. تعتمد النماذج والإمكانات والصلاحيات المتاحة على دليله ووثائق نقطة النهاية.
Authorization: Bearer $GLOOP_API_KEYآليات المصادقة: BearerAuth
الطلب
ترويسات الطلب
Idempotency-Keystringمطلوباحتفظ بقصد الطلب الأصلي وبالمفتاح نفسه. بعد انقطاع الشبكة، استعلم عن الاسترداد أولًا؛ ولا تُعِد إرسال الحالات غير المعروفة دون تحقق.
- الحد الأدنى للطول
1- الحد الأقصى للطول
191
جسم الطلب · multipart/form-data
- النوع
- object
- الحقول المطلوبة
file- خصائص إضافية
- false
جسم الطلب مطلوب
filestringمطلوبجزء الصورة الوحيد، مع اسم ملف؛ JPEG/PNG/WebP غير متحركة بحجم <=10MiB.
- التنسيق
"binary"
الاستجابات والأخطاء
HTTP 200
تم رفع الصورة المرجعية
application/json
- النوع
- object
- الحقول المطلوبة
idmime_typesize_byteswidthheightexpires_at
file_idstringاختياريالمعرّف العام لملف مُدار للحساب والمفتاح نفسيهما.
idstringمطلوبالمعرّف العام لهذا الكائن، المستخدم لمسار تفاصيله المقابل.
mime_typestringمطلوبنوع MIME المتحقق منه للملف.
size_bytesintegerمطلوبحجم الملف بالبايت.
widthintegerمطلوبعرض الصورة بالبكسل.
heightintegerمطلوبارتفاع الصورة بالبكسل.
expires_atintegerمطلوبثواني Unix؛ تعني 0 عدم وجود انتهاء ثابت. يرتبط الرفع بملف مستضاف؛ تتطلب القراءة الحساب نفسه وKey نفسه.
HTTP 400
حقول الطلب أو معاملاته غير صالحة.
application/json
- النوع
- object
- الحقول المطلوبة
error
errorobjectمطلوبالحقول الفرعية لـ error (4)
codestringاختياريmessagestringاختياريtypestringاختياريrequest_idstringاختياري
HTTP 401
Key مفقود أو غير صالح أو منتهي أو ملغى.
application/json
- النوع
- object
- الحقول المطلوبة
error
errorobjectمطلوبالحقول الفرعية لـ error (4)
codestringاختياريmessagestringاختياريtypestringاختياريrequest_idstringاختياري
HTTP 403
صلاحيات IP أو الحساب أو النموذج أو الأداة غير كافية.
application/json
- النوع
- object
- الحقول المطلوبة
error
errorobjectمطلوبالحقول الفرعية لـ error (4)
codestringاختياريmessagestringاختياريtypestringاختياريrequest_idstringاختياري
HTTP 404
الكائن/الإمكانية غير متاحين، أو مفتاح الميزة معطّل.
application/json
- النوع
- object
- الحقول المطلوبة
error
errorobjectمطلوبالحقول الفرعية لـ error (4)
codestringاختياريmessagestringاختياريtypestringاختياريrequest_idstringاختياري
HTTP 409
تعارض في منع التكرار/عرض السعر، أو كائن غير جاهز، أو ما يزال مشارًا إليه.
application/json
- النوع
- object
- الحقول المطلوبة
error
errorobjectمطلوبالحقول الفرعية لـ error (4)
codestringاختياريmessagestringاختياريtypestringاختياريrequest_idstringاختياري
HTTP 429
حد معدل الطلبات/قائمة الانتظار.
application/json
- النوع
- object
- الحقول المطلوبة
error
errorobjectمطلوبالحقول الفرعية لـ error (4)
codestringاختياريmessagestringاختياريtypestringاختياريrequest_idstringاختياري
HTTP 500
فشل داخلي في المصادقة أو تخزين البيانات.
application/json
- النوع
- object
- الحقول المطلوبة
error
errorobjectمطلوبالحقول الفرعية لـ error (4)
codestringاختياريmessagestringاختياريtypestringاختياريrequest_idstringاختياري
HTTP 503
الخدمة أو التسعير أو التخزين غير متاح.
application/json
- النوع
- object
- الحقول المطلوبة
error
errorobjectمطلوبالحقول الفرعية لـ error (4)
codestringاختياريmessagestringاختياريtypestringاختياريrequest_idstringاختياري