REST API
REST API v1 ChatReact umożliwia programowy dostęp do obsługiwanych operacji w panelu: chatboty, baza wiedzy i indeksowanie, uporządkowane ceny, FAQ, przegląd rozmów i Improvement Agent, leady, formularze kontaktowe, live chat, firma i zespół, Email Assistant, analityka i powiadomienia. Akcje ograniczone do przeglądarki (płatności, autoryzacja skrzynki, passkeys, usunięcie konta i zarządzanie kluczami API) pozostają w panelu.
Wolisz rozmawiać z asystentem AI? Te same możliwości są dostępne jako narzędzia MCP — zobacz MCP Server Integration . Interaktywny API Explorer z schematami żądań i odpowiedzi znajduje się pod /api-reference , skąd można również pobrać specyfikację OpenAPI 3.0.
Uwierzytelnianie
Przejdź do Panel → Firma → zakładka API i kliknij Utwórz klucz API
Wybierz nazwę oraz zakresy uprawnień, których klucz potrzebuje (patrz niżej)
Skopiuj klucz — zaczyna się od cr_ i jest wyświetlany tylko raz
Wysyłaj klucz z każdym żądaniem:
curl https://www.chatreact.ai/api/v1/chatbots \
-H "Authorization: Bearer cr_your_api_key"
Nagłówek X-API-Key: cr_your_api_key jest również akceptowany. Klucze API należą do jednej firmy i wykonują operacje z uprawnieniami właściciela firmy; limity planu i blokady funkcji obowiązują tak, jak w panelu.
Dostęp do API jest dostępny w planach płatnych — zobacz Pricing page . Klucze można unieważnić w dowolnym momencie z panelu.
Zakresy uprawnień (Scopes)
Każdy klucz ma przypisany jeden lub więcej zakresów. Endpoint zwraca 403, gdy klucz nie ma wymaganego zakresu.
Scope Przyznaje chatbots:read / chatbots:writeKonfiguracja chatbota: persona, języki, widget, zachowanie, ograniczenia, instrukcje podstawowe, kod osadzenia, faza uczenia, szablony chatbotów, ustawienia widgetu FAQ knowledge:read / knowledge:writeBaza wiedzy: dokumenty, indeksowanie stron, zindeksowane strony faqs:read / faqs:writeFAQ, kategorie FAQ, sugestie, tłumaczenia chats:read / chats:writeHistoria rozmów, oceny rozmów, kategorie zaufania, live chat (akcje agenta wymagają chats:write) leads:read / leads:writeLeadsy, kategorie leadów, ustawienia przechwytywania leadów, eksport forms:read / forms:writeFormularze kontaktowe i zgłoszenia analytics:readStatystyki, szeregi aktywności, lejki, status zaufania company:read / company:writeProfil firmy i ustawienia, członkowie zespołu, zaproszenia email:read / email:writePołączenia Email Assistant, kategorie, kontakty, aktywność prices:readOdczyt wpisów uporządkowanych cen, rewizje, uprawnienia i sugestie prices:writeTworzenie i edycja szkiców cen, import CSV i zastosowanie sugestii jako szkicu; wymaga właściciela firmy prices:approveZatwierdzanie dokładnych wersji lub archiwizacja wpisów; wymaga właściciela firmy blog:read / blog:writeTreści bloga platformy (wewnętrzne ChatReact) any valid key /v1/me, wykorzystanie konta, Twoje powiadomienia
Konwencje
Base URL : https://www.chatreact.ai/api/v1, JSON na wejściu i wyjściu (Content-Type: application/json).Odpowiedzi : { "success": true, "data": … }; listy zawierają dodatkowo "pagination": { "total", "page", "pageSize", "totalPages" }. Na endpointach list używaj page i pageSize (max 100); niektóre endpointy oferują stronicowanie kursorem (cursor / nextCursor).Błędy : { "success": false, "error": "message", "code": "BAD_REQUEST" } z opcjonalnym details dla błędów walidacji. Kody statusu: 400 niepoprawne dane wejściowe, 401 brak lub nieprawidłowy klucz, 403 brak zakresu, funkcja planu nie jest uwzględniona lub niewystarczająca rola, 404 zasób nie znaleziony (również dla zasobów innych firm), 409 konflikt, 429 przekroczono limit zapytań.Aktualizacje częściowe : Endpointy PATCH zmieniają tylko pola, które przesyłasz; nieznane pola są odrzucane.Limit zapytań : 30 żądań na minutę na adres IP.Operacje długotrwałe (indeksowanie, generowanie AI, tłumaczenia) zwracają szybko zadanie lub wynik, który można odpytywać; zużywają one tokeny i budżet indeksowania planu.
Endpointy
Prices & services
Zapis, edycja, import i zastosowanie sugestii tworzą szkice bez zatwierdzenia. Operacje zatwierdzania i archiwizacji przeglądają dokładne wersje; przestarzała wersja zwraca konflikt. Istniejące klucze nie uzyskują automatycznie uprawnień do cen. Tylko właściciel firmy może przyznać uprawnienia do zapisu lub zatwierdzania. Dla procesu klienta zobacz Prices & services .
Method Path Description Scope GET/api/v1/chatbots/{id}/pricesLista wpisów cenowych i uprawnień prices:readPOST/api/v1/chatbots/{id}/pricesUtwórz szkic prices:writeGET/api/v1/chatbots/{id}/prices/{itemId}Odczytaj szczegóły i paginowaną historię prices:readPATCH/api/v1/chatbots/{id}/prices/{itemId}Utwórz edytowany szkic z oczekiwanej wersji prices:writeGET/api/v1/chatbots/{id}/prices/{itemId}/stateOdczytaj pełny stan elementu prices:readPOST/api/v1/chatbots/{id}/prices/{itemId}/approveZatwierdź dokładną wersję prices:approvePOST/api/v1/chatbots/{id}/prices/{itemId}/archiveArchiwizuj dokładną wersję prices:approvePOST/api/v1/chatbots/{id}/prices/approve-manyAtomowo zatwierdź wybraną wersję prices:approvePOST/api/v1/chatbots/{id}/prices/importImportuj szkice CSV z trwałym ID importu prices:writeGET/api/v1/chatbots/{id}/prices/suggestionsLista sugestii cenowych prices:readPOST/api/v1/chatbots/{id}/prices/suggestions/{suggestionId}/applyZastosuj wybraną sugestię jako szkic prices:write
Chatbots
Method Path Description Scope GET/api/v1/chatbotsLista chatbotów chatbots:readPOST/api/v1/chatbotsUtwórz chatbota chatbots:writeGET/api/v1/chatbots/{id}Pobierz chatbota chatbots:readPATCH/api/v1/chatbots/{id}Zaktualizuj chatbota chatbots:writeDELETE/api/v1/chatbots/{id}Usuń chatbota chatbots:writeGET/api/v1/chatbots/{id}/personalityPobierz osobowość chatbota chatbots:readPATCH/api/v1/chatbots/{id}/personalityZaktualizuj osobowość chatbota chatbots:writeGET/api/v1/chatbots/{id}/widgetPobierz ustawienia widgetu chatbots:readPATCH/api/v1/chatbots/{id}/widgetZaktualizuj ustawienia widgetu chatbots:writeGET/api/v1/chatbots/{id}/widget/translationsPobierz tłumaczenia widgetu chatbots:readPUT/api/v1/chatbots/{id}/widget/translationsZastąp tłumaczenia widgetu chatbots:writeGET/api/v1/chatbots/{id}/embedPobierz kod osadzenia chatbots:readPOST/api/v1/chatbots/{id}/embed/confirmPotwierdź osadzenie chatbots:writeGET/api/v1/chatbots/{id}/learning-phasePobierz ustawienia fazy uczenia chatbots:readPATCH/api/v1/chatbots/{id}/learning-phaseZaktualizuj ustawienia fazy uczenia chatbots:writePOST/api/v1/chatbots/{id}/learning-phase/endZakończ fazę uczenia chatbots:writeGET/api/v1/chatbots/{id}/instructionsLista instrukcji podstawowych chatbots:readPOST/api/v1/chatbots/{id}/instructionsDodaj instrukcję podstawową chatbots:writePUT/api/v1/chatbots/{id}/instructions/reorderZmień kolejność instrukcji podstawowych chatbots:writePOST/api/v1/chatbots/{id}/instructions/improveUlepsz instrukcje przy pomocy AI chatbots:writeGET/api/v1/instructions/{id}Pobierz instrukcję podstawową chatbots:readPATCH/api/v1/instructions/{id}Zaktualizuj instrukcję podstawową chatbots:writeDELETE/api/v1/instructions/{id}Usuń instrukcję podstawową chatbots:writeGET/api/v1/chatbot-templatesLista szablonów chatbotów chatbots:read
Baza wiedzy
Method Path Description Scope GET/api/v1/chatbots/{id}/knowledgePrzegląd bazy wiedzy knowledge:readGET/api/v1/chatbots/{id}/documentsLista dokumentów dla chatbota knowledge:readPOST/api/v1/chatbots/{id}/documentsPrześlij dokument knowledge:writePOST/api/v1/chatbots/{id}/documents/presignPrzygotuj podpisane URL do przesyłania dokumentu knowledge:writeGET/api/v1/documents/{id}Pobierz dokument knowledge:readDELETE/api/v1/documents/{id}Usuń dokument knowledge:writePOST/api/v1/documents/{id}/confirmPotwierdź przesłanie przez presigned URL knowledge:writeGET/api/v1/chatbots/{id}/crawl/limitsLimity indeksowania knowledge:readPOST/api/v1/chatbots/{id}/crawl/previewPodgląd skanowania strony knowledge:writeGET/api/v1/chatbots/{id}/crawlLista zadań indeksowania knowledge:readPOST/api/v1/chatbots/{id}/crawlRozpocznij indeksowanie knowledge:writeGET/api/v1/crawl-jobs/{jobId}Pobierz zadanie indeksowania knowledge:readPOST/api/v1/crawl-jobs/{jobId}/cancelAnuluj zadanie indeksowania knowledge:writeGET/api/v1/chatbots/{id}/pagesLista zindeksowanych stron knowledge:readPOST/api/v1/chatbots/{id}/pagesDodaj pojedynczy URL knowledge:writePOST/api/v1/chatbots/{id}/pages/bulk-deleteMasowe usuwanie zindeksowanych stron knowledge:writeGET/api/v1/pages/{id}Pobierz zindeksowaną stronę knowledge:readDELETE/api/v1/pages/{id}Usuń zindeksowaną stronę knowledge:writePOST/api/v1/pages/{id}/recrawlPonownie zindeksuj stronę knowledge:writeGET/api/v1/chatbots/{id}/websitesLista zindeksowanych witryn knowledge:readDELETE/api/v1/chatbots/{id}/websites/{domain}Usuń witrynę knowledge:writePOST/api/v1/chatbots/{id}/websites/{domain}/recrawlPonownie zindeksuj witrynę knowledge:writePOST/api/v1/chatbots/{id}/websites/{domain}/recrawl/cancelAnuluj ponowne indeksowanie witryny knowledge:write
FAQs
Method Path Description Scope GET/api/v1/chatbots/{id}/faqsLista FAQ dla chatbota faqs:readPOST/api/v1/chatbots/{id}/faqsUtwórz FAQ faqs:writePOST/api/v1/chatbots/{id}/faqs/bulkMasowy import FAQ faqs:writePOST/api/v1/chatbots/{id}/faqs/reorderZmień kolejność FAQ faqs:writeGET/api/v1/chatbots/{id}/faqs/embedPobierz kod osadzenia widgetu FAQ chatbots:readPOST/api/v1/chatbots/{id}/faqs/purge-cacheOpróżnij zdalne cache FAQ faqs:writeGET/api/v1/faqs/{id}Pobierz FAQ faqs:readPATCH/api/v1/faqs/{id}Zaktualizuj FAQ faqs:writeDELETE/api/v1/faqs/{id}Usuń FAQ faqs:writePUT/api/v1/faqs/{id}/translationsZaktualizuj tłumaczenia FAQ faqs:writePOST/api/v1/faqs/{id}/translatePrzetłumacz FAQ przy pomocy AI faqs:writeGET/api/v1/chatbots/{id}/faq-suggestionsLista sugestii FAQ faqs:readPOST/api/v1/chatbots/{id}/faq-suggestions/generateGeneruj sugestie FAQ z bazy wiedzy faqs:writeGET/api/v1/faq-suggestions/{id}Pobierz sugestię FAQ faqs:readPOST/api/v1/faq-suggestions/{id}/approveZatwierdź sugestię FAQ faqs:writePOST/api/v1/faq-suggestions/{id}/rejectOdrzuć sugestię FAQ faqs:writeGET/api/v1/chatbots/{id}/faq-categoriesLista kategorii FAQ faqs:readPOST/api/v1/chatbots/{id}/faq-categoriesUtwórz kategorię FAQ faqs:writePOST/api/v1/chatbots/{id}/faq-categories/reorderZmień kolejność kategorii FAQ faqs:writeGET/api/v1/faq-categories/{id}Pobierz kategorię FAQ faqs:readPATCH/api/v1/faq-categories/{id}Zaktualizuj kategorię FAQ faqs:writeDELETE/api/v1/faq-categories/{id}Usuń kategorię FAQ faqs:writePUT/api/v1/faq-categories/{id}/translationsZaktualizuj tłumaczenia kategorii FAQ faqs:writeGET/api/v1/chatbots/{id}/faq-widget-settingsPobierz ustawienia widgetu FAQ chatbots:readPATCH/api/v1/chatbots/{id}/faq-widget-settingsZaktualizuj ustawienia widgetu FAQ chatbots:write
Chats, feedback & Improvement Agent
Method Path Description Scope GET/api/v1/chatsLista sesji czatu chats:readGET/api/v1/chats/{sessionId}Pobierz sesję czatu chats:readPATCH/api/v1/chats/{sessionId}Ustaw kategorię zaufania rozmowy chats:writePOST/api/v1/chats/{sessionId}/feedbackOceń rozmowę (Dobra / Wymaga poprawek) chats:writePOST/api/v1/chats/{sessionId}/feedback/dismissOdrzuć przegląd rozmowy chats:writePOST/api/v1/chats/{sessionId}/improveUruchom Improvement Agent dla rozmowy chatbots:writeGET/api/v1/chatbots/{id}/feedbackLista przeglądów rozmów dla chatbota chats:readGET/api/v1/chatbots/{id}/feedback/statsKarty statystyk przeglądu rozmów chats:readGET/api/v1/feedback/{id}Pobierz przegląd rozmowy chats:readPATCH/api/v1/feedback/{id}Nadpisz ciężkość przeglądu chats:writePOST/api/v1/feedback/{id}/improvement-sessionUruchom Improvement Agent dla przeglądu chatbots:writeGET/api/v1/chatbots/{id}/confidencePobierz status zaufania analytics:readGET/api/v1/chatbots/{id}/confidence-categoriesLista kategorii zaufania chats:readPOST/api/v1/chatbots/{id}/confidence-categoriesUtwórz kategorię zaufania chatbots:writePATCH/api/v1/confidence-categories/{id}Zaktualizuj kategorię zaufania chatbots:writeDELETE/api/v1/confidence-categories/{id}Usuń kategorię zaufania chatbots:writePOST/api/v1/confidence-categories/{id}/mergeScal kategorie zaufania chatbots:writeGET/api/v1/chatbots/{id}/improvement-sessionsLista sesji ulepszania chatbots:readGET/api/v1/improvement-sessions/{id}Pobierz sesję ulepszania chatbots:readPOST/api/v1/improvement-sessions/{id}/messagesWyślij wiadomość do Improvement Agent chatbots:writePOST/api/v1/improvement-sessions/{id}/completeZakończ sesję ulepszania chatbots:writePOST/api/v1/improvement-sessions/{id}/resetZresetuj sesję ulepszania chatbots:writePOST/api/v1/improvement-proposals/{id}/applyZastosuj propozycję ulepszenia chatbots:writePOST/api/v1/improvement-proposals/{id}/rejectOdrzuć propozycję ulepszenia chatbots:writePOST/api/v1/improvement-proposals/{id}/simulationsSymuluj propozycję ulepszenia chatbots:writePOST/api/v1/improvement-simulations/{id}/assessmentOceń wynik symulacji chatbots:write
Leads
Method Path Description Scope GET/api/v1/leadsLista leadów leads:readPOST/api/v1/leadsUtwórz lead leads:writeGET/api/v1/leads/{id}Pobierz lead leads:readPATCH/api/v1/leads/{id}Zaktualizuj lead leads:writeDELETE/api/v1/leads/{id}Usuń lead leads:writePOST/api/v1/leads/{id}/assignPrzypisz lead leads:writePOST/api/v1/leads/bulk-statusMasowa aktualizacja statusu leadów leads:writeGET/api/v1/leads/statsStatystyki leadów leads:readGET/api/v1/leads/exportEksport leadów leads:readGET/api/v1/chatbots/{id}/lead-configPobierz konfigurację przechwytywania leadów leads:readPUT/api/v1/chatbots/{id}/lead-configZaktualizuj konfigurację przechwytywania leadów leads:writeGET/api/v1/chatbots/{id}/lead-categoriesLista kategorii leadów leads:readPOST/api/v1/chatbots/{id}/lead-categoriesUtwórz kategorię leadów leads:writeGET/api/v1/lead-categories/{id}Pobierz kategorię leadów leads:readPATCH/api/v1/lead-categories/{id}Zaktualizuj kategorię leadów leads:writeDELETE/api/v1/lead-categories/{id}Usuń kategorię leadów leads:writePUT/api/v1/lead-categories/{id}/users/{userId}Przypisz członka do kategorii leadów leads:writeDELETE/api/v1/lead-categories/{id}/users/{userId}Usuń członka z kategorii leadów leads:write
Formularze kontaktowe
Method Path Description Scope GET/api/v1/chatbots/{id}/formsLista formularzy kontaktowych forms:readPOST/api/v1/chatbots/{id}/formsUtwórz formularz kontaktowy forms:writeGET/api/v1/forms/{id}Pobierz formularz kontaktowy forms:readPATCH/api/v1/forms/{id}Zaktualizuj formularz kontaktowy forms:writeDELETE/api/v1/forms/{id}Usuń formularz kontaktowy forms:writeGET/api/v1/forms/{id}/submissionsLista zgłoszeń formularzy forms:readGET/api/v1/forms/{id}/statsStatystyki zgłoszeń formularzy forms:readGET/api/v1/submissions/{id}Pobierz zgłoszenie formularza forms:readPATCH/api/v1/submissions/{id}Przejrzyj zgłoszenie formularza forms:writeDELETE/api/v1/submissions/{id}Usuń zgłoszenie formularza forms:write
Live chat
Method Path Description Scope GET/api/v1/live-chat/availabilityPobierz własną dostępność w live chat chats:readPUT/api/v1/live-chat/availabilityUstaw własną dostępność w live chat chats:writePOST/api/v1/live-chat/heartbeatWyślij heartbeat obecności chats:writeGET/api/v1/live-chat/agentsLista dostępnych agentów live chat chats:readGET/api/v1/live-chat/sessionsLista sesji live chat chats:readGET/api/v1/live-chat/sessions/{sessionId}Pobierz sesję live chat chats:readPOST/api/v1/live-chat/sessions/{sessionId}/assignPrzejmij live chat (przypisz do właściciela klucza) chats:writePOST/api/v1/live-chat/sessions/{sessionId}/messagesWyślij wiadomość jako agent chats:writePOST/api/v1/live-chat/sessions/{sessionId}/closeZakończ live chat chats:write
Analityka
Method Path Description Scope GET/api/v1/analyticsPobierz przegląd analityki analytics:readGET/api/v1/analytics/activityPobierz szeregi aktywności czatów analytics:readGET/api/v1/analytics/chatbotsLista statystyk wydajności per chatbot analytics:readGET/api/v1/analytics/chatbots/{id}Pobierz analitykę chatbota analytics:readGET/api/v1/analytics/leadsPobierz lejek leadów analytics:readGET/api/v1/analytics/formsPobierz statystyki zgłoszeń formularzy analytics:readGET/api/v1/activityPobierz podsumowanie uwagi (attention) analytics:read
Firma i zespół
Method Path Description Scope GET/api/v1/companyPobierz firmę any key PATCH/api/v1/companyZaktualizuj firmę company:writeGET/api/v1/company/settingsPobierz ustawienia firmy company:readPATCH/api/v1/company/settingsZaktualizuj ustawienia firmy company:writeDELETE/api/v1/company/logoUsuń logo firmy company:writeGET/api/v1/company/membersLista członków zespołu company:readPATCH/api/v1/company/members/{userId}Zmień rolę członka company:writeDELETE/api/v1/company/members/{userId}Usuń członka zespołu company:writeGET/api/v1/company/invitesLista zaproszeń company:readPOST/api/v1/company/invitesZaproś członka zespołu company:writeDELETE/api/v1/company/invites/{id}Anuluj zaproszenie company:writePOST/api/v1/company/invites/{id}/resendWyślij ponownie zaproszenie company:write
Email Assistant
Method Path Description Scope GET/api/v1/email/connectionsLista połączeń skrzynek pocztowych email:readGET/api/v1/email/connections/{id}Pobierz połączenie skrzynki pocztowej email:readPATCH/api/v1/email/connections/{id}Zaktualizuj połączenie skrzynki pocztowej email:writeDELETE/api/v1/email/connections/{id}Rozłącz skrzynkę pocztową email:writeGET/api/v1/email/connections/{id}/categoriesLista kategorii e-mail email:readPOST/api/v1/email/connections/{id}/categoriesUtwórz kategorię e-mail email:writeGET/api/v1/email/connections/{id}/foldersLista folderów poczty email:readPOST/api/v1/email/connections/{id}/foldersUtwórz folder poczty email:writeGET/api/v1/email/connections/{id}/activityLista dziennika aktywności e-mail email:readGET/api/v1/email/categories/{id}Pobierz kategorię e-mail email:readPATCH/api/v1/email/categories/{id}Zaktualizuj kategorię e-mail email:writeDELETE/api/v1/email/categories/{id}Usuń kategorię e-mail email:writeGET/api/v1/email/contactsLista kontaktów e-mail email:readGET/api/v1/email/contacts/{id}Pobierz kontakt e-mail email:readPATCH/api/v1/email/contacts/{id}Zaktualizuj kontakt e-mail email:writeDELETE/api/v1/email/contacts/{id}Usuń kontakt e-mail email:write
Konto i powiadomienia
Method Path Description Scope GET/api/v1/mePobierz kontekst klucza (whoami) any key GET/api/v1/account/usagePobierz plan i użycie any key GET/api/v1/notificationsLista powiadomień any key DELETE/api/v1/notificationsUsuń stare przeczytane powiadomienia any key GET/api/v1/notifications/unread-countPobierz liczbę nieprzeczytanych powiadomień any key POST/api/v1/notifications/mark-all-readOznacz wszystkie powiadomienia jako przeczytane any key GET/api/v1/notifications/{id}Pobierz powiadomienie any key PATCH/api/v1/notifications/{id}Oznacz powiadomienie jako przeczytane any key
Blog (platform)
Method Path Description Scope GET/api/v1/blogLista wpisów bloga any key POST/api/v1/blogUtwórz wpis bloga any key POST/api/v1/blog/assetsPrześlij zasób do bloga any key GET/api/v1/blog/{id}Pobierz wpis bloga any key PATCH/api/v1/blog/{id}Zaktualizuj wpis bloga any key DELETE/api/v1/blog/{id}Usuń wpis bloga any key POST/api/v1/blog/{id}/translationsKolejkuj tłumaczenia bloga any key
Potrzebujesz pomocy? Skontaktuj się z naszym zespołem wsparcia →