Solicitud de API
El componente Solicitud de API te permite conectar tus flujos con APIs externas enviando solicitudes HTTP personalizables y gestionando las respuestas.
Descripción del componente
Cómo funciona el componente Solicitud de API
Componente Solicitud de API
El componente Solicitud de API es una herramienta versátil diseñada para facilitar solicitudes HTTP dentro de tus flujos de trabajo de IA. Permite que tu flujo interactúe con APIs externas o servicios web enviando solicitudes a una o más URLs y procesando las respuestas. Esta capacidad es esencial para tareas como la obtención de datos, integración con servicios de terceros o la invocación de endpoints personalizados como parte de procesos automatizados o inteligentes.
¿Qué hace el componente?
Este componente te permite configurar y enviar solicitudes HTTP (GET, POST, PATCH, PUT) a URLs especificadas. Puedes personalizar la solicitud agregando encabezados, parámetros de consulta y un cuerpo de la solicitud. También soporta el manejo de datos de formulario y la configuración de tiempos de espera personalizados, lo que lo hace adecuado para una amplia gama de interacciones con APIs.
Entradas
El componente Solicitud de API admite las siguientes entradas configurables:
| Campo | Descripción | Tipo | Predeterminado/Opciones |
|---|---|---|---|
| URL | Ingresa una o más URLs de destino, separadas por comas. | Cadena | |
| Método | Método HTTP a utilizar para la solicitud. | Desplegable | GET, POST, PATCH, PUT |
| Encabezados | Encabezados personalizados para incluir en la solicitud (como un diccionario). | Diccionario/Dato | |
| Cuerpo | Datos de carga útil para solicitudes POST, PATCH o PUT (como un diccionario). | Diccionario/Dato | |
| Parámetros de Consulta | Pares clave-valor para añadir como parámetros de consulta en la URL. | Diccionario/Dato | |
| Usar Datos de Formulario | Alternar para enviar datos como application/x-www-form-urlencoded. | Booleano | false |
| Tiempo de Espera | Tiempo (en segundos) antes de que la solicitud expire. | Entero | 5 |
| TTL de Caché | Cuánto tiempo almacenar en caché la respuesta de la API. Selecciona ‘Sin caché’ para desactivar. | Desplegable | Sin caché, 5 min, … etc. |
| Detallado | Si está activado, imprime salida detallada para depuración. | Booleano | false |
| Nombre de la Herramienta | Nombre para esta herramienta de solicitud de API (para uso por agentes). | Cadena | |
| Descripción de la Herramienta | Descripción para ayudar a los agentes a entender cómo usar esta herramienta. | Cadena (multilínea) |
Salidas
El componente produce dos salidas principales:
| Nombre de Salida | Tipo | Descripción |
|---|---|---|
| Datos | Dato | Los datos de respuesta de la solicitud de la API. |
| Herramienta | Herramienta | Hace disponible esta solicitud de API como una “herramienta” para flujos de trabajo basados en agentes. |
¿Por qué usar este componente?
- Integración: Conecta tu flujo de IA con cualquier API externa o servicio web, facilitando la incorporación de nuevos datos o acciones a tus procesos.
- Flexibilidad: Soporta múltiples métodos HTTP, encabezados, cuerpos y parámetros de consulta personalizados—adecuado tanto para llamadas API simples como complejas.
- Caché: Opcionalmente almacena respuestas en caché para mejorar el rendimiento y reducir llamadas redundantes a la API.
- Soporte de Datos de Formulario: Envía fácilmente datos codificados en formulario para endpoints compatibles.
- Compatible con Agentes: Define nombres y descripciones de herramienta para que el componente pueda ser utilizado como herramienta por flujos de trabajo de IA basados en agentes.
Ejemplos de uso
- Obtener datos en tiempo real (por ejemplo, clima, noticias, finanzas) de APIs públicas.
- Enviar información a un servicio de terceros (por ejemplo, CRM, sistema de tickets).
- Integrar con endpoints backend personalizados para procesamiento de datos o automatización de flujos de trabajo.
- Permitir que agentes LLM llamen a APIs externas como parte de su razonamiento o ejecución de tareas.
Resumen
El componente Solicitud de API es un bloque esencial para cualquier proceso de IA que necesite interactuar con servicios web o fuentes de datos externas. Ofrece un conjunto completo de opciones de configuración para gestionar una amplia variedad de escenarios de solicitudes HTTP, y sus salidas pueden usarse directamente o estar disponibles como una herramienta para flujos de trabajo de IA basados en agentes.
Ejemplos de plantillas de flujo utilizando el componente Solicitud de API
Para ayudarle a comenzar rápidamente, hemos preparado varios ejemplos de plantillas de flujo que demuestran cómo utilizar el componente Solicitud de API de manera efectiva. Estas plantillas muestran diferentes casos de uso y mejores prácticas, facilitando la comprensión e implementación del componente en sus propios proyectos.
Preguntas frecuentes
- ¿Qué hace el componente Solicitud de API?
El componente Solicitud de API permite que tu flujo envíe solicitudes HTTP (GET, POST, PATCH, PUT) a una o más URLs, permitiéndote conectar con cualquier API o servicio web externo.
- ¿Puedo personalizar los encabezados y el cuerpo de mis solicitudes API?
Sí, puedes agregar encabezados personalizados y contenido en el cuerpo para adaptarlos a tu API objetivo. Ambos pueden configurarse usando entradas de datos o diccionarios.
- ¿Admite parámetros de consulta y diferentes métodos HTTP?
Absolutamente. Puedes añadir parámetros de consulta a tu URL y elegir entre varios métodos HTTP, incluyendo GET, POST, PATCH y PUT.
- ¿Puedo almacenar en caché las respuestas de la API?
Sí, puedes configurar cuánto tiempo deben almacenarse en caché las respuestas de la API, o desactivar la caché completamente, ofreciendo control sobre la frescura de los datos y el rendimiento.
- ¿Este componente es adecuado para integrar herramientas de terceros?
Sí, está diseñado para una integración fluida con prácticamente cualquier servicio de terceros que exponga una API, lo que lo convierte en un componente clave para la automatización y flujos de trabajo avanzados.
Conecta Flujos con Cualquier API
Comienza a agregar datos en tiempo real, servicios de terceros o integraciones personalizadas a tus flujos usando Solicitud de API.
Saber más
