Dokumentation

Benutzerdefinierte API

Rufen Sie externe APIs von Ihrem Agenten aus auf, um Daten abzurufen oder Integrationen auszulösen.

Mit benutzerdefinierten API-Aktionen kann Ihr Agent mit externen Diensten interagieren. Rufen Sie Echtzeitdaten ab, senden Sie Formulare oder lösen Sie Workflows in anderen Tools aus.

Eine benutzerdefinierte API-Aktion erstellen

  1. Gehen Sie zum Tab Aktionen Ihres Agenten
  2. Klicken Sie auf Aktion hinzufügen → Benutzerdefinierte API
  3. Konfigurieren Sie den API-Aufruf:
    • Endpunkt-URL - Der aufzurufende API-Endpunkt
    • HTTP-Methode - GET, POST, PUT, PATCH oder DELETE
    • Header - Authentifizierung und Content-Type
    • Body - Zu sendende Daten (für POST/PUT/PATCH)
  4. Speichern und testen

Konfigurationsoptionen

Endpunkt-URL

Die vollständige URL des API-Endpunkts:

https://api.yourservice.com/v1/data

Verwenden Sie ausschließlich HTTPS-Endpunkte. HTTP-Endpunkte werden aus Sicherheitsgründen blockiert.

HTTP-Methode

MethodeAnwendungsfall
GETDaten vom externen Dienst abrufen
POSTDaten senden, Datensätze erstellen
PUTBestehende Datensätze ersetzen
PATCHBestehende Datensätze teilweise aktualisieren
DELETEDatensätze löschen

Fügen Sie Authentifizierungs- und Content-Header hinzu:

Authorization: Bearer {{SECRET:service_api_key}}
Content-Type: application/json

Erstelle das benannte Geheimnis separat. Agentkit löst {{SECRET:name}} nur auf dem Server auf. Aktionsabfragen und Protokolle enthalten den gespeicherten Wert nicht.

Quelle der Eingabedaten

Wähle für ein einzelnes E-Mail-Textfeld Verifizierte E-Mail, sonst nachfragen. Agentkit verwendet die verifizierte Webkontaktadresse oder die Absenderadresse der eingehenden E-Mail. Anonyme Besucher werden nach der Adresse gefragt. Das Modell kann eine verifizierte Adresse nicht ersetzen.

Body

Definieren Sie für POST/PUT-Anfragen den JSON-Body mit den Daten, die Sie senden möchten.

Wann die API aufgerufen wird

Die KI entscheidet anhand des Unterhaltungskontexts und der Beschreibung der Aktion, wann sie die API aufruft. Sie können dieses Verhalten steuern, indem Sie klar beschreiben, wann die Aktion ausgelöst werden soll.

Antworten verarbeiten

Erfolgreiche Antwort

Wenn die API erfolgreich antwortet (2xx-Status):

  • Eine Erfolgsmeldung für den Besucher anzeigen
  • Antwortdaten in den Chat aufnehmen
  • Folgeaktionen auslösen

Fehlerbehandlung

Wenn die API fehlschlägt:

  • Eine freundliche Fehlermeldung anzeigen
  • Den Fehler für die Fehlersuche protokollieren
  • Die Anfrage optional wiederholen

Anwendungsbeispiele

Bestellstatus prüfen

Konfigurieren Sie einen GET-Endpunkt, um Bestelldaten abzurufen, wenn Besucher nach ihrem Bestellstatus fragen.

An CRM übermitteln

Konfigurieren Sie einen POST-Endpunkt, um Lead-Daten an Ihr CRM-System zu senden.

Echtzeitdaten abrufen

Konfigurieren Sie einen GET-Endpunkt, um Echtzeitdaten (z. B. Verfügbarkeit oder Lagerbestand) aus Ihren Systemen abzurufen.

Sicherheitsaspekte

API-Schlüssel

  • Speichere API-Schlüssel als benannte Geheimnisse und verwende {{SECRET:name}} als Referenz.
  • Verwenden Sie umgebungsspezifische Schlüssel zum Testen
  • Rotieren Sie Schlüssel regelmäßig

Ratenbegrenzung

  • Externe APIs haben unter Umständen Ratenlimits
  • Konfigurieren Sie die Ratenbegrenzung Ihres Agenten entsprechend
  • Überwachen Sie die API-Nutzung in den Logs

Datenschutz

  • Senden Sie nur notwendige Daten
  • Stellen Sie bei Bedarf sicher, dass externe Dienste DSGVO-konform sind
  • Protokollieren Sie keine sensiblen Antwortdaten

Timeout und Wiederholungen

EinstellungStandardHinweise
Timeout20 SekundenAnfrage schlägt fehl, wenn keine Antwort erfolgt
Wiederholungen0Richten Sie Webhook-Wiederholungen für mehr Zuverlässigkeit ein

Ihre API-Aktion testen

  1. Richten Sie die Aktion mit einem Test-Endpunkt ein
  2. Gehen Sie zum Playground
  3. Lösen Sie die Aktion mit einer passenden Eingabe aus
  4. Überprüfen Sie die Antwort im Chat
  5. Prüfen Sie die Logs zur Fehlersuche

Nächste Schritte