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.
Descrição do componente
Como o componente Requisição de API funciona
Componente de Requisição de API
O componente de Requisição de API é uma ferramenta versátil projetada para facilitar requisições HTTP dentro dos seus fluxos de trabalho de IA. Ele permite que seu fluxo interaja com APIs externas ou serviços web enviando requisições para um ou mais URLs e processando as respostas. Essa capacidade é essencial para tarefas como obtenção de dados, integração com serviços de terceiros ou invocação de endpoints personalizados como parte de processos automatizados ou inteligentes.
O que o Componente Faz?
Esse componente permite configurar e enviar requisições HTTP (GET, POST, PATCH, PUT) para URLs especificados. Você pode personalizar a requisição adicionando cabeçalhos, parâmetros de consulta e um corpo de requisição. Também oferece suporte a dados de formulário e definição de timeouts personalizados, tornando-o adequado para uma ampla variedade de interações com APIs.
Entradas
O componente Requisição de API suporta as seguintes entradas configuráveis:
| Campo | Descrição | Tipo | Padrão/Opções |
|---|---|---|---|
| URL | Insira um ou mais URLs de destino, separados por vírgula. | String | |
| Método | Método HTTP a ser usado na requisição. | Dropdown | GET, POST, PATCH, PUT |
| Cabeçalhos | Cabeçalhos personalizados para incluir na requisição (como um dicionário). | Dicionário/Dados | |
| Corpo | Dados para requisições POST, PATCH ou PUT (como um dicionário). | Dicionário/Dados | |
| Parâmetros de Consulta | Pares chave-valor para adicionar como parâmetros de consulta na URL. | Dicionário/Dados | |
| Usar Dados de Formulário | Alternar para enviar dados como application/x-www-form-urlencoded. | Booleano | false |
| Timeout | Tempo (em segundos) antes do tempo limite da requisição. | Inteiro | 5 |
| Cache TTL | Por quanto tempo armazenar em cache a resposta da API. Defina como ‘Sem cache’ para desabilitar. | Dropdown | Sem cache, 5 min, … etc. |
| Verbose | Se ativado, exibe saída detalhada para depuração. | Booleano | false |
| Nome da Ferramenta | Nome para esta ferramenta de requisição de API (para uso por agentes). | String | |
| Descrição da Ferramenta | Descrição para ajudar agentes a entender como usar esta ferramenta. | String (multilinha) |
Saídas
O componente produz duas saídas principais:
| Nome da Saída | Tipo | Descrição |
|---|---|---|
| Dados | Dados | Os dados de resposta da requisição de API. |
| Ferramenta | Ferramenta | Disponibiliza esta requisição de API como uma “ferramenta” para fluxos baseados em agentes. |
Por que Usar este Componente?
- Integração: Conecte seu fluxo de IA a qualquer API externa ou serviço web, facilitando a ampliação dos seus processos com novos dados ou ações.
- Flexibilidade: Suporta múltiplos métodos HTTP, cabeçalhos, corpos e parâmetros de consulta personalizados—adequado tanto para chamadas de API simples quanto complexas.
- Cache: Opcionalmente armazena respostas em cache para melhorar a performance e reduzir chamadas redundantes à API.
- Suporte a Dados de Formulário: Envie facilmente dados codificados em formulário para endpoints compatíveis.
- Amigável para Agentes: Defina nomes e descrições de ferramentas para que o componente possa ser usado como ferramenta por fluxos de IA baseados em agentes.
Exemplos de Uso
- Obter dados em tempo real (por exemplo, clima, notícias, finanças) de APIs públicas.
- Enviar informações para um serviço de terceiros (por exemplo, CRM, sistema de tickets).
- Integrar-se a endpoints de backend personalizados para processamento de dados ou automação de fluxos de trabalho.
- Permitir que agentes LLM acessem APIs externas como parte do seu raciocínio ou execução de tarefas.
Resumo
O componente de Requisição de API é um bloco fundamental para qualquer processo de IA que precise interagir com serviços web ou fontes externas de dados. Ele oferece um conjunto abrangente de opções de configuração para lidar com diversos cenários de requisições HTTP, e suas saídas podem ser usadas diretamente ou disponibilizadas como ferramenta para fluxos de IA baseados em agentes.
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.
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.
Saiba mais
