Dokumentation

API-Referenz

Ausführbare Tools abfragen

GET/v1/tools

Unterstützt einheitlich flat als konstanten Preis pro Aufruf, input als Vorabberechnung anhand der Eingaben und usage anhand der endgültigen Nutzung. pricing.quote_required bestimmt, ob ein Kostenvoranschlag erforderlich ist; requires_usage bestimmt, ob eine Kostenobergrenze und bestätigte endgültige Nutzungsdaten erforderlich sind. Beides wird nicht aus schema_version abgeleitet. Bei deaktiviertem metered_pricing sind nur neue Aufrufe eingeschränkt, die endgültige Nutzungsdaten benötigen; konstante/eingabebasierte Regeln ohne dieses Erfordernis bleiben nutzbar. Der aktuelle Schlüssel benötigt Tool-Berechtigung; Ausführungsidentität und Ergebnisse sind an den ursprünglichen Schlüssel gebunden. Bei deaktiviertem Tool-Hauptschalter ist der Katalog leer; der anonyme Katalog erteilt keine Ausführungsberechtigung.

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

Anfrage

Abfrageparameter

  • cursorstringOptional

    next_cursor aus der ursprünglichen Antwort.

  • limitintegerOptional

    Katalogbereich 1–100, ungültige Werte verwenden 20; Ausführungsliste 1–100, ungültige Werte verwenden 20.

Antworten und Fehler

HTTP 200

Ausführbare Tools erfolgreich abgefragt

application/json

Typ
object
Pflichtfelder
itemsnext_cursor
  • itemsarrayErforderlich
    Unterfelder von items (1)
    • []objectOptional
      Unterfelder von [] (8)
      • category_idstringErforderlich

        Kennung der Tool-Kategorie.

      • collection_idstringErforderlich

        Kennung der Tool-Sammlung.

      • tagsarrayErforderlich

        Öffentliche Such-Tags.

        Unterfelder von tags (1)
        • []stringOptional
      • idstringErforderlich

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

      • namestringErforderlich

        Für Nutzer lesbarer Name.

      • descriptionstringErforderlich

        Öffentliche Zweckbeschreibung.

      • versionstringErforderlich

        Vertrags-/Funktions- oder Tool-Version; Ausführungen verwenden die im Katalog angegebene Tool-Version.

      • pricingobjectErforderlich

        Öffentlicher Preis; aktuelle Kostenvoranschläge und Abrechnungsregeln gelten.

        Unterfelder von pricing (9)
        • schema_versionintegerOptional

          Version der Tool-Preisregeln.

        • ruleunknownOptional

          JSON-Wert gemäß Schema oder Protokoll des gewählten Tools; keine festen Felder annehmen.

        • quote_requiredbooleanErforderlich

          Ob neue Ausführungen zuerst einen Kostenvoranschlag bestätigen müssen.

        • currencystringErforderlich

          Währung des Kostenvoranschlags/der Abrechnung.

        • unitstringErforderlich

          call: pro Aufruf oder vorab nach Eingabe; usage: endgültige Nutzung. Genaue Bedeutung siehe mode.

        • amountstringOptional

          Bei mode=flat vollständiger konstanter Dollarbetrag einschließlich null; input/usage liefern keinen missverständlichen konstanten Betrag.

        • price_versionintegerErforderlich

          Revision des Verkaufspreises.

        • modestringErforderlich

          Preisbedeutung: flat konstant pro Aufruf, input vorab anhand der Eingaben, usage anhand der endgültigen Nutzung. Unabhängig vom Datenformat schema_version.

          Aufzählung
          ["flat","input","usage"]
        • requires_usagebooleanErforderlich

          Ob die endgültige Abrechnung bestätigte Nutzungsdaten erfordert, einschließlich Plattformvorgaben. Nicht allein aus dem Verkaufsmodus mode ableiten.

        allOf-Zweig 1

        Typ: object

        In diesem Zweig erforderlich: currency, unit, price_version, mode, quote_required, requires_usage

        • schema_versionintegerOptional

          Version der Tool-Preisregeln.

        • ruleunknownOptional

          JSON-Wert gemäß Schema oder Protokoll des gewählten Tools; keine festen Felder annehmen.

        • quote_requiredbooleanErforderlich

          Ob neue Ausführungen zuerst einen Kostenvoranschlag bestätigen müssen.

        • currencystringErforderlich

          Währung des Kostenvoranschlags/der Abrechnung.

        • unitstringErforderlich

          call: pro Aufruf oder vorab nach Eingabe; usage: endgültige Nutzung. Genaue Bedeutung siehe mode.

        • amountstringOptional

          Bei mode=flat vollständiger konstanter Dollarbetrag einschließlich null; input/usage liefern keinen missverständlichen konstanten Betrag.

        • price_versionintegerErforderlich

          Revision des Verkaufspreises.

        • modestringErforderlich

          Preisbedeutung: flat konstant pro Aufruf, input vorab anhand der Eingaben, usage anhand der endgültigen Nutzung. Unabhängig vom Datenformat schema_version.

          Aufzählung
          ["flat","input","usage"]
        • requires_usagebooleanErforderlich

          Ob die endgültige Abrechnung bestätigte Nutzungsdaten erfordert, einschließlich Plattformvorgaben. Nicht allein aus dem Verkaufsmodus mode ableiten.

  • next_cursorstringErforderlich

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.