Documentazione

Riferimento API

Elenca strumenti eseguibili

GET/v1/tools

Supporta flat (prezzo costante per chiamata), input (precalcolo sugli input) e usage (utilizzo finale). pricing.quote_required determina l'obbligo di preventivo; requires_usage determina l'obbligo di limite di costo e attesa dell'utilizzo finale autorevole; nessuno dei due si deduce da schema_version. Se metered_pricing è disabilitato, sono limitate solo nuove chiamate che richiedono utilizzo finale; regole costanti/input senza tale requisito restano disponibili. La Key corrente deve avere autorizzazione per lo strumento; identità e risultati dell'esecuzione sono vincolati alla Key originale. Se gli strumenti sono globalmente disabilitati, il catalogo è vuoto; quello anonimo non autorizza l'esecuzione.

Autenticazione e autorizzazioni

Usa la chiave GloopAPI corrente. Modelli, funzionalità e autorizzazioni disponibili dipendono dal relativo catalogo e dalla documentazione dell'endpoint.

Authorization: Bearer $GLOOP_API_KEY

Schemi di autenticazione: BearerAuth

Richiesta

Parametri di query

  • cursorstringFacoltativo

    next_cursor della risposta originale.

  • limitintegerFacoltativo

    Catalogo: 1–100, altrimenti 20; elenco esecuzioni: 1–100, altrimenti 20.

Risposte ed errori

HTTP 200

Strumenti eseguibili ottenuti

application/json

Tipo
object
Campi obbligatori
itemsnext_cursor
  • itemsarrayObbligatorio
    Campi figli di items (1)
    • []objectFacoltativo
      Campi figli di [] (8)
      • category_idstringObbligatorio

        Identificatore della categoria dello strumento.

      • collection_idstringObbligatorio

        Identificatore della raccolta di strumenti.

      • tagsarrayObbligatorio

        Etichette di ricerca pubbliche.

        Campi figli di tags (1)
        • []stringFacoltativo
      • idstringObbligatorio

        Identificatore pubblico dell'oggetto, usato nel relativo percorso dei dettagli.

      • namestringObbligatorio

        Nome leggibile dall'utente.

      • descriptionstringObbligatorio

        Descrizione pubblica dello scopo.

      • versionstringObbligatorio

        Versione di contratto, funzionalità o strumento; le esecuzioni usano la versione restituita dal catalogo.

      • pricingobjectObbligatorio

        Prezzo pubblico; si applicano i preventivi e le regole di fatturazione attuali.

        Campi figli di pricing (9)
        • schema_versionintegerFacoltativo

          Versione delle regole di prezzo dello strumento.

        • ruleunknownFacoltativo

          Valore JSON definito dallo schema o protocollo dello strumento scelto; non presumere campi fissi.

        • quote_requiredbooleanObbligatorio

          Indica se una nuova esecuzione richiede prima la conferma del preventivo.

        • currencystringObbligatorio

          Valuta del preventivo/della contabilità.

        • unitstringObbligatorio

          call: per chiamata o precalcolo sull'input; usage: utilizzo finale. Per il significato preciso consulta mode.

        • amountstringFacoltativo

          Con mode=flat, importo costante completo in dollari, incluso zero; input/usage non espongono importi costanti fuorvianti.

        • price_versionintegerObbligatorio

          Revisione del prezzo di vendita.

        • modestringObbligatorio

          Semantica del prezzo di vendita: flat costante per chiamata, input precalcolo sugli input, usage sull'utilizzo finale. Indipendente dal formato schema_version.

          Enumerazione
          ["flat","input","usage"]
        • requires_usagebooleanObbligatorio

          Indica se l'addebito finale richiede utilizzo autorevole, compresi i vincoli della piattaforma; non dedurlo dal solo mode del prezzo di vendita.

        Ramo allOf 1

        Tipo: object

        Obbligatorio in questo ramo: currency, unit, price_version, mode, quote_required, requires_usage

        • schema_versionintegerFacoltativo

          Versione delle regole di prezzo dello strumento.

        • ruleunknownFacoltativo

          Valore JSON definito dallo schema o protocollo dello strumento scelto; non presumere campi fissi.

        • quote_requiredbooleanObbligatorio

          Indica se una nuova esecuzione richiede prima la conferma del preventivo.

        • currencystringObbligatorio

          Valuta del preventivo/della contabilità.

        • unitstringObbligatorio

          call: per chiamata o precalcolo sull'input; usage: utilizzo finale. Per il significato preciso consulta mode.

        • amountstringFacoltativo

          Con mode=flat, importo costante completo in dollari, incluso zero; input/usage non espongono importi costanti fuorvianti.

        • price_versionintegerObbligatorio

          Revisione del prezzo di vendita.

        • modestringObbligatorio

          Semantica del prezzo di vendita: flat costante per chiamata, input precalcolo sugli input, usage sull'utilizzo finale. Indipendente dal formato schema_version.

          Enumerazione
          ["flat","input","usage"]
        • requires_usagebooleanObbligatorio

          Indica se l'addebito finale richiede utilizzo autorevole, compresi i vincoli della piattaforma; non dedurlo dal solo mode del prezzo di vendita.

  • next_cursorstringObbligatorio

HTTP 400

Campi o parametri della richiesta non validi.

application/json

Tipo
object
Campi obbligatori
error

HTTP 401

Key assente, non valida, scaduta o revocata.

application/json

Tipo
object
Campi obbligatori
error

HTTP 403

Autorizzazioni IP, account, modello o strumento insufficienti.

application/json

Tipo
object
Campi obbligatori
error

HTTP 404

Oggetto/funzionalità non disponibile o disabilitata.

application/json

Tipo
object
Campi obbligatori
error

HTTP 409

Conflitto di idempotenza/preventivo, oggetto non pronto o ancora referenziato.

application/json

Tipo
object
Campi obbligatori
error

HTTP 429

Limite di frequenza delle richieste/della coda.

application/json

Tipo
object
Campi obbligatori
error

HTTP 500

Errore interno di autenticazione o storage dei dati.

application/json

Tipo
object
Campi obbligatori
error

HTTP 503

Servizio, prezzi o storage non disponibile.

application/json

Tipo
object
Campi obbligatori
error