Riferimento API
Cerca strumenti eseguibili
/v1/tools/discoverSupporta 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_KEYSchemi di autenticazione: BearerAuth
Richiesta
Corpo della richiesta · application/json
- Tipo
- object
- Campi obbligatori
query- Proprietà aggiuntive
- false
Corpo della richiesta obbligatorio
Risposte ed errori
HTTP 200
Ricerca degli strumenti eseguibili riuscita
application/json
- Tipo
- object
- Campi obbligatori
resultscount
resultsarrayObbligatorioCampi figli di results (1)
[]objectFacoltativoCampi figli di [] (8)
category_idstringObbligatorioIdentificatore della categoria dello strumento.
collection_idstringObbligatorioIdentificatore della raccolta di strumenti.
tagsarrayObbligatorioEtichette di ricerca pubbliche.
Campi figli di tags (1)
[]stringFacoltativo
idstringObbligatorioIdentificatore pubblico dell'oggetto, usato nel relativo percorso dei dettagli.
namestringObbligatorioNome leggibile dall'utente.
descriptionstringObbligatorioDescrizione pubblica dello scopo.
versionstringObbligatorioVersione di contratto, funzionalità o strumento; le esecuzioni usano la versione restituita dal catalogo.
pricingobjectObbligatorioPrezzo pubblico; si applicano i preventivi e le regole di fatturazione attuali.
Campi figli di pricing (9)
schema_versionintegerFacoltativoVersione delle regole di prezzo dello strumento.
ruleunknownFacoltativoValore JSON definito dallo schema o protocollo dello strumento scelto; non presumere campi fissi.
quote_requiredbooleanObbligatorioIndica se una nuova esecuzione richiede prima la conferma del preventivo.
currencystringObbligatorioValuta del preventivo/della contabilità.
unitstringObbligatoriocall: per chiamata o precalcolo sull'input; usage: utilizzo finale. Per il significato preciso consulta mode.
amountstringFacoltativoCon mode=flat, importo costante completo in dollari, incluso zero; input/usage non espongono importi costanti fuorvianti.
price_versionintegerObbligatorioRevisione del prezzo di vendita.
modestringObbligatorioSemantica 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_usagebooleanObbligatorioIndica 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_versionintegerFacoltativoVersione delle regole di prezzo dello strumento.
ruleunknownFacoltativoValore JSON definito dallo schema o protocollo dello strumento scelto; non presumere campi fissi.
quote_requiredbooleanObbligatorioIndica se una nuova esecuzione richiede prima la conferma del preventivo.
currencystringObbligatorioValuta del preventivo/della contabilità.
unitstringObbligatoriocall: per chiamata o precalcolo sull'input; usage: utilizzo finale. Per il significato preciso consulta mode.
amountstringFacoltativoCon mode=flat, importo costante completo in dollari, incluso zero; input/usage non espongono importi costanti fuorvianti.
price_versionintegerObbligatorioRevisione del prezzo di vendita.
modestringObbligatorioSemantica 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_usagebooleanObbligatorioIndica se l'addebito finale richiede utilizzo autorevole, compresi i vincoli della piattaforma; non dedurlo dal solo mode del prezzo di vendita.
countintegerObbligatorio
HTTP 400
Campi o parametri della richiesta non validi.
application/json
- Tipo
- object
- Campi obbligatori
error
errorobjectObbligatorioCampi figli di error (4)
codestringFacoltativomessagestringFacoltativotypestringFacoltativorequest_idstringFacoltativo
HTTP 401
Key assente, non valida, scaduta o revocata.
application/json
- Tipo
- object
- Campi obbligatori
error
errorobjectObbligatorioCampi figli di error (4)
codestringFacoltativomessagestringFacoltativotypestringFacoltativorequest_idstringFacoltativo
HTTP 403
Autorizzazioni IP, account, modello o strumento insufficienti.
application/json
- Tipo
- object
- Campi obbligatori
error
errorobjectObbligatorioCampi figli di error (4)
codestringFacoltativomessagestringFacoltativotypestringFacoltativorequest_idstringFacoltativo
HTTP 404
Oggetto/funzionalità non disponibile o disabilitata.
application/json
- Tipo
- object
- Campi obbligatori
error
errorobjectObbligatorioCampi figli di error (4)
codestringFacoltativomessagestringFacoltativotypestringFacoltativorequest_idstringFacoltativo
HTTP 409
Conflitto di idempotenza/preventivo, oggetto non pronto o ancora referenziato.
application/json
- Tipo
- object
- Campi obbligatori
error
errorobjectObbligatorioCampi figli di error (4)
codestringFacoltativomessagestringFacoltativotypestringFacoltativorequest_idstringFacoltativo
HTTP 429
Limite di frequenza delle richieste/della coda.
application/json
- Tipo
- object
- Campi obbligatori
error
errorobjectObbligatorioCampi figli di error (4)
codestringFacoltativomessagestringFacoltativotypestringFacoltativorequest_idstringFacoltativo
HTTP 500
Errore interno di autenticazione o storage dei dati.
application/json
- Tipo
- object
- Campi obbligatori
error
errorobjectObbligatorioCampi figli di error (4)
codestringFacoltativomessagestringFacoltativotypestringFacoltativorequest_idstringFacoltativo
HTTP 503
Servizio, prezzi o storage non disponibile.
application/json
- Tipo
- object
- Campi obbligatori
error
errorobjectObbligatorioCampi figli di error (4)
codestringFacoltativomessagestringFacoltativotypestringFacoltativorequest_idstringFacoltativo