ChatReact
DomovDokumentácia

REST API

ChatReact REST API v1 poskytuje programatický prístup k podporovaným operáciám z dashboardu: chatboti, knowledge base a crawlovanie, štruktúrované ceny, FAQs, revízia chatov a Improvement Agent, leads, kontaktné formuláre, live chat, spoločnosť a tím, Email Assistant, analytika a notifikácie. Akcie viazané na prehliadač (platby, autorizácia mailboxu, passkeys, zmazanie účtu a správa API kľúčov) zostávajú v dashboarde.

Preferujete komunikáciu s AI asistentom? Rovnaké schopnosti sú dostupné ako MCP nástroje — pozrite si MCP Server Integration. Interaktívny API Explorer so schémami požiadaviek a odpovedí nájdete na /api-reference, kde si môžete tiež stiahnuť špecifikáciu OpenAPI 3.0.

Autentifikácia

  1. Prejdite do Dashboard → Spoločnosť → záložka API a kliknite Vytvoriť API kľúč
  2. Zvoľte názov a povolenia (scopes), ktoré kľúč potrebuje (viď nižšie)
  3. Skopírujte kľúč — začína na cr_ a je zobrazený iba raz

Posielajte kľúč s každým requestom:

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

Prijatý je aj header X-API-Key: cr_your_api_key. API kľúče patria jednej spoločnosti a vykonávajú sa s právami vlastníka spoločnosti; limity plánu a feature gating sa uplatňujú presne ako v dashboarde.

API prístup je dostupný v platených plánoch — pozrite si Pricing page. Kľúče je možné kedykoľvek zrušiť z dashboardu.

Scopes

Každý kľúč nesie jeden alebo viac scopes. Endpoint vráti 403, ak kľúču chýba požadovaný scope.

ScopeGrants
chatbots:read / chatbots:writeKonfigurácia chatbota: persona, jazyky, widget, správanie, obmedzenia, základné inštrukcie, embed kód, fáza učenia, šablóny chatbotov, nastavenia FAQ widgetu
knowledge:read / knowledge:writeKnowledge base: dokumenty, crawlovanie webu, zachytené stránky
faqs:read / faqs:writeFAQs, kategórie FAQ, návrhy, preklady
chats:read / chats:writeHistória chatov, hodnotenia chatov, confidence kategórie, live chat (agent akcie vyžadujú chats:write)
leads:read / leads:writeLeads, kategórie leadov, nastavenia zachytávania leadov, export
forms:read / forms:writeKontaktné formuláre a podania
analytics:readŠtatistiky, časové rady aktivít, funnel-y, confidence status
company:read / company:writeProfil spoločnosti a nastavenia, členovia tímu, pozvánky
email:read / email:writeEmail Assistant pripojenia, kategórie, kontakty, aktivita
prices:readČítanie záznamov štruktúrovaných cien, revízie, oprávnenosť a návrhy
prices:writeVytváranie a úprava návrhov cien, import CSV a aplikovanie návrhu ako draft; vyžaduje vlastníka spoločnosti
prices:approveSchválenie presných verzií alebo archivácia záznamov; vyžaduje vlastníka spoločnosti
blog:read / blog:writeObsah blogu platformy (vnútorné ChatReact)
any valid key/v1/me, využitie účtu, vaše notifikácie

Konvencie

  • Base URL: https://www.chatreact.ai/api/v1, JSON dovnútra aj von (Content-Type: application/json).
  • Odpovede: { "success": true, "data": … }; zoznamy pridávajú "pagination": { "total", "page", "pageSize", "totalPages" }. Použite page a pageSize (max 100) na endpointoch so zoznamom; niektoré endpointy ponúkajú cursor pagináciu (cursor / nextCursor).
  • Chyby: { "success": false, "error": "message", "code": "BAD_REQUEST" } s voliteľným details pre validačné chyby. Stavové kódy: 400 neplatný vstup, 401 chýbajúci alebo neplatný kľúč, 403 chýbajúci scope, funkcia nie je v pláne alebo nedostatočná rola, 404 zdroj nenájdený (aj pre zdroje iných spoločností), 409 konflikt, 429 prekročený rate limit.
  • Čiastočné aktualizácie: PATCH endpointy menia len polia, ktoré pošlete; neznáme polia sú odmietnuté.
  • Rate limit: 30 požiadaviek za minútu na IP adresu.
  • Dlhodobé operácie (crawly, AI generovanie, preklady) vracajú rýchlo job alebo výsledok, ktorý môžete pollovať; spotrebúvajú token a crawl budget vášho plánu.

Endpoints

Prices & services

Ukladanie, úprava, importovanie a aplikovanie návrhu vytvára návrhy (drafty) bez schválenia. Operácie schválenia a archivácie prehliadajú presné verzie; zastaralá verzia vráti konflikt. Existujúce kľúče automaticky nezískavajú povolenia pre ceny. Iba vlastník spoločnosti môže udeliť práva na zápis alebo schvaľovanie. Pre workflow pre zákazníka pozrite Prices & services.

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/pricesZoznam záznamov cien a oprávnenosťprices:read
POST/api/v1/chatbots/{id}/pricesVytvoriť draftprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}Prečítať detaily a stránkovanú históriuprices:read
PATCH/api/v1/chatbots/{id}/prices/{itemId}Vytvoriť upravený draft z očakávanej verzieprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}/statePrečítať úplný stav položkyprices:read
POST/api/v1/chatbots/{id}/prices/{itemId}/approveSchváliť presnú verziuprices:approve
POST/api/v1/chatbots/{id}/prices/{itemId}/archiveArchivovať presnú verziuprices:approve
POST/api/v1/chatbots/{id}/prices/approve-manyAtomicky schváliť explicitný výber verzieprices:approve
POST/api/v1/chatbots/{id}/prices/importImportovať CSV drafty so stabilným import IDprices:write
GET/api/v1/chatbots/{id}/prices/suggestionsZoznam návrhov cienprices:read
POST/api/v1/chatbots/{id}/prices/suggestions/{suggestionId}/applyAplikovať vybraný návrh ako draftprices:write

Chatboti

MethodPathDescriptionScope
GET/api/v1/chatbotsZoznam chatbotovchatbots:read
POST/api/v1/chatbotsVytvoriť chatbotachatbots:write
GET/api/v1/chatbots/{id}Získať chatbotachatbots:read
PATCH/api/v1/chatbots/{id}Aktualizovať chatbotachatbots:write
DELETE/api/v1/chatbots/{id}Odstrániť chatbotachatbots:write
GET/api/v1/chatbots/{id}/personalityZískať osobnosť chatbotachatbots:read
PATCH/api/v1/chatbots/{id}/personalityAktualizovať osobnosť chatbotachatbots:write
GET/api/v1/chatbots/{id}/widgetZískať nastavenia widgetuchatbots:read
PATCH/api/v1/chatbots/{id}/widgetAktualizovať nastavenia widgetuchatbots:write
GET/api/v1/chatbots/{id}/widget/translationsZískať preklady widgetuchatbots:read
PUT/api/v1/chatbots/{id}/widget/translationsNahradiť preklady widgetuchatbots:write
GET/api/v1/chatbots/{id}/embedZískať embed kódchatbots:read
POST/api/v1/chatbots/{id}/embed/confirmPotvrdiť embedchatbots:write
GET/api/v1/chatbots/{id}/learning-phaseZískať nastavenia fázy učeniachatbots:read
PATCH/api/v1/chatbots/{id}/learning-phaseAktualizovať nastavenia fázy učeniachatbots:write
POST/api/v1/chatbots/{id}/learning-phase/endUkončiť fázu učeniachatbots:write
GET/api/v1/chatbots/{id}/instructionsZoznam základných inštrukciíchatbots:read
POST/api/v1/chatbots/{id}/instructionsPridať základnú inštrukciuchatbots:write
PUT/api/v1/chatbots/{id}/instructions/reorderZoradiť základné inštrukciechatbots:write
POST/api/v1/chatbots/{id}/instructions/improveVylepšiť inštrukcie pomocou AIchatbots:write
GET/api/v1/instructions/{id}Získať základnú inštrukciuchatbots:read
PATCH/api/v1/instructions/{id}Aktualizovať základnú inštrukciuchatbots:write
DELETE/api/v1/instructions/{id}Odstrániť základnú inštrukciuchatbots:write
GET/api/v1/chatbot-templatesZoznam šablón chatbotovchatbots:read

Knowledge base

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/knowledgePrehľad knowledge baseknowledge:read
GET/api/v1/chatbots/{id}/documentsZoznam dokumentov pre chatbotaknowledge:read
POST/api/v1/chatbots/{id}/documentsNahrať dokumentknowledge:write
POST/api/v1/chatbots/{id}/documents/presignPredsignovať nahrávanie dokumentuknowledge:write
GET/api/v1/documents/{id}Získať dokumentknowledge:read
DELETE/api/v1/documents/{id}Odstrániť dokumentknowledge:write
POST/api/v1/documents/{id}/confirmPotvrdiť predsigned uploadknowledge:write
GET/api/v1/chatbots/{id}/crawl/limitsLimity crawlovaniaknowledge:read
POST/api/v1/chatbots/{id}/crawl/previewNáhľad skenovania webuknowledge:write
GET/api/v1/chatbots/{id}/crawlZoznam crawl jobovknowledge:read
POST/api/v1/chatbots/{id}/crawlSpustiť crawlknowledge:write
GET/api/v1/crawl-jobs/{jobId}Získať crawl jobknowledge:read
POST/api/v1/crawl-jobs/{jobId}/cancelZrušiť crawl jobknowledge:write
GET/api/v1/chatbots/{id}/pagesZoznam zachytených stránokknowledge:read
POST/api/v1/chatbots/{id}/pagesPridať single URLknowledge:write
POST/api/v1/chatbots/{id}/pages/bulk-deleteHromadné odstránenie zachytených stránokknowledge:write
GET/api/v1/pages/{id}Získať zachytenú stránkuknowledge:read
DELETE/api/v1/pages/{id}Odstrániť zachytenú stránkuknowledge:write
POST/api/v1/pages/{id}/recrawlRe-crawl stránkyknowledge:write
GET/api/v1/chatbots/{id}/websitesZoznam zachytených webovknowledge:read
DELETE/api/v1/chatbots/{id}/websites/{domain}Odstrániť webknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawlRe-crawl webknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawl/cancelZrušiť re-crawl webuknowledge:write

FAQs

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/faqsZoznam FAQ pre chatbotafaqs:read
POST/api/v1/chatbots/{id}/faqsVytvoriť FAQfaqs:write
POST/api/v1/chatbots/{id}/faqs/bulkHromadný import FAQfaqs:write
POST/api/v1/chatbots/{id}/faqs/reorderZoradiť FAQfaqs:write
GET/api/v1/chatbots/{id}/faqs/embedZískať embed kód FAQ widgetuchatbots:read
POST/api/v1/chatbots/{id}/faqs/purge-cacheVyčistiť vzdialené cache FAQfaqs:write
GET/api/v1/faqs/{id}Získať FAQfaqs:read
PATCH/api/v1/faqs/{id}Aktualizovať FAQfaqs:write
DELETE/api/v1/faqs/{id}Odstrániť FAQfaqs:write
PUT/api/v1/faqs/{id}/translationsAktualizovať preklady FAQfaqs:write
POST/api/v1/faqs/{id}/translateAI-preložiť FAQfaqs:write
GET/api/v1/chatbots/{id}/faq-suggestionsZoznam návrhov FAQfaqs:read
POST/api/v1/chatbots/{id}/faq-suggestions/generateGenerovať návrhy FAQ z knowledge basefaqs:write
GET/api/v1/faq-suggestions/{id}Získať návrh FAQfaqs:read
POST/api/v1/faq-suggestions/{id}/approveSchváliť návrh FAQfaqs:write
POST/api/v1/faq-suggestions/{id}/rejectOdmietnuť návrh FAQfaqs:write
GET/api/v1/chatbots/{id}/faq-categoriesZoznam kategórií FAQfaqs:read
POST/api/v1/chatbots/{id}/faq-categoriesVytvoriť kategóriu FAQfaqs:write
POST/api/v1/chatbots/{id}/faq-categories/reorderZoradiť kategórie FAQfaqs:write
GET/api/v1/faq-categories/{id}Získať kategóriu FAQfaqs:read
PATCH/api/v1/faq-categories/{id}Aktualizovať kategóriu FAQfaqs:write
DELETE/api/v1/faq-categories/{id}Odstrániť kategóriu FAQfaqs:write
PUT/api/v1/faq-categories/{id}/translationsAktualizovať preklady kategórie FAQfaqs:write
GET/api/v1/chatbots/{id}/faq-widget-settingsZískať nastavenia FAQ widgetuchatbots:read
PATCH/api/v1/chatbots/{id}/faq-widget-settingsAktualizovať nastavenia FAQ widgetuchatbots:write

Chaty, feedback & Improvement Agent

MethodPathDescriptionScope
GET/api/v1/chatsZoznam chat sessionovchats:read
GET/api/v1/chats/{sessionId}Získať chat sessionchats:read
PATCH/api/v1/chats/{sessionId}Nastaviť confidence kategóriu chatuchats:write
POST/api/v1/chats/{sessionId}/feedbackOhodnotiť chat (Good / Needs Work)chats:write
POST/api/v1/chats/{sessionId}/feedback/dismissUpozornenie na revíziu chatu (dismiss)chats:write
POST/api/v1/chats/{sessionId}/improveSpustiť Improvement Agent pre chatchatbots:write
GET/api/v1/chatbots/{id}/feedbackZoznam revízií chatov pre chatbotachats:read
GET/api/v1/chatbots/{id}/feedback/statsŠtatistické karty revízií chatovchats:read
GET/api/v1/feedback/{id}Získať revíziu chatuchats:read
PATCH/api/v1/feedback/{id}Prepísať závažnosť revíziechats:write
POST/api/v1/feedback/{id}/improvement-sessionSpustiť Improvement Agent pre revíziuchatbots:write
GET/api/v1/chatbots/{id}/confidenceZískať confidence statusanalytics:read
GET/api/v1/chatbots/{id}/confidence-categoriesZoznam confidence kategóriíchats:read
POST/api/v1/chatbots/{id}/confidence-categoriesVytvoriť confidence kategóriuchatbots:write
PATCH/api/v1/confidence-categories/{id}Aktualizovať confidence kategóriuchatbots:write
DELETE/api/v1/confidence-categories/{id}Odstrániť confidence kategóriuchatbots:write
POST/api/v1/confidence-categories/{id}/mergeZlúčiť confidence kategóriechatbots:write
GET/api/v1/chatbots/{id}/improvement-sessionsZoznam improvement sessionovchatbots:read
GET/api/v1/improvement-sessions/{id}Získať improvement sessionchatbots:read
POST/api/v1/improvement-sessions/{id}/messagesPoslať správu Improvement Agentovichatbots:write
POST/api/v1/improvement-sessions/{id}/completeDokončiť improvement sessionchatbots:write
POST/api/v1/improvement-sessions/{id}/resetResetovať improvement sessionchatbots:write
POST/api/v1/improvement-proposals/{id}/applyAplikovať návrh zlepšeniachatbots:write
POST/api/v1/improvement-proposals/{id}/rejectOdmietnuť návrh zlepšeniachatbots:write
POST/api/v1/improvement-proposals/{id}/simulationsSimulovať návrh zlepšeniachatbots:write
POST/api/v1/improvement-simulations/{id}/assessmentOhodnotiť výsledok simuláciechatbots:write

Leads

MethodPathDescriptionScope
GET/api/v1/leadsZoznam leadovleads:read
POST/api/v1/leadsVytvoriť leadleads:write
GET/api/v1/leads/{id}Získať leadleads:read
PATCH/api/v1/leads/{id}Aktualizovať leadleads:write
DELETE/api/v1/leads/{id}Odstrániť leadleads:write
POST/api/v1/leads/{id}/assignPriradiť leadleads:write
POST/api/v1/leads/bulk-statusHromadná aktualizácia statusu leadovleads:write
GET/api/v1/leads/statsŠtatistiky leadovleads:read
GET/api/v1/leads/exportExport leadovleads:read
GET/api/v1/chatbots/{id}/lead-configZískať konfiguráciu zachytávania leadovleads:read
PUT/api/v1/chatbots/{id}/lead-configAktualizovať konfiguráciu zachytávania leadovleads:write
GET/api/v1/chatbots/{id}/lead-categoriesZoznam kategórií leadovleads:read
POST/api/v1/chatbots/{id}/lead-categoriesVytvoriť kategóriu leadovleads:write
GET/api/v1/lead-categories/{id}Získať kategóriu leaduleads:read
PATCH/api/v1/lead-categories/{id}Aktualizovať kategóriu leaduleads:write
DELETE/api/v1/lead-categories/{id}Odstrániť kategóriu leaduleads:write
PUT/api/v1/lead-categories/{id}/users/{userId}Priradiť člena ku kategórii leaduleads:write
DELETE/api/v1/lead-categories/{id}/users/{userId}Odstrániť člena z kategórie leaduleads:write

Kontaktné formuláre

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/formsZoznam kontaktných formulárovforms:read
POST/api/v1/chatbots/{id}/formsVytvoriť kontaktný formulárforms:write
GET/api/v1/forms/{id}Získať kontaktný formulárforms:read
PATCH/api/v1/forms/{id}Aktualizovať kontaktný formulárforms:write
DELETE/api/v1/forms/{id}Odstrániť kontaktný formulárforms:write
GET/api/v1/forms/{id}/submissionsZoznam podaní formuláraforms:read
GET/api/v1/forms/{id}/statsŠtatistiky podaní formuláraforms:read
GET/api/v1/submissions/{id}Získať podanie formuláraforms:read
PATCH/api/v1/submissions/{id}Preskúmať podanie formuláraforms:write
DELETE/api/v1/submissions/{id}Odstrániť podanie formuláraforms:write

Live chat

MethodPathDescriptionScope
GET/api/v1/live-chat/availabilityZískať vlastnú dostupnosť pre live chatchats:read
PUT/api/v1/live-chat/availabilityNastaviť vlastnú dostupnosť pre live chatchats:write
POST/api/v1/live-chat/heartbeatPoslať heartbeat prítomnostichats:write
GET/api/v1/live-chat/agentsZoznam dostupných live chat agentovchats:read
GET/api/v1/live-chat/sessionsZoznam live chat sessionovchats:read
GET/api/v1/live-chat/sessions/{sessionId}Získať live chat sessionchats:read
POST/api/v1/live-chat/sessions/{sessionId}/assignPrevziať live chat (priradiť vlastníkovi kľúča)chats:write
POST/api/v1/live-chat/sessions/{sessionId}/messagesPoslať správu ako agentchats:write
POST/api/v1/live-chat/sessions/{sessionId}/closeUkončiť live chatchats:write

Analytika

MethodPathDescriptionScope
GET/api/v1/analyticsZískať prehľad analytikyanalytics:read
GET/api/v1/analytics/activityZískať časové rady aktivity chatovanalytics:read
GET/api/v1/analytics/chatbotsZoznam štatistík výkonnosti podľa chatbotaanalytics:read
GET/api/v1/analytics/chatbots/{id}Získať analytiku chatbotaanalytics:read
GET/api/v1/analytics/leadsZískať lead funnelanalytics:read
GET/api/v1/analytics/formsZískať štatistiky podaní formulárovanalytics:read
GET/api/v1/activityZískať súhrn pozornosti (attention summary)analytics:read

Spoločnosť & tím

MethodPathDescriptionScope
GET/api/v1/companyZískať spoločnosťany key
PATCH/api/v1/companyAktualizovať spoločnosťcompany:write
GET/api/v1/company/settingsZískať nastavenia spoločnosticompany:read
PATCH/api/v1/company/settingsAktualizovať nastavenia spoločnosticompany:write
DELETE/api/v1/company/logoOdstrániť logo spoločnosticompany:write
GET/api/v1/company/membersZoznam členov tímucompany:read
PATCH/api/v1/company/members/{userId}Zmeniť rolu členacompany:write
DELETE/api/v1/company/members/{userId}Odstrániť člena tímucompany:write
GET/api/v1/company/invitesZoznam pozvánokcompany:read
POST/api/v1/company/invitesPozvať člena tímucompany:write
DELETE/api/v1/company/invites/{id}Zrušiť pozvánkucompany:write
POST/api/v1/company/invites/{id}/resendPreposlať pozvánkucompany:write

Email Assistant

MethodPathDescriptionScope
GET/api/v1/email/connectionsZoznam pripojení mailboxovemail:read
GET/api/v1/email/connections/{id}Získať pripojenie mailboxuemail:read
PATCH/api/v1/email/connections/{id}Aktualizovať pripojenie mailboxuemail:write
DELETE/api/v1/email/connections/{id}Odpojiť mailboxemail:write
GET/api/v1/email/connections/{id}/categoriesZoznam email kategóriíemail:read
POST/api/v1/email/connections/{id}/categoriesVytvoriť email kategóriuemail:write
GET/api/v1/email/connections/{id}/foldersZoznam mail folderovemail:read
POST/api/v1/email/connections/{id}/foldersVytvoriť mail folderemail:write
GET/api/v1/email/connections/{id}/activityZoznam logu email aktivítemail:read
GET/api/v1/email/categories/{id}Získať email kategóriuemail:read
PATCH/api/v1/email/categories/{id}Aktualizovať email kategóriuemail:write
DELETE/api/v1/email/categories/{id}Odstrániť email kategóriuemail:write
GET/api/v1/email/contactsZoznam email kontaktovemail:read
GET/api/v1/email/contacts/{id}Získať email kontaktemail:read
PATCH/api/v1/email/contacts/{id}Aktualizovať email kontaktemail:write
DELETE/api/v1/email/contacts/{id}Odstrániť email kontaktemail:write

Účet & notifikácie

MethodPathDescriptionScope
GET/api/v1/meZískať kontext kľúča (whoami)any key
GET/api/v1/account/usageZískať plán a využitieany key
GET/api/v1/notificationsZoznam notifikáciíany key
DELETE/api/v1/notificationsOdstrániť staré prečítané notifikácieany key
GET/api/v1/notifications/unread-countZískať počet neprečítaných notifikáciíany key
POST/api/v1/notifications/mark-all-readOznačiť všetky notifikácie ako prečítanéany key
GET/api/v1/notifications/{id}Získať notifikáciuany key
PATCH/api/v1/notifications/{id}Označiť notifikáciu ako prečítanúany key

Blog (platforma)

MethodPathDescriptionScope
GET/api/v1/blogZoznam blogových príspevkovany key
POST/api/v1/blogVytvoriť blogový príspevokany key
POST/api/v1/blog/assetsNahrať blogový assetany key
GET/api/v1/blog/{id}Získať blogový príspevokany key
PATCH/api/v1/blog/{id}Aktualizovať blogový príspevokany key
DELETE/api/v1/blog/{id}Odstrániť blogový príspevokany key
POST/api/v1/blog/{id}/translationsZaradiť preklady blogu do frontyany key

Potrebujete pomoc? Kontaktujte náš tím podpory →

Predchádzajúce
Integrácia Shopify
Ďalšie
Integrácia MCP servera