Die Conversation-AI-API von HighLevel gibt Entwicklern programmgesteuerte Kontrolle über KI-Agenten, Aktionen und Konversations-Generierungen. Nutzen Sie sichere Tokens und granulare Scopes, um die Agenten-Einrichtung zu automatisieren, externe Apps zu integrieren und Konversationsdaten für Analysen oder Compliance zu exportieren. Dieser Leitfaden erklärt, was die API ist, welche Vorteile sie bietet, die Authentifizierungsoptionen (PIT & JWT), die Endpoint-Familien sowie die schrittweise Einrichtung mit Screenshots.
INHALTSVERZEICHNIS
Was ist die Conversation AI API?
Zentrale Vorteile der Conversation AI API
Authentifizierung (PIT & JWT)
API-Dokumentation
Aktionen
Agenten
Generierungen
Häufig gestellte Fragen
Was ist die Conversation AI API?
Die Conversation AI API stellt dieselben Kernfunktionen bereit, die auch in der Conversation-AI-UI verfügbar sind (Erstellen und Verwalten von Agenten, Anhängen von Aktionen sowie Abrufen von KI-Antwortdetails), sodass Ihr Team Konfigurationen automatisieren und Conversation AI mit Ihren eigenen Systemen verbinden kann.
Mit dieser API können Sie Agenten in großem Umfang bereitstellen, Aktions-Updates skripten und nachrichtenbezogene Generierungsdaten für Reporting und Audits abrufen.
Zentrale Vorteile der Conversation AI API
Das Verständnis der praktischen Vorteile hilft bei der Entscheidung, wann die API statt der UI genutzt werden sollte. Diese Punkte heben die Ergebnisse hervor, die Teams typischerweise automatisieren: schnelleres Provisioning, konsistente Konfiguration im großen Maßstab und zuverlässiger Zugriff auf detaillierte Konversationsdaten.
Schnelleres Onboarding: Automatisieren Sie die Agenten-Erstellung und das Anhängen von Aktionen für neue Standorte oder Kunden in wenigen Minuten.
Skalierbare Konfiguration: Wenden Sie konsistente Agenten-Einstellungen und Aktionen über viele Sub-Accounts hinweg per Skripten oder CI/CD-Jobs an.
Tiefere Analysen: Rufen Sie Generierungen (KI-Antwortdetails) ab, um Dashboards, QA-Workflows, Audits und Compliance-Exporte zu betreiben.
Flexible Integration: Orchestrieren Sie HighLevel mit Ihren internen Tools – triggern Sie Workflows, verfolgen Sie Ergebnisse und protokollieren Sie Ereignisse extern.
Least-Privilege-Sicherheit: Verwenden Sie Read-only- oder Write-Scopes, um den Zugriff exakt auf das zu begrenzen, was Ihre Integration benötigt.
Authentifizierung (PIT & JWT)
Die Wahl der richtigen Authentifizierungsmethode gewährleistet zuverlässigen und sicheren Zugriff. Personal Integration Tokens (PIT) lassen sich schnell erstellen und mit Scopes versehen, während JSON Web Tokens (JWT) OAuth-basierte App-Flows unterstützen. Beide können für den Zugriff auf die Conversation AI API verwendet werden.
Öffnen Sie Settings → Private Integrations in Ihrem HighLevel-Sub-Account (Standort).
Geben Sie grundlegende Informationen an (Name und Beschreibung).
Wählen Sie die Conversation-AI-Scopes aus.
Erstellen Sie das Token und kopieren Sie es.
Verwalten und verwenden Sie das Token entsprechend.
API-Dokumentation
Sehen Sie sich hier die vollständige API-Dokumentation an: Marketplace API 2.0 Conversation AI Actions
Aktionen
Aktion an Agent anhängen
Aktionen für einen Agenten auflisten
Aktion nach ID abrufen
Aktion aktualisieren
Aktion vom Agenten entfernen
Follow-up-Einstellungen aktualisieren
Agenten
Agent erstellen
Agenten suchen
Agent aktualisieren
Agent abrufen
Agent löschen
Generierungen
Generierungsdetails abrufen
Häufig gestellte Fragen
F: Benötige ich ein Sub-Account- oder Agency-Token für Conversation AI?
A: Verwenden Sie ein Sub-Account-Token, damit Aufrufe im richtigen Standort-Kontext ausgeführt werden.
F: Kann ich sowohl PIT als auch JWT verwenden?
A: Ja. Sie können sich mit beiden Methoden authentifizieren. Wählen Sie PIT für einfache Server-zu-Server-Integrationen; verwenden Sie JWT für OAuth-App-Flows.
F: Wo finde ich die agentId?
A: Erstellen oder suchen Sie Agenten über die Agents API und verwenden Sie anschließend das zurückgegebene id-Feld in weiteren Aufrufen.
F: Wie prüfe ich KI-Antworten programmgesteuert (Audit)?
A: Nutzen Sie den Generations-Endpoint, um nachrichtenbezogene Antwortdetails abzurufen und in Ihrem Analyse- oder Compliance-System zu speichern.
F: Was verursacht einen 403-Fehler, obwohl mein Token gültig aussieht?
A: Meist fehlt dem Token der erforderliche Scope oder es handelt sich nicht um ein Sub-Account-Token für den Ziel-Standort.