Zum Hauptinhalt springen
POST
/
api
/
user
/
ai
/
generate-reply
KI-Antwort generieren
curl --request POST \
  --url https://app.famulor.de/api/user/ai/generate-reply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistant_id": 123,
  "customer_identifier": "<string>",
  "message": "<string>"
}
'
{
  "success": true,
  "conversation_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "customer_identifier": "+14155551234",
  "reply": "Hi John! I'd be happy to help you schedule an appointment. What day and time work best for you?",
  "function_calls": [],
  "ai_disabled": false
}
Dieser Endpunkt erzeugt automatisch eine intelligente Antwort auf eine Kundennachricht mithilfe Ihres konfigurierten KI-Assistenten. Das System verwaltet dabei automatisch den Gesprächskontext für jeden Kunden, sodass der Assistent sich an vorherige Nachrichten erinnert und kontextbezogen antworten kann. Ideal für die Integration in externe Messaging-Plattformen, CRMs oder eigene Chat-Oberflächen.
Rate Limit: Dieser Endpunkt ist auf 5 Anfragen pro Minute pro API-Token begrenzt, um Missbrauch zu verhindern.

​
Request Body

​
assistant_id
integer
erforderlich
Die ID des Assistenten, der für die Antwortgenerierung verwendet werden soll. Muss zu Ihrem Konto gehören.
​
customer_identifier
string
erforderlich
Eine eindeutige Kennung für den Kunden. Diese wird verwendet, um den Gesprächskontext über mehrere Nachrichten hinweg zu erhalten.Beispiele: Telefonnummer, E-Mail-Adresse, CRM-Kontakt-ID, Facebook-Benutzer-ID.Maximale Länge: 255 Zeichen.Wichtig: Verwenden Sie immer dasselbe Format für denselben Kunden, damit der Kontext korrekt zugeordnet wird.
​
message
string
erforderlich
Die Nachricht des Kunden, auf die geantwortet werden soll.
​
variables
object
Optionale Kontextvariablen, die an den Assistenten übergeben werden. Diese werden mit vorhandenen Gesprächsvariablen zusammengeführt.Nützlich für die Übergabe von Kundendaten, Sitzungskontext oder anderen Metadaten, die die Antwort personalisieren können.

​
Antwort-Felder

​
success
boolean
Gibt an, ob die Anfrage erfolgreich war
​
conversation_id
string
Die UUID der Konversation. Verwenden Sie diese, um die Konversation später zu verfolgen oder darauf zu verweisen.
​
customer_identifier
string
Die im Request bereitgestellte Kundenkennung
​
reply
string
Die von der KI generierte Antwort auf die Kundennachricht
​
function_calls
array
Array von Funktionsaufrufen, die der Assistent während der Verarbeitung der Nachricht durchgeführt hat. Leeres Array, wenn keine Funktionen aufgerufen wurden.
​
ai_disabled
boolean
Gibt an, ob KI-Antworten für diese Konversation deaktiviert sind (z.B. aufgrund einer manuellen Übernahme)

​
Fehlerantworten

​
success
boolean
Wird false sein, wenn ein Fehler auftritt
​
error
string
Fehlermeldung, die beschreibt, was schiefgelaufen ist
​
error_code
string
Maschinenlesbarer Fehlercode. Mögliche Werte:
  • ASSISTANT_NOT_FOUND - Die Assistenten-ID ist ungültig oder gehört nicht zu Ihrem Konto
  • INSUFFICIENT_BALANCE - Ihr Kontoguthaben ist zu niedrig, um die Nachricht zu verarbeiten

​
Anwendungsfälle

​
Multi-Channel KI-Antworten

Nutzen Sie diesen Endpunkt, um KI-Antworten zu jeder Messaging-Plattform hinzuzufügen:
  1. Empfangen Sie eine Nachricht von WhatsApp, Facebook, SMS oder einem anderen Kanal
  2. Rufen Sie diesen Endpunkt mit der Nachricht und der Kundenkennung auf
  3. Senden Sie die KI-Antwort über den ursprünglichen Kanal zurück

​
CRM-Integration

Integrieren Sie KI-Antworten in Ihr CRM oder Helpdesk-System:
  • Verwenden Sie die CRM-Kontakt-ID als customer_identifier
  • Übergeben Sie Kundendaten als Variablen für personalisierte Antworten
  • Die Konversation bleibt über Sitzungen hinweg erhalten, wenn dieselbe Kennung verwendet wird

​
Eigene Chat-Oberflächen

Erstellen Sie Ihre eigene Chat-Oberfläche, die von Ihrem Famulor-Assistenten angetrieben wird:
  • Generieren Sie eine eindeutige Kennung für jede Benutzersitzung
  • Senden Sie Nachrichten über diesen Endpunkt
  • Zeigen Sie die KI-Antworten in Ihrer Oberfläche an

​
Konversations-Persistenz

Konversationen werden automatisch basierend auf der Kombination aus assistant_id und customer_identifier gespeichert:
  • Gleiche Kennung: Nachrichten werden zur bestehenden Konversation hinzugefügt, wobei der vollständige Kontext erhalten bleibt
  • Neue Kennung: Eine neue Konversation wird für den Kunden erstellt
  • Variablen-Zusammenführung: Wenn Variablen bereitgestellt werden, werden sie mit vorhandenen Konversationsvariablen zusammengeführt

​
Best Practices

  • Konsistente Kennungen verwenden: Verwenden Sie immer dasselbe Format für Kundenkennungen (z.B. immer E.164 für Telefonnummern)
  • Relevanten Kontext übergeben: Nutzen Sie das variables-Feld, um Kundendaten bereitzustellen, die der KI helfen, Antworten zu personalisieren
  • Rate Limits handhaben: Implementieren Sie Wiederholungslogik mit exponentiellem Backoff für rate-limitierte Anfragen
  • Konversations-IDs speichern: Speichern Sie die zurückgegebene conversation_id für spätere Referenz oder Fehlerbehebung
  • Kosten überwachen: Verfolgen Sie die Nutzung, um Kosten zu verwalten, insbesondere bei Integrationen mit hohem Volumen
{
  "success": true,
  "conversation_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "customer_identifier": "+14155551234",
  "reply": "Hi John! I'd be happy to help you schedule an appointment. What day and time work best for you?",
  "function_calls": [],
  "ai_disabled": false
}
Passende Seiten: Introduction und Authentication Guide und API Integration Examples.