Requête API

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.

API Integration Webhooks Automation
Essayez-le maintenant Réserver une démo

Description du composant

Comment fonctionne le composant Requête API

The API Request component is a versatile tool designed to facilitate HTTP requests within your AI workflows. It enables your workflow to interact with external APIs or web services by sending requests to one or more URLs and processing the responses. This capability is essential for tasks such as data retrieval, integration with third-party services, or invoking custom endpoints as part of automated or intelligent processes.

What Does the Component Do?

This component allows you to configure and send HTTP requests (GET, POST, PATCH, PUT) to specified URLs. You can customize the request by adding headers, query parameters, and a request body. It also supports handling form data and setting custom timeouts, making it suitable for a wide range of API interactions.

Inputs

The API Request component supports the following configurable inputs:

FieldDescriptionTypeDefault/Options
URLEnter one or more target URLs, separated by commas.String
MethodHTTP method to use for the request.DropdownGET, POST, PATCH, PUT
HeadersCustom headers to include in the request (as a dictionary).Dictionary/Data
BodyData payload for POST, PATCH, or PUT requests (as a dictionary).Dictionary/Data
Query ParametersKey-value pairs to append as URL query parameters.Dictionary/Data
Use Form DataToggle to send data as application/x-www-form-urlencoded.Booleanfalse
TimeoutTime (in seconds) before the request times out.Integer5
Cache TTLHow long to cache the API response. Set to ‘No cache’ to disable.DropdownNo cache, 5 min, … etc.
VerboseIf enabled, prints verbose output for debugging.Booleanfalse
Tool NameName for this API request tool (for use by agents).String
Tool DescriptionDescription to help agents understand how to use this tool.String (multiline)

Outputs

The component produces two main outputs:

Output NameTypeDescription
DataDataThe response data from the API request.
ToolToolMakes this API request available as a “tool” for agent-based workflows.

Why Use This Component?

  • Integration: Connect your AI workflow to any external API or web service, making it easy to augment your processes with new data or actions.
  • Flexibility: Supports multiple HTTP methods, custom headers, bodies, and query parameters—suitable for simple and complex API calls alike.
  • Caching: Optionally caches responses to improve performance and reduce redundant API calls.
  • Form Data Support: Easily submit form-encoded data for compatible endpoints.
  • Agent-Friendly: Define tool names and descriptions so the component can be used as a tool by agent-based AI workflows.

Example Use Cases

  • Retrieve real-time data (e.g., weather, news, finance) from public APIs.
  • Submit information to a third-party service (e.g., CRM, ticketing system).
  • Integrate with custom backend endpoints for data processing or workflow automation.
  • Enable LLM agents to call external APIs as part of their reasoning or task execution.

Summary

The API Request component is an essential building block for any AI process that needs to interact with web services or external data sources. It offers a comprehensive set of configuration options to handle a wide variety of HTTP request scenarios, and its outputs can be used directly or made available as a tool for agent-based AI workflows.

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.

Agent de support client IA pour LiveAgent
Agent de support client IA pour LiveAgent

Agent de support client IA pour LiveAgent

Ce flux de travail automatise le support client pour votre entreprise en intégrant les conversations LiveAgent, en extrayant les données pertinentes des convers...

6 min de lecture

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.

Essayez-le maintenant Réserver une démo