Documentation

Référence API

Lister les capacités de l'espace vidéo

GET/v1/video-models

Renvoie par mode les presets exécutables et contraintes d'images. Utilisez uniquement des presets complets, sans mélanger les modes.

Authentification et autorisations

Utilisez votre clé GloopAPI actuelle. Les modèles, capacités et autorisations disponibles dépendent de son catalogue et de la documentation du point de terminaison.

Authorization: Bearer $GLOOP_API_KEY

Schémas d'authentification : BearerAuth

Réponses et erreurs

HTTP 200

Capacités de l'espace vidéo obtenues

application/json

Type
object
Champs obligatoires
dataworkspace_enabledupload_enabledfile_storage_enabled
  • dataarrayObligatoire

    Tableau de données de la page/du catalogue actuel.

    Sous-champs de data (1)
    • []objectFacultatif
      Sous-champs de [] (6)
      • idstringObligatoire

        Identifiant public de l'objet, utilisé dans son chemin de détails.

      • namestringObligatoire

        Nom lisible par l'utilisateur.

      • capability_versionstringObligatoire

        Version des capacités de ce modèle public.

      • modesarrayObligatoire

        Modes exécutables du modèle avec leurs combinaisons complètes de paramètres.

        Sous-champs de modes (1)
        • []objectFacultatif
          Sous-champs de [] (9)
          • modestringObligatoire

            Mode d'exécution.

          • presetsarrayObligatoire

            Combinaison complète de paramètres exécutable ; ne formez pas de produit cartésien entre combinaisons.

            Sous-champs de presets (1)
            • []objectFacultatif
              Sous-champs de [] (4)
              • durationintegerFacultatifAutorise null

                Durée en secondes du preset du modèle.

              • resolutionstringFacultatif

                Résolution du preset du modèle.

              • aspect_ratiostringFacultatif

                Rapport d'aspect du preset du modèle.

              • generate_audiobooleanFacultatifAutorise null

                Indique si le preset du modèle génère de l'audio.

          • audio_policystringObligatoire

            Politique du champ audio du mode courant.

          • aspect_policystringObligatoire

            Politique du champ de rapport d'aspect du mode courant.

          • duration_policystringObligatoire

            Politique du champ de durée du mode courant.

          • prompt_max_charsintegerObligatoire

            Nombre maximal de caractères Unicode du prompt pour ce mode.

          • start_frameobjectFacultatif

            Contraintes d'image initiale du mode courant.

            Sous-champs de start_frame (5)
            • requiredbooleanObligatoire

              Indique si ce mode exige cette image.

            • max_bytesintegerObligatoire

              Taille maximale du fichier en octets pour cette image.

            • max_pixelsintegerObligatoire

              Nombre maximal total de pixels de cette image.

            • max_edgeintegerObligatoire

              Nombre maximal de pixels sur un côté de cette image.

            • content_typesarrayObligatoire

              Types MIME d'image autorisés pour cette image.

              Sous-champs de content_types (1)
              • []stringFacultatif
            Branche allOf 1

            Type: object

            Obligatoire dans cette branche : required, max_bytes, max_pixels, max_edge, content_types

            • requiredbooleanObligatoire

              Indique si ce mode exige cette image.

            • max_bytesintegerObligatoire

              Taille maximale du fichier en octets pour cette image.

            • max_pixelsintegerObligatoire

              Nombre maximal total de pixels de cette image.

            • max_edgeintegerObligatoire

              Nombre maximal de pixels sur un côté de cette image.

            • content_typesarrayObligatoire

              Types MIME d'image autorisés pour cette image.

              Sous-champs de content_types (1)
              • []stringFacultatif
          • end_frameobjectFacultatif

            Contraintes d'image finale du mode courant.

            Sous-champs de end_frame (5)
            • requiredbooleanObligatoire

              Indique si ce mode exige cette image.

            • max_bytesintegerObligatoire

              Taille maximale du fichier en octets pour cette image.

            • max_pixelsintegerObligatoire

              Nombre maximal total de pixels de cette image.

            • max_edgeintegerObligatoire

              Nombre maximal de pixels sur un côté de cette image.

            • content_typesarrayObligatoire

              Types MIME d'image autorisés pour cette image.

              Sous-champs de content_types (1)
              • []stringFacultatif
            Branche allOf 1

            Type: object

            Obligatoire dans cette branche : required, max_bytes, max_pixels, max_edge, content_types

            • requiredbooleanObligatoire

              Indique si ce mode exige cette image.

            • max_bytesintegerObligatoire

              Taille maximale du fichier en octets pour cette image.

            • max_pixelsintegerObligatoire

              Nombre maximal total de pixels de cette image.

            • max_edgeintegerObligatoire

              Nombre maximal de pixels sur un côté de cette image.

            • content_typesarrayObligatoire

              Types MIME d'image autorisés pour cette image.

              Sous-champs de content_types (1)
              • []stringFacultatif
          • cancel_policystringFacultatif

            Politique de capacité d'annulation ; une demande ne garantit ni annulation effective ni remboursement.

      • cancel_policystringObligatoire

        Politique de capacité d'annulation ; une demande ne garantit ni annulation effective ni remboursement.

      • pricing_kindsarrayObligatoire

        Modes tarifaires autorisés par ce modèle.

        Sous-champs de pricing_kinds (1)
        • []stringFacultatif
  • workspace_enabledbooleanObligatoire

    Disponibilité des nouvelles tâches dans l'espace actuel ; ne signifie pas que les objets historiques sont supprimés.

  • upload_enabledbooleanObligatoire

    Indique si le service autorise le téléversement de références.

  • file_storage_enabledbooleanObligatoire

    Indique si le service active le stockage de fichiers hébergés.

HTTP 400

Champs ou paramètres de requête invalides.

application/json

Type
object
Champs obligatoires
error

HTTP 401

Key absente, invalide, expirée ou révoquée.

application/json

Type
object
Champs obligatoires
error

HTTP 403

Autorisations IP, compte, modèle ou outil insuffisantes.

application/json

Type
object
Champs obligatoires
error

HTTP 404

Objet/capacité indisponible ou fonctionnalité désactivée.

application/json

Type
object
Champs obligatoires
error

HTTP 409

Conflit d'idempotence/devis, objet non prêt ou encore référencé.

application/json

Type
object
Champs obligatoires
error

HTTP 429

Limitation de débit des requêtes/de la file.

application/json

Type
object
Champs obligatoires
error

HTTP 500

Défaillance interne d'authentification ou de stockage des données.

application/json

Type
object
Champs obligatoires
error

HTTP 503

Service, tarification ou stockage indisponible.

application/json

Type
object
Champs obligatoires
error