التوثيق

مرجع API

الاستعلام عن الملفات المُدارة

GET/v1/files

الملفات السابقة للحساب والمفتاح نفسيهما. يُسمح بالمفاتيح الصالحة ذات الحصة المستنفدة؛ وتُرفض المفاتيح الملغاة/المنتهية الصلاحية. يتطلب التنزيل ready؛ ويُرجع الحذف أثناء وجود مرجع 409. يعيد retry محاولة حفظ النتيجة الأصلية فقط، لا التوليد. تستخدم API العادية احتفاظًا بالأيام، وتحمي المهام الدائمة المراجع، ويعني expires_at=0 عدم وجود انتهاء صلاحية ثابت.

المصادقة والصلاحيات

استخدم مفتاح GloopAPI الحالي. تعتمد النماذج والإمكانات والصلاحيات المتاحة على دليله ووثائق نقطة النهاية.

Authorization: Bearer $GLOOP_API_KEY

آليات المصادقة: BearerAuth

الطلب

معاملات الاستعلام

  • afterintegerاختياري

    استخدم next_cursor من الرد الأصلي؛ يحدد الخادم 50 عنصرًا لكل صفحة.

    القيمة الافتراضية
    0
    الحد الأدنى
    0

الاستجابات والأخطاء

HTTP 200

تم الاستعلام عن الملفات المُدارة بنجاح

application/json

النوع
object
الحقول المطلوبة
datanext_cursor
  • dataarrayمطلوب
    الحقول الفرعية لـ data (1)
    • []objectاختياري
      الحقول الفرعية لـ [] (13)
      • idstringمطلوب

        المعرّف العام لهذا الكائن، المستخدم لمسار تفاصيله المقابل.

      • source_kindstringمطلوب

        فئة مصدر الملف؛ تحدد دورة الحياة وقواعد حماية المراجع.

      • source_indexintegerمطلوب

        فهرس عنصر نتيجة المصدر.

      • modelstringمطلوب

        معرّف نموذج عام من دليل المفتاح الحالي.

      • statusstringمطلوب

        مراحل التخزين الخلفية مثل waiting/pending/archiving/ready/failed/deleting؛ لا يتاح رابط التنزيل إلا بعد ready.

      • mime_typestringمطلوب

        نوع MIME المتحقق منه للملف.

      • file_namestringمطلوب

        اسم الملف العام للتنزيل.

      • sha256stringاختياري

        SHA-256 للمحتوى المؤرشف، يُعاد إن كان محددًا.

      • size_bytesintegerمطلوب

        حجم الملف بالبايت.

      • error_codestringاختياري

        رمز خطأ عام يمكن استخدامه في منطق التفرّع.

      • created_atintegerمطلوب

        وقت الإنشاء بثواني Unix.

      • updated_atintegerمطلوب

        آخر تحديث بثواني Unix.

      • expires_atintegerمطلوب

        ثواني Unix؛ تعني 0 الاحتفاظ طويلًا. تتبع API العادية مدة النشر؛ وتحمي مراجع الصور/الفيديو الدائمة النتائج. تبقى الحسابات وسجلات عدم التكرار بعد الحذف.

  • next_cursorintegerمطلوب

HTTP 400

حقول الطلب أو معاملاته غير صالحة.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 401

Key مفقود أو غير صالح أو منتهي أو ملغى.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 403

صلاحيات IP أو الحساب أو النموذج أو الأداة غير كافية.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 404

الكائن/الإمكانية غير متاحين، أو مفتاح الميزة معطّل.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 409

تعارض في منع التكرار/عرض السعر، أو كائن غير جاهز، أو ما يزال مشارًا إليه.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 429

حد معدل الطلبات/قائمة الانتظار.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 500

فشل داخلي في المصادقة أو تخزين البيانات.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)

HTTP 503

الخدمة أو التسعير أو التخزين غير متاح.

application/json

النوع
object
الحقول المطلوبة
error
  • errorobjectمطلوب
    الحقول الفرعية لـ error (4)