التوثيق

مرجع API

الاستعلام عن إمكانات مساحة عمل الفيديو

GET/v1/video-models

يعيد إعدادات مسبقة قابلة للتنفيذ وقيود الإطارات لكل وضع. لا يجوز استخدام إلا إعدادات مسبقة كاملة؛ ولا تخلط المعاملات بين الأوضاع.

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

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

Authorization: Bearer $GLOOP_API_KEY

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

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

HTTP 200

تم الاستعلام عن إمكانات مساحة عمل الفيديو بنجاح

application/json

النوع
object
الحقول المطلوبة
dataworkspace_enabledupload_enabledfile_storage_enabled
  • dataarrayمطلوب

    مصفوفة بيانات الصفحة/الدليل الحاليين.

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

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

      • namestringمطلوب

        اسم مقروء للمستخدم.

      • capability_versionstringمطلوب

        إصدار إمكانات هذا النموذج العام.

      • modesarrayمطلوب

        الأوضاع القابلة للتنفيذ لهذا النموذج وتركيبات المعاملات الكاملة لكل منها.

        الحقول الفرعية لـ modes (1)
        • []objectاختياري
          الحقول الفرعية لـ [] (9)
          • modestringمطلوب

            وضع التنفيذ.

          • presetsarrayمطلوب

            تركيبات معاملات كاملة وقابلة للتنفيذ؛ لا تكوّن حاصل ضرب ديكارتي بين التركيبات.

            الحقول الفرعية لـ presets (1)
            • []objectاختياري
              الحقول الفرعية لـ [] (4)
              • durationintegerاختيارييسمح بـ null

                المدة بالثواني في الإعداد المسبق للنموذج.

              • resolutionstringاختياري

                قيمة الدقة في الإعداد المسبق للنموذج.

              • aspect_ratiostringاختياري

                قيمة نسبة العرض إلى الارتفاع في الإعداد المسبق للنموذج.

              • generate_audiobooleanاختيارييسمح بـ null

                هل يولّد هذا الإعداد المسبق للنموذج صوتًا.

          • audio_policystringمطلوب

            سياسة حقل الصوت للوضع الحالي.

          • aspect_policystringمطلوب

            سياسة حقل نسبة العرض إلى الارتفاع للوضع الحالي.

          • duration_policystringمطلوب

            سياسة حقل المدة للوضع الحالي.

          • prompt_max_charsintegerمطلوب

            الحد الأقصى لعدد محارف Unicode في التوجيه للوضع الحالي.

          • start_frameobjectاختياري

            قيود الإطار الأول للوضع الحالي.

            الحقول الفرعية لـ start_frame (5)
            • requiredbooleanمطلوب

              هل يتطلب هذا الوضع الإطار.

            • max_bytesintegerمطلوب

              الحد الأقصى لحجم الملف بالبايت المسموح به لهذا الإطار.

            • max_pixelsintegerمطلوب

              الحد الأقصى لإجمالي عدد البكسلات المسموح به لهذا الإطار.

            • max_edgeintegerمطلوب

              الحد الأقصى لعدد البكسلات في أي جانب من هذا الإطار.

            • content_typesarrayمطلوب

              أنواع MIME للصور المسموح بها لهذا الإطار.

              الحقول الفرعية لـ content_types (1)
              • []stringاختياري
            فرع allOf رقم 1

            النوع: object

            المطلوب في هذا الفرع: required, max_bytes, max_pixels, max_edge, content_types

            • requiredbooleanمطلوب

              هل يتطلب هذا الوضع الإطار.

            • max_bytesintegerمطلوب

              الحد الأقصى لحجم الملف بالبايت المسموح به لهذا الإطار.

            • max_pixelsintegerمطلوب

              الحد الأقصى لإجمالي عدد البكسلات المسموح به لهذا الإطار.

            • max_edgeintegerمطلوب

              الحد الأقصى لعدد البكسلات في أي جانب من هذا الإطار.

            • content_typesarrayمطلوب

              أنواع MIME للصور المسموح بها لهذا الإطار.

              الحقول الفرعية لـ content_types (1)
              • []stringاختياري
          • end_frameobjectاختياري

            قيود الإطار الأخير للوضع الحالي.

            الحقول الفرعية لـ end_frame (5)
            • requiredbooleanمطلوب

              هل يتطلب هذا الوضع الإطار.

            • max_bytesintegerمطلوب

              الحد الأقصى لحجم الملف بالبايت المسموح به لهذا الإطار.

            • max_pixelsintegerمطلوب

              الحد الأقصى لإجمالي عدد البكسلات المسموح به لهذا الإطار.

            • max_edgeintegerمطلوب

              الحد الأقصى لعدد البكسلات في أي جانب من هذا الإطار.

            • content_typesarrayمطلوب

              أنواع MIME للصور المسموح بها لهذا الإطار.

              الحقول الفرعية لـ content_types (1)
              • []stringاختياري
            فرع allOf رقم 1

            النوع: object

            المطلوب في هذا الفرع: required, max_bytes, max_pixels, max_edge, content_types

            • requiredbooleanمطلوب

              هل يتطلب هذا الوضع الإطار.

            • max_bytesintegerمطلوب

              الحد الأقصى لحجم الملف بالبايت المسموح به لهذا الإطار.

            • max_pixelsintegerمطلوب

              الحد الأقصى لإجمالي عدد البكسلات المسموح به لهذا الإطار.

            • max_edgeintegerمطلوب

              الحد الأقصى لعدد البكسلات في أي جانب من هذا الإطار.

            • content_typesarrayمطلوب

              أنواع MIME للصور المسموح بها لهذا الإطار.

              الحقول الفرعية لـ content_types (1)
              • []stringاختياري
          • cancel_policystringاختياري

            سياسة إمكانية الإلغاء؛ لا يضمن طلب الإلغاء اكتماله أو استرداد المبلغ.

      • cancel_policystringمطلوب

        سياسة إمكانية الإلغاء؛ لا يضمن طلب الإلغاء اكتماله أو استرداد المبلغ.

      • pricing_kindsarrayمطلوب

        طرق التسعير التي يسمح بها هذا النموذج.

        الحقول الفرعية لـ pricing_kinds (1)
        • []stringاختياري
  • workspace_enabledbooleanمطلوب

    هل تُفعَّل المهام الجديدة في مساحة العمل الحالية؛ لا يعني ذلك حذف الكائنات السابقة.

  • upload_enabledbooleanمطلوب

    هل تفعّل الخدمة رفع الصور المرجعية.

  • file_storage_enabledbooleanمطلوب

    هل تفعّل الخدمة تخزين الملفات المُدارة.

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)