StartseiteDokumentation

REST-API

Die ChatReact REST-API v1 bietet programmatischen Zugriff auf alles, was Sie im Dashboard tun können: Chatbots, Wissensdatenbank und Crawling, FAQs, Chat-Prüfung und Improvement Agent, Leads, Kontaktformulare, Live-Chat, Unternehmen und Team, E-Mail-Assistent, Analysen und Benachrichtigungen. Nur browsergebundene Aktionen (Zahlungen, Postfach-OAuth, Passkeys, Kontolöschung und die Verwaltung von API-Schlüsseln) bleiben im Dashboard.

Sie möchten lieber mit einem KI-Assistenten arbeiten? Dieselben Funktionen stehen als MCP-Tools zur Verfügung — siehe MCP-Server-Integration. Der interaktive API-Explorer mit Request- und Response-Schemas befindet sich unter /api-reference; dort können Sie auch die OpenAPI-3.0-Spezifikation herunterladen.

Authentifizierung

  1. Öffnen Sie Dashboard → Unternehmen → Registerkarte API und klicken Sie auf API-Schlüssel erstellen
  2. Vergeben Sie einen Namen und wählen Sie die Berechtigungs-Scopes, die der Schlüssel benötigt (siehe unten)
  3. Kopieren Sie den Schlüssel — er beginnt mit cr_ und wird nur einmal angezeigt

Senden Sie den Schlüssel mit jeder Anfrage:

curl https://www.chatreact.ai/api/v1/chatbots \
  -H "Authorization: Bearer cr_your_api_key"

Ein Header X-API-Key: cr_your_api_key wird ebenfalls akzeptiert. API-Schlüssel gehören zu genau einer Firma und arbeiten mit den Rechten des Firmeninhabers; Plan-Limits und Feature-Freischaltungen gelten genau wie im Dashboard.

API-Zugriff ist in kostenpflichtigen Plänen verfügbar — siehe die Preisseite. Schlüssel können jederzeit im Dashboard widerrufen werden.

Scopes

Jeder Schlüssel trägt einen oder mehrere Scopes. Ein Endpunkt antwortet mit 403, wenn dem Schlüssel der benötigte Scope fehlt.

ScopeBerechtigt zu
chatbots:read / chatbots:writeChatbot-Konfiguration: Persona, Sprachen, Widget, Verhalten, Einschränkungen, Kernanweisungen, Embed-Code, Lernphase, Chatbot-Vorlagen, FAQ-Widget-Einstellungen
knowledge:read / knowledge:writeWissensdatenbank: Dokumente, Website-Crawling, gecrawlte Seiten
faqs:read / faqs:writeFAQs, FAQ-Kategorien, Vorschläge, Übersetzungen
chats:read / chats:writeChatverlauf, Chat-Bewertungen, Confidence-Kategorien, Live-Chat (Agenten-Aktionen benötigen chats:write)
leads:read / leads:writeLeads, Lead-Kategorien, Lead-Erfassungseinstellungen, Export
forms:read / forms:writeKontaktformulare und Einsendungen
analytics:readStatistiken, Aktivitätsverläufe, Funnels, Confidence-Status
company:read / company:writeFirmenprofil und -einstellungen, Teammitglieder, Einladungen
email:read / email:writeE-Mail-Assistent: Verbindungen, Kategorien, Kontakte, Aktivität
blog:read / blog:writePlattform-Blog-Inhalte (ChatReact-intern)
jeder gültige Schlüssel/v1/me, Kontonutzung, Ihre Benachrichtigungen

Konventionen

  • Basis-URL: https://www.chatreact.ai/api/v1, JSON ein- und ausgehend (Content-Type: application/json).
  • Antworten: { "success": true, "data": … }; Listen ergänzen "pagination": { "total", "page", "pageSize", "totalPages" }. Verwenden Sie page und pageSize (max. 100) bei Listen-Endpunkten; einige Endpunkte bieten Cursor-Paginierung (cursor / nextCursor).
  • Fehler: { "success": false, "error": "Meldung", "code": "BAD_REQUEST" } mit optionalen details bei Validierungsfehlern. Statuscodes: 400 ungültige Eingabe, 401 fehlender oder ungültiger Schlüssel, 403 fehlender Scope, Funktion nicht im Plan enthalten oder unzureichende Rolle, 404 Ressource nicht gefunden (auch bei Ressourcen anderer Firmen), 409 Konflikt, 429 Rate-Limit überschritten.
  • Teilaktualisierungen: PATCH-Endpunkte ändern nur die gesendeten Felder; unbekannte Felder werden abgelehnt.
  • Rate-Limit: 30 Anfragen pro Minute und IP-Adresse.
  • Lang laufende Vorgänge (Crawls, KI-Generierung, Übersetzungen) antworten sofort mit einem Job oder Ergebnis, das Sie abfragen können; sie verbrauchen das Token- und Crawl-Kontingent Ihres Plans.

Endpunkte

Chatbots

MethodePfadBeschreibungScope
GET/api/v1/chatbotsChatbots auflistenchatbots:read
POST/api/v1/chatbotsChatbot erstellenchatbots:write
GET/api/v1/chatbots/{id}Chatbot abrufenchatbots:read
PATCH/api/v1/chatbots/{id}Chatbot aktualisierenchatbots:write
DELETE/api/v1/chatbots/{id}Chatbot löschenchatbots:write
GET/api/v1/chatbots/{id}/personalityChatbot-Persönlichkeit abrufenchatbots:read
PATCH/api/v1/chatbots/{id}/personalityChatbot-Persönlichkeit aktualisierenchatbots:write
GET/api/v1/chatbots/{id}/widgetWidget-Einstellungen abrufenchatbots:read
PATCH/api/v1/chatbots/{id}/widgetWidget-Einstellungen aktualisierenchatbots:write
GET/api/v1/chatbots/{id}/widget/translationsWidget-Übersetzungen abrufenchatbots:read
PUT/api/v1/chatbots/{id}/widget/translationsWidget-Übersetzungen ersetzenchatbots:write
GET/api/v1/chatbots/{id}/embedEmbed-Code abrufenchatbots:read
POST/api/v1/chatbots/{id}/embed/confirmEmbed bestätigenchatbots:write
GET/api/v1/chatbots/{id}/learning-phaseEinstellungen der Lernphase abrufenchatbots:read
PATCH/api/v1/chatbots/{id}/learning-phaseEinstellungen der Lernphase aktualisierenchatbots:write
POST/api/v1/chatbots/{id}/learning-phase/endLernphase beendenchatbots:write
GET/api/v1/chatbots/{id}/instructionsKernanweisungen auflistenchatbots:read
POST/api/v1/chatbots/{id}/instructionsKernanweisung hinzufügenchatbots:write
PUT/api/v1/chatbots/{id}/instructions/reorderKernanweisungen neu anordnenchatbots:write
POST/api/v1/chatbots/{id}/instructions/improveAnweisungen mit KI verbessernchatbots:write
GET/api/v1/instructions/{id}Kernanweisung abrufenchatbots:read
PATCH/api/v1/instructions/{id}Kernanweisung aktualisierenchatbots:write
DELETE/api/v1/instructions/{id}Kernanweisung löschenchatbots:write
GET/api/v1/chatbot-templatesChatbot-Vorlagen auflistenchatbots:read

Wissensdatenbank

MethodePfadBeschreibungScope
GET/api/v1/chatbots/{id}/knowledgeWissensdatenbank-Übersichtknowledge:read
GET/api/v1/chatbots/{id}/documentsDokumente für Chatbot auflistenknowledge:read
POST/api/v1/chatbots/{id}/documentsDokument hochladenknowledge:write
POST/api/v1/chatbots/{id}/documents/presignDokument-Upload vorab signierenknowledge:write
GET/api/v1/documents/{id}Dokument abrufenknowledge:read
DELETE/api/v1/documents/{id}Dokument löschenknowledge:write
POST/api/v1/documents/{id}/confirmVorab signierten Upload bestätigenknowledge:write
GET/api/v1/chatbots/{id}/crawl/limitsCrawl-Limitsknowledge:read
POST/api/v1/chatbots/{id}/crawl/previewWebsite-Scan vorschauenknowledge:write
GET/api/v1/chatbots/{id}/crawlCrawl-Jobs auflistenknowledge:read
POST/api/v1/chatbots/{id}/crawlCrawl startenknowledge:write
GET/api/v1/crawl-jobs/{jobId}Crawl-Job abrufenknowledge:read
POST/api/v1/crawl-jobs/{jobId}/cancelCrawl-Job abbrechenknowledge:write
GET/api/v1/chatbots/{id}/pagesGezielte Seiten auflistenknowledge:read
POST/api/v1/chatbots/{id}/pagesEinzelne URL hinzufügenknowledge:write
POST/api/v1/chatbots/{id}/pages/bulk-deleteGezielte Seiten bulk-löschenknowledge:write
GET/api/v1/pages/{id}Gezielte Seite abrufenknowledge:read
DELETE/api/v1/pages/{id}Gezielte Seite löschenknowledge:write
POST/api/v1/pages/{id}/recrawlSeite erneut crawlenknowledge:write
GET/api/v1/chatbots/{id}/websitesGezielte Websites auflistenknowledge:read
DELETE/api/v1/chatbots/{id}/websites/{domain}Website löschenknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawlWebsite erneut crawlenknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawl/cancelWebsite-Recrawl abbrechenknowledge:write

FAQs

MethodePfadBeschreibungScope
GET/api/v1/chatbots/{id}/faqsFAQs für Chatbot auflistenfaqs:read
POST/api/v1/chatbots/{id}/faqsFAQ erstellenfaqs:write
POST/api/v1/chatbots/{id}/faqs/bulkFAQs importieren (Bulk)faqs:write
POST/api/v1/chatbots/{id}/faqs/reorderFAQs neu anordnenfaqs:write
GET/api/v1/chatbots/{id}/faqs/embedFAQ-Widget-Embed-Code abrufenchatbots:read
POST/api/v1/chatbots/{id}/faqs/purge-cacheRemote-FAQ-Caches leerenfaqs:write
GET/api/v1/faqs/{id}FAQ abrufenfaqs:read
PATCH/api/v1/faqs/{id}FAQ aktualisierenfaqs:write
DELETE/api/v1/faqs/{id}FAQ löschenfaqs:write
PUT/api/v1/faqs/{id}/translationsFAQ-Übersetzungen aktualisierenfaqs:write
POST/api/v1/faqs/{id}/translateFAQ mit KI übersetzenfaqs:write
GET/api/v1/chatbots/{id}/faq-suggestionsFAQ-Vorschläge auflistenfaqs:read
POST/api/v1/chatbots/{id}/faq-suggestions/generateFAQ-Vorschläge aus Wissensdatenbank generierenfaqs:write
GET/api/v1/faq-suggestions/{id}FAQ-Vorschlag abrufenfaqs:read
POST/api/v1/faq-suggestions/{id}/approveFAQ-Vorschlag genehmigenfaqs:write
POST/api/v1/faq-suggestions/{id}/rejectFAQ-Vorschlag ablehnenfaqs:write
GET/api/v1/chatbots/{id}/faq-categoriesFAQ-Kategorien auflistenfaqs:read
POST/api/v1/chatbots/{id}/faq-categoriesFAQ-Kategorie erstellenfaqs:write
POST/api/v1/chatbots/{id}/faq-categories/reorderFAQ-Kategorien neu anordnenfaqs:write
GET/api/v1/faq-categories/{id}FAQ-Kategorie abrufenfaqs:read
PATCH/api/v1/faq-categories/{id}FAQ-Kategorie aktualisierenfaqs:write
DELETE/api/v1/faq-categories/{id}FAQ-Kategorie löschenfaqs:write
PUT/api/v1/faq-categories/{id}/translationsFAQ-Kategorie-Übersetzungen aktualisierenfaqs:write
GET/api/v1/chatbots/{id}/faq-widget-settingsFAQ-Widget-Einstellungen abrufenchatbots:read
PATCH/api/v1/chatbots/{id}/faq-widget-settingsFAQ-Widget-Einstellungen aktualisierenchatbots:write

Chats, Feedback & Improvement Agent

MethodePfadBeschreibungScope
GET/api/v1/chatsChatsitzungen auflistenchats:read
GET/api/v1/chats/{sessionId}Chatsitzung abrufenchats:read
PATCH/api/v1/chats/{sessionId}Chat-Vertrauenswürdigkeit setzenchats:write
POST/api/v1/chats/{sessionId}/feedbackChat bewerten (Gut / Verbesserungswürdig)chats:write
POST/api/v1/chats/{sessionId}/feedback/dismissChat-Bewertung verwerfenchats:write
POST/api/v1/chats/{sessionId}/improveImprovement Agent für Chat startenchatbots:write
GET/api/v1/chatbots/{id}/feedbackChat-Bewertungen eines Chatbots auflistenchats:read
GET/api/v1/chatbots/{id}/feedback/statsStatistikkarten zu Chat-Bewertungenchats:read
GET/api/v1/feedback/{id}Chat-Bewertung abrufenchats:read
PATCH/api/v1/feedback/{id}Bewertungs-Schweregrad überschreibenchats:write
POST/api/v1/feedback/{id}/improvement-sessionImprovement Agent für Bewertung startenchatbots:write
GET/api/v1/chatbots/{id}/confidenceVertrauensstatus abrufenanalytics:read
GET/api/v1/chatbots/{id}/confidence-categoriesVertrauenskategorien auflistenchats:read
POST/api/v1/chatbots/{id}/confidence-categoriesVertrauenskategorie erstellenchatbots:write
PATCH/api/v1/confidence-categories/{id}Vertrauenskategorie aktualisierenchatbots:write
DELETE/api/v1/confidence-categories/{id}Vertrauenskategorie löschenchatbots:write
POST/api/v1/confidence-categories/{id}/mergeVertrauenskategorien zusammenführenchatbots:write
GET/api/v1/chatbots/{id}/improvement-sessionsVerbesserungssitzungen auflistenchatbots:read
GET/api/v1/improvement-sessions/{id}Verbesserungssitzung abrufenchatbots:read
POST/api/v1/improvement-sessions/{id}/messagesNachricht an Improvement Agent sendenchatbots:write
POST/api/v1/improvement-sessions/{id}/completeVerbesserungssitzung abschließenchatbots:write
POST/api/v1/improvement-sessions/{id}/resetVerbesserungssitzung zurücksetzenchatbots:write
POST/api/v1/improvement-proposals/{id}/applyVerbesserungsvorschlag anwendenchatbots:write
POST/api/v1/improvement-proposals/{id}/rejectVerbesserungsvorschlag ablehnenchatbots:write
POST/api/v1/improvement-proposals/{id}/simulationsVerbesserungsvorschlag simulierenchatbots:write
POST/api/v1/improvement-simulations/{id}/assessmentSimulationsergebnis bewertenchatbots:write

Leads

MethodePfadBeschreibungScope
GET/api/v1/leadsLeads auflistenleads:read
POST/api/v1/leadsLead erstellenleads:write
GET/api/v1/leads/{id}Lead abrufenleads:read
PATCH/api/v1/leads/{id}Lead aktualisierenleads:write
DELETE/api/v1/leads/{id}Lead löschenleads:write
POST/api/v1/leads/{id}/assignLead zuweisenleads:write
POST/api/v1/leads/bulk-statusLead-Status bulk-aktualisierenleads:write
GET/api/v1/leads/statsLead-Statistikenleads:read
GET/api/v1/leads/exportLeads exportierenleads:read
GET/api/v1/chatbots/{id}/lead-configLead-Erfassungs-Konfiguration abrufenleads:read
PUT/api/v1/chatbots/{id}/lead-configLead-Erfassungs-Konfiguration aktualisierenleads:write
GET/api/v1/chatbots/{id}/lead-categoriesLead-Kategorien auflistenleads:read
POST/api/v1/chatbots/{id}/lead-categoriesLead-Kategorie erstellenleads:write
GET/api/v1/lead-categories/{id}Lead-Kategorie abrufenleads:read
PATCH/api/v1/lead-categories/{id}Lead-Kategorie aktualisierenleads:write
DELETE/api/v1/lead-categories/{id}Lead-Kategorie löschenleads:write
PUT/api/v1/lead-categories/{id}/users/{userId}Mitglied einer Lead-Kategorie zuweisenleads:write
DELETE/api/v1/lead-categories/{id}/users/{userId}Mitglied aus Lead-Kategorie entfernenleads:write

Kontaktformulare

MethodePfadBeschreibungScope
GET/api/v1/chatbots/{id}/formsKontaktformulare auflistenforms:read
POST/api/v1/chatbots/{id}/formsKontaktformular erstellenforms:write
GET/api/v1/forms/{id}Kontaktformular abrufenforms:read
PATCH/api/v1/forms/{id}Kontaktformular aktualisierenforms:write
DELETE/api/v1/forms/{id}Kontaktformular löschenforms:write
GET/api/v1/forms/{id}/submissionsFormulareinsendungen auflistenforms:read
GET/api/v1/forms/{id}/statsFormulareinsendungs-Statistikenforms:read
GET/api/v1/submissions/{id}Formulareinsendung abrufenforms:read
PATCH/api/v1/submissions/{id}Formulareinsendung prüfenforms:write
DELETE/api/v1/submissions/{id}Formulareinsendung löschenforms:write

Live-Chat

MethodePfadBeschreibungScope
GET/api/v1/live-chat/availabilityEigene Live-Chat-Verfügbarkeit abrufenchats:read
PUT/api/v1/live-chat/availabilityEigene Live-Chat-Verfügbarkeit setzenchats:write
POST/api/v1/live-chat/heartbeatPräsenz-Heartbeat sendenchats:write
GET/api/v1/live-chat/agentsVerfügbare Live-Chat-Agenten auflistenchats:read
GET/api/v1/live-chat/sessionsLive-Chat-Sitzungen auflistenchats:read
GET/api/v1/live-chat/sessions/{sessionId}Live-Chat-Sitzung abrufenchats:read
POST/api/v1/live-chat/sessions/{sessionId}/assignLive-Chat übernehmen (Key-Besitzer zuweisen)chats:write
POST/api/v1/live-chat/sessions/{sessionId}/messagesNachricht als Agent sendenchats:write
POST/api/v1/live-chat/sessions/{sessionId}/closeLive-Chat beendenchats:write

Analysen

MethodePfadBeschreibungScope
GET/api/v1/analyticsAnalytics-Übersicht abrufenanalytics:read
GET/api/v1/analytics/activityChat-Aktivitätszeitreihe abrufenanalytics:read
GET/api/v1/analytics/chatbotsLeistungsstatistiken pro Chatbot auflistenanalytics:read
GET/api/v1/analytics/chatbots/{id}Chatbot-Analytics abrufenanalytics:read
GET/api/v1/analytics/leadsLead-Funnel abrufenanalytics:read
GET/api/v1/analytics/formsFormulareinsendungs-Statistiken abrufenanalytics:read
GET/api/v1/activityAufmerksamkeitszusammenfassung abrufenanalytics:read

Unternehmen & Team

MethodePfadBeschreibungScope
GET/api/v1/companyFirma abrufenjeder Schlüssel
PATCH/api/v1/companyFirma aktualisierencompany:write
GET/api/v1/company/settingsFirmeneinstellungen abrufencompany:read
PATCH/api/v1/company/settingsFirmeneinstellungen aktualisierencompany:write
DELETE/api/v1/company/logoFirmenlogo entfernencompany:write
GET/api/v1/company/membersTeammitglieder auflistencompany:read
PATCH/api/v1/company/members/{userId}Rolle eines Mitglieds änderncompany:write
DELETE/api/v1/company/members/{userId}Teammitglied entfernencompany:write
GET/api/v1/company/invitesEinladungen auflistencompany:read
POST/api/v1/company/invitesTeammitglied einladencompany:write
DELETE/api/v1/company/invites/{id}Einladung stornierencompany:write
POST/api/v1/company/invites/{id}/resendEinladung erneut sendencompany:write

E-Mail-Assistent

MethodePfadBeschreibungScope
GET/api/v1/email/connectionsMailbox-Verbindungen auflistenemail:read
GET/api/v1/email/connections/{id}Mailbox-Verbindung abrufenemail:read
PATCH/api/v1/email/connections/{id}Mailbox-Verbindung aktualisierenemail:write
DELETE/api/v1/email/connections/{id}Mailbox trennenemail:write
GET/api/v1/email/connections/{id}/categoriesE-Mail-Kategorien auflistenemail:read
POST/api/v1/email/connections/{id}/categoriesE-Mail-Kategorie erstellenemail:write
GET/api/v1/email/connections/{id}/activityE-Mail-Aktivitätslog auflistenemail:read
GET/api/v1/email/categories/{id}E-Mail-Kategorie abrufenemail:read
PATCH/api/v1/email/categories/{id}E-Mail-Kategorie aktualisierenemail:write
DELETE/api/v1/email/categories/{id}E-Mail-Kategorie löschenemail:write
GET/api/v1/email/contactsE-Mail-Kontakte auflistenemail:read
GET/api/v1/email/contacts/{id}E-Mail-Kontakt abrufenemail:read
PATCH/api/v1/email/contacts/{id}E-Mail-Kontakt aktualisierenemail:write
DELETE/api/v1/email/contacts/{id}E-Mail-Kontakt löschenemail:write

Konto & Benachrichtigungen

MethodePfadBeschreibungScope
GET/api/v1/meKey-Kontext abrufen (whoami)jeder Schlüssel
GET/api/v1/account/usagePlan und Nutzung abrufenjeder Schlüssel
GET/api/v1/notificationsBenachrichtigungen auflistenjeder Schlüssel
DELETE/api/v1/notificationsAlte gelesene Benachrichtigungen löschenjeder Schlüssel
GET/api/v1/notifications/unread-countAnzahl ungelesener Benachrichtigungen abrufenjeder Schlüssel
POST/api/v1/notifications/mark-all-readAlle Benachrichtigungen als gelesen markierenjeder Schlüssel
GET/api/v1/notifications/{id}Benachrichtigung abrufenjeder Schlüssel
PATCH/api/v1/notifications/{id}Benachrichtigung als gelesen markierenjeder Schlüssel

Blog (Plattform)

MethodePfadBeschreibungScope
GET/api/v1/blogBlogbeiträge auflistenjeder Schlüssel
POST/api/v1/blogBlogbeitrag erstellenjeder Schlüssel
POST/api/v1/blog/assetsBlog-Asset hochladenjeder Schlüssel
GET/api/v1/blog/{id}Blogbeitrag abrufenjeder Schlüssel
PATCH/api/v1/blog/{id}Blogbeitrag aktualisierenjeder Schlüssel
DELETE/api/v1/blog/{id}Blogbeitrag löschenjeder Schlüssel
POST/api/v1/blog/{id}/translationsBlog-Übersetzungen in die Warteschlange stellenjeder Schlüssel

Brauchen Sie Hilfe? Kontaktieren Sie unser Support-Team →