Documentazione

Riferimento API

Ottieni un'esecuzione dello strumento

GET/v1/tool-runs/{id}

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 del percorso

  • idstringObbligatorio

    ID dello strumento del catalogo o dell'esecuzione originale, secondo l'oggetto dell'operazione.

Risposte ed errori

HTTP 200

Esecuzione dello strumento ottenuta

application/json

Tipo
object
Campi obbligatori
idtool_idversionstatusoutputbillingresult_expiredcreated_atupdated_at
  • idstringObbligatorio

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

  • tool_idstringObbligatorio

    ID dello strumento nel catalogo eseguibile della Key corrente.

  • versionstringObbligatorio

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

  • statusstringObbligatorio

    submitting/running/submission_unknown/succeeded/failed; submission_unknown indica invio dall'esito sconosciuto: non cambiare Idempotency-Key per ripetere.

  • outputunknownObbligatorio

    JSON definito da output_schema dello strumento; non presumere che il risultato esista dopo la scadenza.

  • error_codestringFacoltativo

    Codice errore pubblico utilizzabile per scegliere il ramo di gestione.

  • billingobjectObbligatorio

    Stato contabile indipendente, da non sostituire con quello di generazione.

    Campi figli di billing (7)
    • review_requiredbooleanFacoltativo

      Le prove contabili richiedono revisione manuale.

    • reasonstringFacoltativo

      Motivo pubblico dell'azione non disponibile o della revisione contabile.

    • usageunknownFacoltativo

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

    • breakdownunknownFacoltativo

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

    • statusstringObbligatorio

      Stato attuale dell'oggetto; valutare separatamente contabilità e salvataggio.

    • reserved_usdstringObbligatorio

      Prenotazione massima in dollari, come stringa.

    • charged_usdstringObbligatorio

      Importo attualmente confermato in dollari, come stringa.

    Ramo allOf 1

    Tipo: object

    Obbligatorio in questo ramo: status, reserved_usd, charged_usd

    • review_requiredbooleanFacoltativo

      Le prove contabili richiedono revisione manuale.

    • reasonstringFacoltativo

      Motivo pubblico dell'azione non disponibile o della revisione contabile.

    • usageunknownFacoltativo

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

    • breakdownunknownFacoltativo

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

    • statusstringObbligatorio

      Stato attuale dell'oggetto; valutare separatamente contabilità e salvataggio.

    • reserved_usdstringObbligatorio

      Prenotazione massima in dollari, come stringa.

    • charged_usdstringObbligatorio

      Importo attualmente confermato in dollari, come stringa.

  • result_expiredbooleanObbligatorio

    Indica se il risultato è scaduto; contabilità e idempotenza restano conservate.

  • created_atintegerObbligatorio

    Ora di creazione in secondi Unix.

  • updated_atintegerObbligatorio

    Ultimo aggiornamento in secondi Unix.

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