Aller au contenu

Référence des outils

Vue d’ensemble

Chaque outil appelable : son rôle, ses scopes, ses paramètres et un exemple en curl, JavaScript et Python.

Les outils sont rangés par famille, une page chacune. La référence est générée depuis le code de l’API : elle ne peut pas en dériver, et un outil ajouté y apparaît de lui-même.

Les familles d’outils#

Format d’un appel#

POSThttps://piqline.com/api/v1/tools/{nom}

Tous les outils s’appellent de la même façon :

  • Authorization: Bearer piq_live_… et Content-Type: application/json.
  • Un corps JSON : l’entrée de l’outil. Un outil sans paramètre accepte {}.
  • Une réponse 200 de la forme { "tool": "nom", "output": … }.
  • Une erreur en application/problem+json : voir Erreurs.

Les scopes d’une clé, ce qui borne chaque outil et les limites sont dans Authentification. La liste en direct, avec les schémas d’entrée, se lit par GEThttps://piqline.com/api/v1/tools.

Le document OpenAPI décrit les mêmes routes pour un générateur de client.

Une question sur l’API, ou une erreur dans cette page ? Écrivez-nous.