Mit der API-Schnittstelle holst du die Calls deines Teams in eigene Systeme: Zusammenfassungen, Analysen, Scores und auf Wunsch die Transkripte. Typische Ziele sind Zapier, Make, n8n, ein CRM ohne eigene CloseAI-Anbindung oder Auswertungen in Excel und BI-Tools.
Schlüssel erstellen
Öffne Integrationen und scrolle zum Abschnitt API-Schnittstelle.
Klicke auf Schlüssel erstellen, gib einen Namen ein (z. B. „Zapier“) und wähle die Berechtigungen.
Kopiere den Schlüssel sofort. Er wird nur dieses eine Mal angezeigt.
Erstelle für jedes System einen eigenen Schlüssel. Dann kannst du einen einzelnen Zugang widerrufen, ohne die anderen zu stören. Ein Team kann bis zu 10 aktive Schlüssel haben.
Berechtigung | Erlaubt |
|---|---|
Calls lesen | Calls mit Zusammenfassung, Analyse, Scores und eigenen Feldern, Produktkontexte |
Team lesen | Mitglieder mit Rolle und Lizenz |
Transkripte lesen | vollständige Transkripte (standardmäßig aus) |
Ein Schlüssel sieht alle Calls der aktuellen Mitglieder deines Teams, also dasselbe wie Inhaber und Admins im Team-Dashboard.
Anfragen senden
Adresse: https://api.getcloseai.com/v1
Sende den Schlüssel bei jeder Anfrage im Header:
Authorization: Bearer cai_live_…Verbindung testen:
curl https://api.getcloseai.com/v1/me -H "Authorization: Bearer cai_live_…"Endpunkte
Endpunkt | Berechtigung | Liefert |
|---|---|---|
| jede | Team, Schlüssel, Berechtigungen und Limits |
| Calls lesen | die Calls des Teams, neueste zuerst |
| Calls lesen | ein Call mit Analyse, in derselben Form wie die Webhooks |
| Transkripte lesen | das vollständige Transkript |
| Team lesen | Mitglieder mit Rolle und Lizenz |
| Calls lesen | Produktkontexte zum Filtern |
Filter für GET /v1/calls: from und to (Startzeit, ISO 8601), user_id, product_context_id, updated_since.
Mit ?include=summary,call_metrics holst du bei einem einzelnen Call nur die Teile, die du brauchst. Möglich sind summary, sales_analysis, call_metrics, spin_questions, call_assessment, script_adherence und custom_fields.
Seitenweise abrufen und abgleichen
Listen kommen in Seiten von 25 Einträgen, mit limit bis zu 100. Steht in der Antwort ein next_cursor, holst du die nächste Seite mit ?cursor=…. Bei null bist du am Ende.
Für einen regelmäßigen Abgleich übergibst du den Zeitpunkt deines letzten Abgleichs als updated_since. Dann kommen alle Calls, die sich seitdem geändert haben, älteste Änderung zuerst. Eine Änderung ist zum Beispiel eine fertige oder neu gestartete Analyse.
Limits
60 Anfragen pro Minute und Schlüssel
10.000 Anfragen pro Tag und Team (100 in der Testphase)
Die Header X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset zeigen den Stand. Ist ein Limit erreicht, antwortet die API mit Status 429 und nennt im Header Retry-After, wie viele Sekunden du warten sollst.
Fehler
Fehler haben immer die Form { "error": { "code": "…", "message": "…" } }.
Status | Code | Bedeutung |
|---|---|---|
400 |
| Ein Filter oder der Cursor ist ungültig. |
401 |
| Der Schlüssel fehlt, ist falsch, abgelaufen oder widerrufen. |
403 |
| Das Add-on ist nicht aktiv oder der Plan hat keine API. |
403 |
| Dem Schlüssel fehlt die nötige Berechtigung. |
404 |
| Der Call gehört nicht zu deinem Team oder existiert nicht. |
410 |
| Das Transkript wurde nach der Auswertung gelöscht. |
429 |
| Ein Limit ist erreicht. |
Jede Antwort trägt den Header X-Request-ID. Nenne ihn, wenn du dich an den Support wendest.
API oder Webhooks?
Webhooks schicken einen Call von selbst, sobald er ausgewertet ist. Die API fragst du selbst ab, wann du willst, auch rückwirkend. Viele Teams nutzen beides: Webhooks für den sofortigen Eintrag, die API für den nächtlichen Abgleich.
Datenschutz
Transkripte enthalten die Aussagen deiner Gesprächspartner. Schalte „Transkripte lesen“ nur für Systeme ein, die dafür freigegeben sind. Mit dem Abruf gibst du die Daten an deine eigenen Systeme weiter, für die du verantwortlich bist. Nutzt dein Team das Compliance-Add-on (Transkript-Löschung), sind Transkripte nach der Auswertung nicht mehr abrufbar. Zusammenfassung und Analyse bleiben erhalten.