Dokumentation

API-Referenz

Funktionen des Videoarbeitsbereichs abfragen

GET/v1/video-models

Liefert ausführbare presets und Frame-Grenzen je Modus. Nur vollständige preset-Kombinationen verwenden; keine Parameter aus verschiedenen Modi mischen.

Authentifizierung und Berechtigungen

Verwenden Sie Ihren aktuellen GloopAPI-Schlüssel. Verfügbare Modelle, Funktionen und Berechtigungen hängen von seinem Katalog und der Endpunktdokumentation ab.

Authorization: Bearer $GLOOP_API_KEY

Authentifizierungsschemata: BearerAuth

Antworten und Fehler

HTTP 200

Funktionen des Videoarbeitsbereichs erfolgreich abgefragt

application/json

Typ
object
Pflichtfelder
dataworkspace_enabledupload_enabledfile_storage_enabled
  • dataarrayErforderlich

    Datenarray der aktuellen Seite/des Katalogs.

    Unterfelder von data (1)
    • []objectOptional
      Unterfelder von [] (6)
      • idstringErforderlich

        Öffentliche Kennung dieses Objekts für den zugehörigen Detailpfad.

      • namestringErforderlich

        Für Nutzer lesbarer Name.

      • capability_versionstringErforderlich

        Funktionsversion dieses öffentlichen Modells.

      • modesarrayErforderlich

        Ausführbare Modi dieses Modells und ihre vollständigen Parameterkombinationen.

        Unterfelder von modes (1)
        • []objectOptional
          Unterfelder von [] (9)
          • modestringErforderlich

            Ausführungsmodus.

          • presetsarrayErforderlich

            Vollständige ausführbare Parameterkombinationen; kein kartesisches Produkt über verschiedene Kombinationen bilden.

            Unterfelder von presets (1)
            • []objectOptional
              Unterfelder von [] (4)
              • durationintegerOptionalErlaubt null

                Dauer in Sekunden aus dem Modell-preset.

              • resolutionstringOptional

                Auflösungswert aus dem Modell-preset.

              • aspect_ratiostringOptional

                Seitenverhältnis aus dem Modell-preset.

              • generate_audiobooleanOptionalErlaubt null

                Ob dieses Modell-preset Audio generiert.

          • audio_policystringErforderlich

            Richtlinie für das Audiofeld im aktuellen Modus.

          • aspect_policystringErforderlich

            Richtlinie für das Seitenverhältnisfeld im aktuellen Modus.

          • duration_policystringErforderlich

            Richtlinie für das Dauerfeld im aktuellen Modus.

          • prompt_max_charsintegerErforderlich

            Maximale Unicode-Zeichenzahl des Prompts im aktuellen Modus.

          • start_frameobjectOptional

            Vorgaben für den ersten Frame im aktuellen Modus.

            Unterfelder von start_frame (5)
            • requiredbooleanErforderlich

              Ob dieser Modus den Frame erfordert.

            • max_bytesintegerErforderlich

              Maximale Dateigröße in Bytes für diesen Frame.

            • max_pixelsintegerErforderlich

              Maximale Gesamtpixelzahl dieses Frames.

            • max_edgeintegerErforderlich

              Maximale Pixelzahl je Seite dieses Frames.

            • content_typesarrayErforderlich

              Für diesen Frame erlaubte Bild-MIME-Typen.

              Unterfelder von content_types (1)
              • []stringOptional
            allOf-Zweig 1

            Typ: object

            In diesem Zweig erforderlich: required, max_bytes, max_pixels, max_edge, content_types

            • requiredbooleanErforderlich

              Ob dieser Modus den Frame erfordert.

            • max_bytesintegerErforderlich

              Maximale Dateigröße in Bytes für diesen Frame.

            • max_pixelsintegerErforderlich

              Maximale Gesamtpixelzahl dieses Frames.

            • max_edgeintegerErforderlich

              Maximale Pixelzahl je Seite dieses Frames.

            • content_typesarrayErforderlich

              Für diesen Frame erlaubte Bild-MIME-Typen.

              Unterfelder von content_types (1)
              • []stringOptional
          • end_frameobjectOptional

            Vorgaben für den letzten Frame im aktuellen Modus.

            Unterfelder von end_frame (5)
            • requiredbooleanErforderlich

              Ob dieser Modus den Frame erfordert.

            • max_bytesintegerErforderlich

              Maximale Dateigröße in Bytes für diesen Frame.

            • max_pixelsintegerErforderlich

              Maximale Gesamtpixelzahl dieses Frames.

            • max_edgeintegerErforderlich

              Maximale Pixelzahl je Seite dieses Frames.

            • content_typesarrayErforderlich

              Für diesen Frame erlaubte Bild-MIME-Typen.

              Unterfelder von content_types (1)
              • []stringOptional
            allOf-Zweig 1

            Typ: object

            In diesem Zweig erforderlich: required, max_bytes, max_pixels, max_edge, content_types

            • requiredbooleanErforderlich

              Ob dieser Modus den Frame erfordert.

            • max_bytesintegerErforderlich

              Maximale Dateigröße in Bytes für diesen Frame.

            • max_pixelsintegerErforderlich

              Maximale Gesamtpixelzahl dieses Frames.

            • max_edgeintegerErforderlich

              Maximale Pixelzahl je Seite dieses Frames.

            • content_typesarrayErforderlich

              Für diesen Frame erlaubte Bild-MIME-Typen.

              Unterfelder von content_types (1)
              • []stringOptional
          • cancel_policystringOptional

            Richtlinie zur Abbruchfähigkeit; eine Abbruchanfrage garantiert weder erfolgreichen Abbruch noch Erstattung.

      • cancel_policystringErforderlich

        Richtlinie zur Abbruchfähigkeit; eine Abbruchanfrage garantiert weder erfolgreichen Abbruch noch Erstattung.

      • pricing_kindsarrayErforderlich

        Für dieses Modell erlaubte Preismethoden.

        Unterfelder von pricing_kinds (1)
        • []stringOptional
  • workspace_enabledbooleanErforderlich

    Ob neue Aufgaben im aktuellen Arbeitsbereich verfügbar sind; bedeutet nicht, dass historische Objekte gelöscht wurden.

  • upload_enabledbooleanErforderlich

    Ob der Dienst Referenzbild-Uploads aktiviert hat.

  • file_storage_enabledbooleanErforderlich

    Ob der Dienst verwaltete Dateispeicherung aktiviert hat.

HTTP 400

Ungültige Anfragefelder oder Parameter.

application/json

Typ
object
Pflichtfelder
error

HTTP 401

Key fehlt, ist ungültig, abgelaufen oder widerrufen.

application/json

Typ
object
Pflichtfelder
error

HTTP 403

Unzureichende IP-, Konto-, Modell- oder Tool-Berechtigungen.

application/json

Typ
object
Pflichtfelder
error

HTTP 404

Objekt/Funktion nicht verfügbar oder Funktionsschalter deaktiviert.

application/json

Typ
object
Pflichtfelder
error

HTTP 409

Idempotenz-/Kostenvoranschlagskonflikt, Objekt nicht bereit oder noch referenziert.

application/json

Typ
object
Pflichtfelder
error

HTTP 429

Anfrage-/Warteschlangenlimit.

application/json

Typ
object
Pflichtfelder
error

HTTP 500

Interner Authentifizierungs- oder Datenspeicherungsfehler.

application/json

Typ
object
Pflichtfelder
error

HTTP 503

Dienst, Preisberechnung oder Speicherung nicht verfügbar.

application/json

Typ
object
Pflichtfelder
error
Bereit zum Entwickeln? Öffnen Sie Konsole um einen API-Schlüssel zu erstellen, oder durchsuchen Sie Funktionen.