Requête API

Le composant Requête API vous permet de connecter vos flux à des API externes en envoyant des requêtes HTTP personnalisables et en gérant les réponses.

Requête API

Description du composant

Comment fonctionne le composant Requête API

Composant Requête API

Le composant Requête API est un outil polyvalent conçu pour faciliter les requêtes HTTP au sein de vos flux de travail IA. Il permet à votre flux de travail d’interagir avec des API ou services web externes en envoyant des requêtes vers une ou plusieurs URLs et en traitant les réponses. Cette capacité est essentielle pour des tâches telles que la récupération de données, l’intégration de services tiers, ou l’appel de points de terminaison personnalisés dans le cadre de processus automatisés ou intelligents.

Que fait le composant ?

Ce composant vous permet de configurer et d’envoyer des requêtes HTTP (GET, POST, PATCH, PUT) vers des URLs spécifiées. Vous pouvez personnaliser la requête en ajoutant des en-têtes, des paramètres de requête et un corps de requête. Il prend également en charge la gestion des données de formulaire et la définition de délais d’attente personnalisés, ce qui le rend adapté à un large éventail d’interactions API.

Entrées

Le composant Requête API prend en charge les entrées configurables suivantes :

ChampDescriptionTypePar défaut/Options
URLSaisissez une ou plusieurs URLs cibles, séparées par des virgules.Chaîne
MéthodeMéthode HTTP à utiliser pour la requête.Liste déroulanteGET, POST, PATCH, PUT
En-têtesEn-têtes personnalisés à inclure dans la requête (sous forme de dictionnaire).Dictionnaire/Données
CorpsCharge utile pour les requêtes POST, PATCH ou PUT (sous forme de dictionnaire).Dictionnaire/Données
Paramètres de requêtePaires clé-valeur à ajouter comme paramètres de requête dans l’URL.Dictionnaire/Données
Utiliser données de formulaireBascule pour envoyer les données en application/x-www-form-urlencoded.Booléenfalse
Délai d’attenteTemps (en secondes) avant expiration de la requête.Entier5
Cache TTLDurée de mise en cache de la réponse API. Mettre sur ‘Pas de cache’ pour désactiver.Liste déroulantePas de cache, 5 min, … etc.
VerbeuxSi activé, affiche une sortie détaillée pour le débogage.Booléenfalse
Nom de l’outilNom de cet outil de requête API (pour l’utilisation par les agents).Chaîne
Description de l’outilDescription pour aider les agents à comprendre comment utiliser cet outil.Chaîne (multiligne)

Sorties

Le composant produit deux sorties principales :

Nom de la sortieTypeDescription
DonnéesDonnéesLes données de réponse de la requête API.
OutilOutilRend cette requête API disponible comme “outil” pour les flux de travail pilotés par agent.

Pourquoi utiliser ce composant ?

  • Intégration : Connectez votre flux de travail IA à n’importe quelle API ou service web externe, facilitant l’enrichissement de vos processus avec de nouvelles données ou actions.
  • Flexibilité : Prend en charge plusieurs méthodes HTTP, des en-têtes, corps et paramètres de requête personnalisés—convient aussi bien aux appels API simples que complexes.
  • Mise en cache : Met en cache les réponses pour améliorer les performances et réduire les appels API redondants, si souhaité.
  • Prise en charge des données de formulaire : Soumettez facilement des données encodées pour les points de terminaison compatibles.
  • Conçu pour les agents : Définissez des noms et descriptions d’outils afin que le composant puisse être utilisé comme outil par des flux de travail IA pilotés par agent.

Exemples d’utilisation

  • Récupérer des données en temps réel (par exemple météo, actualités, finance) auprès d’API publiques.
  • Envoyer des informations à un service tiers (par exemple CRM, système de ticketing).
  • Intégrer des points de terminaison backend personnalisés pour le traitement de données ou l’automatisation de flux.
  • Permettre à des agents LLM d’appeler des API externes dans le cadre de leur raisonnement ou de l’exécution de tâches.

Résumé

Le composant Requête API est un élément essentiel pour tout processus IA nécessitant d’interagir avec des services web ou des sources de données externes. Il offre un ensemble complet d’options de configuration pour gérer une grande variété de scénarios de requêtes HTTP, et ses sorties peuvent être utilisées directement ou rendues disponibles comme outil pour des flux de travail IA pilotés par agent.

Exemples de modèles de flux utilisant le composant Requête API

Pour vous aider à démarrer rapidement, nous avons préparé plusieurs exemples de modèles de flux qui démontrent comment utiliser efficacement le composant Requête API. Ces modèles présentent différents cas d'utilisation et meilleures pratiques, facilitant votre compréhension et l'implémentation du composant dans vos propres projets.

Questions fréquemment posées

Que fait le composant Requête API ?

Le composant Requête API permet à votre flux d'envoyer des requêtes HTTP (GET, POST, PATCH, PUT) vers une ou plusieurs URLs, vous permettant de vous connecter à n'importe quelle API externe ou service web.

Puis-je personnaliser les en-têtes et le corps de mes requêtes API ?

Oui, vous pouvez ajouter des en-têtes personnalisés et un contenu de corps adapté à votre API cible. Les deux peuvent être définis à l'aide d'entrées de données ou de dictionnaires.

Prend-il en charge les paramètres de requête et différentes méthodes HTTP ?

Absolument. Vous pouvez ajouter des paramètres de requête à votre URL et choisir parmi diverses méthodes HTTP, y compris GET, POST, PATCH et PUT.

Puis-je mettre en cache les réponses de l’API ?

Oui, vous pouvez configurer la durée de mise en cache des réponses API, ou désactiver complètement la mise en cache, offrant un contrôle sur la fraîcheur des données et les performances.

Ce composant est-il adapté à l'intégration d'outils tiers ?

Oui, il est conçu pour une intégration transparente avec pratiquement tout service tiers exposant une API, ce qui en fait un composant clé pour l'automatisation et les flux de travail avancés.

Connectez vos flux à n'importe quelle API

Commencez à ajouter des données en temps réel, des services tiers ou des intégrations personnalisées à vos flux grâce à la Requête API.

En savoir plus