Documentation

Référence API

Obtenir le contrat d'un outil

GET/v1/tools/{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.

Paramètres de requête

  • versionstringFacultatif

    Si omis, current version ; la création d'exécution doit préciser la version du catalogue.

Réponses et erreurs

HTTP 200

Contrat de l'outil obtenu

application/json

Type
object
Champs obligatoires
category_idcollection_idtagsidnamedescriptionversionpricinginput_schemaoutput_schemaread_only
  • category_idstringObligatoire

    Identifiant de catégorie d'outil.

  • collection_idstringObligatoire

    Identifiant de collection d'outils.

  • tagsarrayObligatoire

    Étiquettes de recherche publiques.

    Sous-champs de tags (1)
    • []stringFacultatif
  • idstringObligatoire

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

  • namestringObligatoire

    Nom lisible par l'utilisateur.

  • descriptionstringObligatoire

    Description publique de l'usage.

  • versionstringObligatoire

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

  • pricingobjectObligatoire

    Prix public ; les devis et règles de facturation en vigueur s’appliquent.

    Sous-champs de pricing (9)
    • schema_versionintegerFacultatif

      Version des règles tarifaires de l'outil.

    • ruleunknownFacultatif

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

    • quote_requiredbooleanObligatoire

      Indique si une nouvelle exécution exige d'abord la confirmation d'un devis.

    • currencystringObligatoire

      Devise du devis/de la comptabilité.

    • unitstringObligatoire

      call : par appel ou précalcul selon l'entrée ; usage : utilisation finale. Voir mode pour le sens précis.

    • amountstringFacultatif

      Avec mode=flat, montant constant complet en dollars, y compris zéro ; input/usage n'exposent pas de montant constant trompeur.

    • price_versionintegerObligatoire

      Révision du prix de vente.

    • modestringObligatoire

      Sémantique du prix de vente : flat constant par appel, input précalcul selon entrées, usage selon utilisation finale. Indépendante du format schema_version.

      Énumération
      ["flat","input","usage"]
    • requires_usagebooleanObligatoire

      Indique si le règlement final nécessite une utilisation faisant autorité, y compris les contraintes de plateforme ; ne pas le déduire du seul mode de prix de vente.

    Branche allOf 1

    Type: object

    Obligatoire dans cette branche : currency, unit, price_version, mode, quote_required, requires_usage

    • schema_versionintegerFacultatif

      Version des règles tarifaires de l'outil.

    • ruleunknownFacultatif

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

    • quote_requiredbooleanObligatoire

      Indique si une nouvelle exécution exige d'abord la confirmation d'un devis.

    • currencystringObligatoire

      Devise du devis/de la comptabilité.

    • unitstringObligatoire

      call : par appel ou précalcul selon l'entrée ; usage : utilisation finale. Voir mode pour le sens précis.

    • amountstringFacultatif

      Avec mode=flat, montant constant complet en dollars, y compris zéro ; input/usage n'exposent pas de montant constant trompeur.

    • price_versionintegerObligatoire

      Révision du prix de vente.

    • modestringObligatoire

      Sémantique du prix de vente : flat constant par appel, input précalcul selon entrées, usage selon utilisation finale. Indépendante du format schema_version.

      Énumération
      ["flat","input","usage"]
    • requires_usagebooleanObligatoire

      Indique si le règlement final nécessite une utilisation faisant autorité, y compris les contraintes de plateforme ; ne pas le déduire du seul mode de prix de vente.

  • input_schemaunknownObligatoire

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

  • output_schemaunknownObligatoire

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

  • read_onlybooleanObligatoire

    Propriété de lecture seule déclarée dans le contrat public, sans garantie d'accès sans autorisation ni de gratuité.

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