API-Anfrage
Mit der API-Anfrage-Komponente können Sie Ihre Flows über anpassbare HTTP-Anfragen mit externen APIs verbinden und Antworten verarbeiten.
Komponentenbeschreibung
So funktioniert die API-Anfrage-Komponente
API-Anfrage-Komponente
Die API-Anfrage-Komponente ist ein vielseitiges Werkzeug, das entwickelt wurde, um HTTP-Anfragen innerhalb Ihrer KI-Workflows zu ermöglichen. Sie gestattet es Ihrem Workflow, mit externen APIs oder Webdiensten zu interagieren, indem Anfragen an eine oder mehrere URLs gesendet und die Antworten verarbeitet werden. Diese Fähigkeit ist essenziell für Aufgaben wie das Abrufen von Daten, die Integration von Drittanbieterdiensten oder das Ansprechen benutzerdefinierter Endpunkte im Rahmen automatisierter oder intelligenter Prozesse.
Was macht die Komponente?
Mit dieser Komponente können Sie HTTP-Anfragen (GET, POST, PATCH, PUT) an festgelegte URLs konfigurieren und senden. Sie können die Anfrage anpassen, indem Sie Header, Query-Parameter und einen Request-Body hinzufügen. Außerdem unterstützt sie das Verarbeiten von Formulardaten und das Setzen individueller Timeouts, wodurch sie für eine Vielzahl von API-Interaktionen geeignet ist.
Eingaben
Die API-Anfrage-Komponente unterstützt folgende konfigurierbare Eingaben:
| Feld | Beschreibung | Typ | Standard/Optionen |
|---|---|---|---|
| URL | Geben Sie eine oder mehrere Ziel-URLs ein, getrennt durch Kommas. | String | |
| Methode | HTTP-Methode, die für die Anfrage verwendet wird. | Dropdown | GET, POST, PATCH, PUT |
| Header | Benutzerdefinierte Header, die der Anfrage hinzugefügt werden (als Dictionary). | Dictionary/Daten | |
| Body | Daten-Payload für POST-, PATCH- oder PUT-Anfragen (als Dictionary). | Dictionary/Daten | |
| Query-Parameter | Schlüssel-Wert-Paare, die als URL-Query-Parameter angehängt werden. | Dictionary/Daten | |
| Formulardaten verwenden | Umschalter, um Daten als application/x-www-form-urlencoded zu senden. | Boolean | false |
| Timeout | Zeit (in Sekunden), bis die Anfrage abgebrochen wird. | Integer | 5 |
| Cache-TTL | Wie lange die API-Antwort zwischengespeichert werden soll. „Kein Cache“ deaktiviert das Caching. | Dropdown | Kein Cache, 5 Min, … usw. |
| Verbose | Bei Aktivierung wird eine ausführliche Ausgabe zur Fehlersuche angezeigt. | Boolean | false |
| Werkzeugname | Name für dieses API-Anfrage-Werkzeug (zur Verwendung durch Agents). | String | |
| Werkzeugbeschreibung | Beschreibung, um Agents die Nutzung dieses Werkzeugs zu erläutern. | String (mehrzeilig) |
Ausgaben
Die Komponente erzeugt zwei Hauptausgaben:
| Ausgabename | Typ | Beschreibung |
|---|---|---|
| Daten | Daten | Die Antwortsdaten der API-Anfrage. |
| Werkzeug | Tool | Stellt diese API-Anfrage als „Werkzeug“ für agentenbasierte Workflows bereit. |
Warum diese Komponente verwenden?
- Integration: Verbinden Sie Ihren KI-Workflow mit beliebigen externen APIs oder Webdiensten und erweitern Sie Ihre Prozesse einfach um neue Daten oder Aktionen.
- Flexibilität: Unterstützt mehrere HTTP-Methoden, benutzerdefinierte Header, Bodys und Query-Parameter – geeignet für einfache wie komplexe API-Aufrufe.
- Caching: Optionales Zwischenspeichern von Antworten zur Leistungssteigerung und Reduzierung redundanter API-Calls.
- Formulardaten-Unterstützung: Formkodierte Daten können unkompliziert an geeignete Endpunkte gesendet werden.
- Agentenfreundlich: Definieren Sie Werkzeugnamen und Beschreibungen, sodass die Komponente als Werkzeug in agentenbasierten KI-Workflows genutzt werden kann.
Anwendungsbeispiele
- Abrufen von Echtzeitdaten (z. B. Wetter, Nachrichten, Finanzen) über öffentliche APIs.
- Übermitteln von Informationen an einen Drittanbieterdienst (z. B. CRM, Ticket-System).
- Integration mit benutzerdefinierten Backend-Endpunkten für Datenverarbeitung oder Workflow-Automatisierung.
- Ermöglichen Sie LLM-Agents, externe APIs im Rahmen ihrer Entscheidungsfindung oder Aufgabenausführung aufzurufen.
Zusammenfassung
Die API-Anfrage-Komponente ist ein essenzieller Baustein für jeden KI-Prozess, der mit Webdiensten oder externen Datenquellen interagieren muss. Sie bietet eine umfassende Auswahl an Konfigurationsmöglichkeiten, um unterschiedlichste HTTP-Anfrageszenarien abzudecken, und ihre Ausgaben können direkt genutzt oder als Werkzeug für agentenbasierte KI-Workflows bereitgestellt werden.
Beispiele für Flow-Vorlagen mit der API-Anfrage-Komponente
Um Ihnen den schnellen Einstieg zu erleichtern, haben wir mehrere Beispiel-Flow-Vorlagen vorbereitet, die zeigen, wie die API-Anfrage-Komponente effektiv genutzt wird. Diese Vorlagen präsentieren verschiedene Anwendungsfälle und Best Practices und erleichtern Ihnen das Verständnis und die Implementierung der Komponente in Ihren eigenen Projekten.
Häufig gestellte Fragen
- Was macht die API-Anfrage-Komponente?
Die API-Anfrage-Komponente ermöglicht Ihrem Flow, HTTP-Anfragen (GET, POST, PATCH, PUT) an eine oder mehrere URLs zu senden, sodass Sie sich mit jeder externen API oder jedem Webdienst verbinden können.
- Kann ich die Header und den Body meiner API-Anfragen anpassen?
Ja, Sie können benutzerdefinierte Header und Body-Inhalte hinzufügen, um sie an Ihre Ziel-API anzupassen. Beides kann über Dateneingaben oder Dictionaries festgelegt werden.
- Werden Query-Parameter und verschiedene HTTP-Methoden unterstützt?
Absolut. Sie können Query-Parameter an Ihre URL anhängen und aus verschiedenen HTTP-Methoden wählen, darunter GET, POST, PATCH und PUT.
- Kann ich API-Antworten zwischenspeichern?
Ja, Sie können konfigurieren, wie lange API-Antworten zwischengespeichert werden sollen, oder das Caching vollständig deaktivieren, um Kontrolle über Datenaktualität und Performance zu haben.
- Ist diese Komponente für die Integration mit Drittanbietertools geeignet?
Ja, sie wurde für die nahtlose Integration mit praktisch jedem Drittanbieterdienst entwickelt, der eine API bereitstellt, und ist damit eine zentrale Komponente für Automatisierung und fortgeschrittene Workflows.
Flows mit jeder API verbinden
Fügen Sie Ihren Flows jetzt Echtzeitdaten, Drittanbieterdienste oder benutzerdefinierte Integrationen mit der API-Anfrage hinzu.
Mehr erfahren
