Documentation

Référence API

Obtenir une exécution d'outil

GET/v1/tool-runs/{id}

Prend en charge flat (prix constant par appel), input (précalcul selon l'entrée) et usage (utilisation finale). pricing.quote_required impose ou non un devis ; requires_usage impose ou non un plafond de coût et l'attente de l'utilisation finale faisant autorité ; aucun ne se déduit de schema_version. Si metered_pricing est désactivé, seuls les nouveaux appels nécessitant l'utilisation finale sont limités ; les règles constantes/d'entrée sans cette exigence restent disponibles. La Key actuelle doit être autorisée pour l'outil ; identité d'exécution et résultats sont limités à la Key d'origine. Si l'interrupteur général des outils est désactivé, le catalogue est vide ; le catalogue anonyme ne constitue pas une autorisation d'exécution.

Authentification et autorisations

Utilisez votre clé GloopAPI actuelle. Les modèles, capacités et autorisations disponibles dépendent de son catalogue et de la documentation du point de terminaison.

Authorization: Bearer $GLOOP_API_KEY

Schémas d'authentification : BearerAuth

Requête

Paramètres de chemin

  • idstringObligatoire

    ID d'outil du catalogue ou ID d'exécution initiale, selon l'objet de l'opération.

Réponses et erreurs

HTTP 200

Exécution d'outil obtenue

application/json

Type
object
Champs obligatoires
idtool_idversionstatusoutputbillingresult_expiredcreated_atupdated_at
  • idstringObligatoire

    Identifiant public de l'objet, utilisé dans son chemin de détails.

  • tool_idstringObligatoire

    ID d'outil dans le catalogue exécutable de la Key actuelle.

  • versionstringObligatoire

    Version du contrat, de la capacité ou de l'outil ; les exécutions utilisent la version d'outil du catalogue.

  • statusstringObligatoire

    submitting/running/submission_unknown/succeeded/failed ; submission_unknown signifie soumission inconnue : ne changez pas Idempotency-Key pour répéter.

  • outputunknownObligatoire

    JSON défini par output_schema de l'outil ; ne présumez pas que le résultat existe après expiration.

  • error_codestringFacultatif

    Code d'erreur public utilisable pour choisir une branche de traitement.

  • billingobjectObligatoire

    État comptable indépendant, à ne pas remplacer par l'état de génération.

    Sous-champs de billing (7)
    • review_requiredbooleanFacultatif

      Les preuves comptables nécessitent une révision manuelle.

    • reasonstringFacultatif

      Raison publique de l'indisponibilité de l'action ou de la révision comptable.

    • usageunknownFacultatif

      Valeur JSON définie par le schema ou protocole de l'outil choisi ; ne présumez pas de champs fixes.

    • breakdownunknownFacultatif

      Valeur JSON définie par le schema ou protocole de l'outil choisi ; ne présumez pas de champs fixes.

    • statusstringObligatoire

      État actuel de l'objet ; évaluer séparément comptabilité et sauvegarde.

    • reserved_usdstringObligatoire

      Réservation maximale en dollars, sous forme de chaîne.

    • charged_usdstringObligatoire

      Montant actuellement confirmé en dollars, sous forme de chaîne.

    Branche allOf 1

    Type: object

    Obligatoire dans cette branche : status, reserved_usd, charged_usd

    • review_requiredbooleanFacultatif

      Les preuves comptables nécessitent une révision manuelle.

    • reasonstringFacultatif

      Raison publique de l'indisponibilité de l'action ou de la révision comptable.

    • usageunknownFacultatif

      Valeur JSON définie par le schema ou protocole de l'outil choisi ; ne présumez pas de champs fixes.

    • breakdownunknownFacultatif

      Valeur JSON définie par le schema ou protocole de l'outil choisi ; ne présumez pas de champs fixes.

    • statusstringObligatoire

      État actuel de l'objet ; évaluer séparément comptabilité et sauvegarde.

    • reserved_usdstringObligatoire

      Réservation maximale en dollars, sous forme de chaîne.

    • charged_usdstringObligatoire

      Montant actuellement confirmé en dollars, sous forme de chaîne.

  • result_expiredbooleanObligatoire

    Indique si le résultat a expiré ; comptabilité et idempotence restent conservées.

  • created_atintegerObligatoire

    Date de création en secondes Unix.

  • updated_atintegerObligatoire

    Dernière mise à jour en secondes Unix.

HTTP 400

Champs ou paramètres de requête invalides.

application/json

Type
object
Champs obligatoires
error

HTTP 401

Key absente, invalide, expirée ou révoquée.

application/json

Type
object
Champs obligatoires
error

HTTP 403

Autorisations IP, compte, modèle ou outil insuffisantes.

application/json

Type
object
Champs obligatoires
error

HTTP 404

Objet/capacité indisponible ou fonctionnalité désactivée.

application/json

Type
object
Champs obligatoires
error

HTTP 409

Conflit d'idempotence/devis, objet non prêt ou encore référencé.

application/json

Type
object
Champs obligatoires
error

HTTP 429

Limitation de débit des requêtes/de la file.

application/json

Type
object
Champs obligatoires
error

HTTP 500

Défaillance interne d'authentification ou de stockage des données.

application/json

Type
object
Champs obligatoires
error

HTTP 503

Service, tarification ou stockage indisponible.

application/json

Type
object
Champs obligatoires
error