Requisição de API

Requisição de API

O componente Requisição de API permite conectar seus fluxos a APIs externas enviando requisições HTTP personalizáveis e lidando com as respostas.

API Integration Webhooks Automation
Experimente Agora Agendar uma demonstração

Descrição do componente

Como o componente Requisição de API funciona

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.

Exemplos de modelos de fluxo usando o componente Requisição de API

Para ajudá-lo a começar rapidamente, preparamos vários modelos de fluxo de exemplo que demonstram como usar o componente Requisição de API de forma eficaz. Esses modelos apresentam diferentes casos de uso e melhores práticas, tornando mais fácil para você entender e implementar o componente em seus próprios projetos.

Curador de Principais Notícias do Hacker News com IA
Curador de Principais Notícias do Hacker News com IA

Curador de Principais Notícias do Hacker News com IA

Um fluxo automatizado, alimentado por IA, para buscar, resumir e apresentar as principais notícias do Hacker News, incluindo detalhes das histórias, URLs e melh...

5 min de leitura

Perguntas frequentes

O que o componente Requisição de API faz?

O componente Requisição de API permite que seu fluxo envie requisições HTTP (GET, POST, PATCH, PUT) para um ou mais URLs, possibilitando a conexão com qualquer API externa ou serviço web.

Posso personalizar os cabeçalhos e o corpo das minhas requisições de API?

Sim, você pode adicionar cabeçalhos personalizados e conteúdo de corpo conforme necessário para sua API de destino. Ambos podem ser definidos usando entradas de dados ou dicionários.

Ele suporta parâmetros de consulta e diferentes métodos HTTP?

Com certeza. Você pode adicionar parâmetros de consulta à sua URL e escolher entre diversos métodos HTTP, incluindo GET, POST, PATCH e PUT.

Posso armazenar em cache as respostas das APIs?

Sim, você pode configurar por quanto tempo as respostas das APIs devem ser armazenadas em cache, ou desabilitar o cache completamente, oferecendo controle sobre a atualização dos dados e desempenho.

Este componente é adequado para integração com ferramentas de terceiros?

Sim, ele foi projetado para integração perfeita com praticamente qualquer serviço de terceiros que ofereça uma API, tornando-se um componente central para automação e fluxos de trabalho avançados.

Conecte Fluxos a Qualquer API

Comece a adicionar dados em tempo real, serviços de terceiros ou integrações personalizadas aos seus fluxos usando a Requisição de API.

Experimente Agora Agendar uma demonstração