💡
API-Aktionen erfordern technisches Verständnis für die Einrichtung von Servern oder Schnittstellen.
API-Aktionen ermöglichen es Ihnen, externe Systeme und Services mit Ihren Workflows zu verbinden, indem Sie HTTP-Anfragen an deren Endpunkte senden. Sie ermöglichen es Ihnen, Daten programmatisch an Drittanbieter-Anwendungen, Datenbanken oder eigene Server zu senden oder von diesen abzurufen. Sie können die Anfragemethode (GET, PATCH, POST, PUT, DELETE), Header, Authentifizierung und Body-Parameter entsprechend den Anforderungen der API konfigurieren. API-Aktionen sind besonders nützlich, wenn keine MCP-Integration verfügbar ist oder wenn Sie direkte Kontrolle über die HTTP-Kommunikation benötigen. Einmal konfiguriert, können diese Aktionen automatisch innerhalb Ihrer Workflows oder durch KI-Agenten ausgelöst werden, um Aufgaben zu automatisieren und Daten plattformübergreifend zu synchronisieren.
⚠️
Hinweise!
Die Qualität Ihrer Daten ist wirklich wichtig! Wenn Sie der KI qualitativ minderwertige Informationen zur Verfügung stellen, erhalten Sie auch minderwertige Ergebnisse zurück (nach dem Prinzip „garbage in, garbage out”)
Jedes KI-Modell arbeitet mit Context Limits, also einer Limitierung der Datenmenge, die es von externen Systemen z.B. per API oder über einen MCP Server zur Verfügung gestellt wird.
Um die bestmögliche Antwortqualität zu erhalten, ist es essentiell, die Informationen so stark wie möglich vorzufiltern. Das Ziel ist, dass das KI-Modell ausschließlich exakt die Informationen erhält, die für die Beantwortung genau dieser einen Nachricht benötigt werden.
Ansonsten wird das KI-Modell mit ungefilterten Informationen, und damit auch einer unnötig großen Datenmenge “vollgeladen”, in der Hoffnung, dass die KI daraus eine sinnvolle Antwort erstellt, und das möglichst auch noch rasend schnell. Dies ist nicht realistisch.
Nutzen Sie daher bestmöglich die Übergabemöglichkeiten von Parametern sowohl auf Basis der Eingaben des Kontakts, als auch bei der Rückgabe von Daten per API.
Geben Sie Ihrer API-Aktion einen internen Namen und versehen Sie Ihren KI-Agenten mit Anweisungen, wann diese Aktion ausgelöst werden soll.
Fügen Sie die vorgesehene Endpunkt-URL und Methode hinzu.
Konfigurieren Sie Header, Body und Platzhalter, falls erforderlich.
Image without caption
💡
Beachten Sie, dass Sie Ihre neue API-Aktion für jeden AI Agent aktivieren müssen, der darauf Zugriff haben soll – im Tab „Actions" auf der Einrichtungsseite Ihres AI Agents.

Wie filtere ich die Antwort einer API-Aktion?

Je weniger Daten Ihr AI Agent aus einer Antwort erhält, desto besser antwortet er. Liefert Ihre API JSON, kürzen Sie die Antwort deshalb schon in der Aktion: Wählen Sie unter „Erweiterte Response-Verarbeitung“ die Option „JSON“ aus und tragen Sie im Feld „JSON-Filtering mit JMESPath“ einen JMESPath-Ausdruck ein, z.B. `data.items[0].name`. Ihr AI Agent erhält dann nur das Ergebnis dieses Ausdrucks.
Image without caption
Liefert Ihre API Termine, Öffnungszeiten oder andere Einträge mit Datum, helfen zwei zusätzliche Funktionen, vergangene Einträge auszusortieren, bevor Ihr AI Agent sie sieht:
  • `today()`: das heutige Datum in der Zeitzone Ihrer Organisation, im Format `YYYY-MM-DD`. `items[?date >= today()]` behält nur Einträge ab heute.
  • `to_date()`: wandelt gängige Datumsformate wie `2027-01-08`, `08.01.2027` oder `8 Jan 2027` in dasselbe Format um. `items[?to_date(date) >= today()]` funktioniert daher mit den meisten gängigen Datumsformaten. Die Ausnahmen stehen im nächsten Absatz.
Datumswerte werden als Text verglichen. Ein Vergleich mit `today()` ohne `to_date()` funktioniert deshalb nur, wenn Ihre API bereits `YYYY-MM-DD` liefert. Werte, die `to_date()` nicht lesen kann, etwa ausgeschriebene deutsche Monatsnamen wie „8. Januar 2027“ oder Unix-Zeitstempel, fallen aus dem Ergebnis heraus. Mehrdeutige Angaben wie `03/04/2027` werden Tag vor Monat gelesen, also als 3. April.

Beispielkonfigurationen

BeispielkonfigurationenBeispielkonfigurationen

Praxistipps

bestmögliche Reduzierung von Daten, die durch API Actions an Lime Connect übergeben werden
Jedes KI-Modell hat technisch bedingte Context Limits. Hierbei handelt es sich um eine Limitierung der Daten- bzw. Informationsmenge, die das Modell in einer Anfrage insgesamt maximal verarbeiten kann.
Auch wenn die Context Limits in der Theorie zum Teil vermeintlich viele Informationen zulassen, nimmt die Antwortqualität in der Praxis mit steigender Datenmenge oft deutlich ab.
Um die bestmögliche Antwortqualität zu erhalten, ist es daher essentiell, die Informationen so stark wie möglich vorzufiltern. Das Ziel ist, dass das KI-Modell ausschließlich exakt die Informationen erhält, die für die Beantwortung genau dieser einen Frage benötigt werden.
Wird eine solche Filterung nicht vorgenommen, wird das KI-Modell mit einer unnötig großen Datenmenge “ertränkt", was die Qualität der Antworten wie erwähnt deutlich senkt