API-verzoek
Met de API-verzoek-component kun je je flows verbinden met externe API’s door aanpasbare HTTP-verzoeken te versturen en de reacties te verwerken.
Componentbeschrijving
Hoe de API-verzoek-component werkt
API-verzoek-component
De API-verzoek-component is een veelzijdig hulpmiddel, ontworpen om HTTP-verzoeken binnen je AI-workflows te faciliteren. Hiermee kan je workflow communiceren met externe API’s of webservices door verzoeken naar een of meerdere URL’s te sturen en de antwoorden te verwerken. Deze functionaliteit is essentieel voor taken als dataverzameling, integratie met externe diensten of het aanroepen van aangepaste endpoints als onderdeel van geautomatiseerde of intelligente processen.
Wat doet de component?
Met deze component kun je HTTP-verzoeken (GET, POST, PATCH, PUT) configureren en versturen naar opgegeven URL’s. Je kunt het verzoek aanpassen door headers, queryparameters en een request body toe te voegen. Ook ondersteunt het het verwerken van formulierdata en het instellen van aangepaste timeouts, waardoor het geschikt is voor een breed scala aan API-interacties.
Invoer
De API-verzoek-component ondersteunt de volgende configureerbare invoervelden:
| Veld | Omschrijving | Type | Standaard/Opties |
|---|---|---|---|
| URL | Voer een of meerdere doel-URL’s in, gescheiden door komma’s. | String | |
| Methode | HTTP-methode voor het verzoek. | Dropdown | GET, POST, PATCH, PUT |
| Headers | Aangepaste headers om mee te sturen in het verzoek (als woordenboek). | Dictionary/Data | |
| Body | Datapayload voor POST-, PATCH- of PUT-verzoeken (als woordenboek). | Dictionary/Data | |
| Queryparameters | Sleutel-waardeparen die als URL-queryparameters worden toegevoegd. | Dictionary/Data | |
| Formulierdata gebruiken | Schakel in om data te versturen als application/x-www-form-urlencoded. | Boolean | false |
| Timeout | Tijd (in seconden) voordat het verzoek time-out. | Integer | 5 |
| Cache TTL | Hoe lang het API-antwoord wordt gecachet. Zet op ‘Geen cache’ om uit te schakelen. | Dropdown | Geen cache, 5 min, … enz. |
| Verbose | Indien ingeschakeld, wordt uitgebreide output voor debugging getoond. | Boolean | false |
| Toolnaam | Naam voor dit API-verzoek-hulpmiddel (voor gebruik door agents). | String | |
| Toolbeschrijving | Beschrijving om agents te helpen begrijpen hoe dit hulpmiddel te gebruiken. | String (multiline) |
Uitvoer
De component levert twee hoofduitvoerwaarden:
| Uitvoernaam | Type | Omschrijving |
|---|---|---|
| Data | Data | De responsdata van het API-verzoek. |
| Tool | Tool | Maakt dit API-verzoek beschikbaar als “tool” voor agent-gebaseerde workflows. |
Waarom deze component gebruiken?
- Integratie: Verbind je AI-workflow met elke externe API of webservice, zodat je processen eenvoudig kunt verrijken met nieuwe data of acties.
- Flexibiliteit: Ondersteunt meerdere HTTP-methoden, aangepaste headers, bodies en queryparameters—geschikt voor zowel eenvoudige als complexe API-aanroepen.
- Caching: Kan optioneel antwoorden cachen voor betere prestaties en minder overbodige API-aanroepen.
- Ondersteuning voor formulierdata: Verstuur eenvoudig form-gecodeerde data naar compatibele endpoints.
- Agent-vriendelijk: Definieer toolnamen en beschrijvingen zodat de component als tool bruikbaar is in agent-gebaseerde AI-workflows.
Voorbeeldtoepassingen
- Real-time data ophalen (bijvoorbeeld weer, nieuws, financiën) van publieke API’s.
- Informatie versturen naar een externe dienst (bijvoorbeeld CRM, ticketingsysteem).
- Integreren met aangepaste backend endpoints voor dataverwerking of workflowautomatisering.
- LLM-agents in staat stellen externe API’s aan te roepen als onderdeel van hun redenering of taakuitvoering.
Samenvatting
De API-verzoek-component is een essentieel bouwblok voor elk AI-proces dat moet communiceren met webservices of externe databronnen. Het biedt een uitgebreide set configuratie-opties om een grote verscheidenheid aan HTTP-verzoekscenario’s te verwerken, en de uitvoer ervan kan direct gebruikt worden of beschikbaar worden gesteld als tool voor agent-gebaseerde AI-workflows.
Voorbeelden van flowsjablonen met API-verzoek-component
Om u snel op weg te helpen, hebben we verschillende voorbeeld-flowsjablonen voorbereid die laten zien hoe u de API-verzoek-component effectief kunt gebruiken. Deze sjablonen tonen verschillende gebruikscases en best practices, waardoor het voor u gemakkelijker wordt om de component te begrijpen en te implementeren in uw eigen projecten.
Veelgestelde vragen
- Wat doet de API-verzoek-component?
De API-verzoek-component stelt je flow in staat om HTTP-verzoeken (GET, POST, PATCH, PUT) naar een of meerdere URL's te sturen, zodat je verbinding kunt maken met elke externe API of webservice.
- Kan ik de headers en body van mijn API-verzoeken aanpassen?
Ja, je kunt aangepaste headers en body-inhoud toevoegen om aan te sluiten op je gewenste API. Beide kunnen worden ingesteld via datainvoer of woordenboeken.
- Worden queryparameters en verschillende HTTP-methoden ondersteund?
Absoluut. Je kunt queryparameters aan je URL toevoegen en kiezen uit verschillende HTTP-methoden, waaronder GET, POST, PATCH en PUT.
- Kan ik API-antwoorden cachen?
Ja, je kunt instellen hoe lang API-antwoorden worden gecachet of caching volledig uitschakelen, zodat je controle hebt over de actualiteit en prestaties van data.
- Is deze component geschikt voor integratie met externe tools?
Ja, het is ontworpen voor naadloze integratie met vrijwel elke externe service die een API aanbiedt, waardoor het een kerncomponent is voor automatisering en geavanceerde workflows.
Verbind Flows met Elke API
Begin met het toevoegen van real-time data, externe diensten of aangepaste integraties aan je flows met behulp van API-verzoek.
Meer informatie
