ChatReact
DomůDokumentace

REST API

ChatReact REST API v1 vám poskytuje programatický přístup k podporovaným operacím v dashboardu: chatboti, knowledge base a crawling, strukturované ceny, FAQ, kontrola chatu a Improvement Agent, leads, kontaktní formuláře, live chat, společnost a tým, Email Assistant, analytika a notifikace. Akce vázané na prohlížeč (platby, autorizace schránky, passkeys, smazání účtu a správa API klíčů) zůstávají v dashboardu.

Preferujete komunikaci s AI asistentem? Stejné schopnosti jsou dostupné jako MCP nástroje — viz MCP Server Integration. Interaktivní API Explorer se schématy požadavků a odpovědí je na /api-reference, kde si také můžete stáhnout specifikaci OpenAPI 3.0.

Autentizace

  1. Přejděte do Přehled → Společnost → kartu API a klikněte Vytvořit API klíč
  2. Zvolte název a rozsahy oprávnění, které klíč potřebuje (viz níže)
  3. Zkopírujte klíč — začíná cr_ a je zobrazen pouze jednou

Pošlete klíč s každým požadavkem:

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

Hlavička X-API-Key: cr_your_api_key je také akceptována. API klíče patří jedné společnosti a vykonávají akce s oprávněními vlastníka společnosti; limity plánu a feature gating platí přesně jako v dashboardu.

Přístup k API je dostupný v placených plánech — viz Pricing page. Klíče lze kdykoli zneplatnit z dashboardu.

Rozsahy oprávnění (Scopes)

Každý klíč nese jeden nebo více scope. Endpoint vrátí 403, když klíč postrádá požadovaný scope.

ScopeUmožňuje
chatbots:read / chatbots:writeKonfiguraci chatbotů: persona, jazyky, widget, chování, omezení, hlavní instrukce, embed kód, učící fáze, šablony chatbotů, nastavení FAQ widgetu
knowledge:read / knowledge:writeKnowledge base: dokumenty, procházení webu, procházené stránky
faqs:read / faqs:writeFAQ, kategorie FAQ, návrhy, překlady
chats:read / chats:writeHistorie chatů, hodnocení chatu, kategorie důvěry, live chat (agentní akce vyžadují chats:write)
leads:read / leads:writeLeads, kategorie leadů, nastavení zachytávání leadů, export
forms:read / forms:writeKontaktní formuláře a odeslané formuláře
analytics:readStatistiky, časové řady aktivit, funnely, stav důvěry
company:read / company:writeProfil společnosti a nastavení, členové týmu, pozvánky
email:read / email:writeEmail Assistant připojení, kategorie, kontakty, aktivita
prices:readČtení položek strukturovaných cen, revize, způsobilost a návrhy
prices:writeVytváření a úprava návrhů cen, import CSV a aplikace návrhu jako draft; vyžaduje vlastníka společnosti
prices:approveSchvalování přesných verzí nebo archivace položek; vyžaduje vlastníka společnosti
blog:read / blog:writeObsah platformního blogu (interní ChatReact)
any valid key/v1/me, využití účtu, vaše notifikace

Konvence

  • Base URL: https://www.chatreact.ai/api/v1, JSON dovnitř i ven (Content-Type: application/json).
  • Odpovědi: { "success": true, "data": … }; seznamy přidávají "pagination": { "total", "page", "pageSize", "totalPages" }. Na list endpointech použijte page a pageSize (max 100); některé endpointy nabízejí cursor paginaci (cursor / nextCursor).
  • Chyby: { "success": false, "error": "message", "code": "BAD_REQUEST" } s volitelným details pro validační chyby. Status kódy: 400 neplatný vstup, 401 chybějící nebo neplatný klíč, 403 chybějící scope, feature plánu není zahrnuta nebo nedostatečná role, 404 zdroj nenalezen (také pro zdroje jiných společností), 409 konflikt, 429 překročen rate limit.
  • Částečné aktualizace: PATCH endpointy změní pouze pole, která pošlete; neznámá pole jsou odmítnuta.
  • Rate limit: 30 požadavků za minutu na IP adresu.
  • Dlouhotrvající operace (crawly, AI generace, překlady) vrací rychle job nebo výsledek, který můžete pollovat; spotřebovávají tokeny a crawl budget vašeho plánu.

Endpoints

Prices & services

Ukládání, úprava, import a aplikace návrhu vytváří drafty bez schválení. Operace schválení a archivace prověřují přesné verze; zastaralá verze vrátí konflikt. Existující klíče automaticky nezískávají oprávnění k cenám. Pouze vlastník společnosti může udělit zápisová nebo schvalovací oprávnění. Pro zákaznický workflow viz Prices & services.

MethodPathPopisScope
GET/api/v1/chatbots/{id}/pricesVýpis položek cen a způsobilostiprices:read
POST/api/v1/chatbots/{id}/pricesVytvořit draftprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}Číst detaily a stránkovanou historiiprices:read
PATCH/api/v1/chatbots/{id}/prices/{itemId}Vytvořit upravený draft z očekávané verzeprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}/stateČíst úplný stav položkyprices:read
POST/api/v1/chatbots/{id}/prices/{itemId}/approveSchválit přesnou verziprices:approve
POST/api/v1/chatbots/{id}/prices/{itemId}/archiveArchivovat přesnou verziprices:approve
POST/api/v1/chatbots/{id}/prices/approve-manyAtomicky schválit explicitní výběr verzeprices:approve
POST/api/v1/chatbots/{id}/prices/importImportovat CSV drafty se stabilním import IDprices:write
GET/api/v1/chatbots/{id}/prices/suggestionsVýpis návrhů cenprices:read
POST/api/v1/chatbots/{id}/prices/suggestions/{suggestionId}/applyAplikovat vybraný návrh jako draftprices:write

Chatboti

MethodPathPopisScope
GET/api/v1/chatbotsVýpis chatbotůchatbots:read
POST/api/v1/chatbotsVytvořit chatbotachatbots:write
GET/api/v1/chatbots/{id}Získat chatbotachatbots:read
PATCH/api/v1/chatbots/{id}Aktualizovat chatbotachatbots:write
DELETE/api/v1/chatbots/{id}Smazat chatbotachatbots:write
GET/api/v1/chatbots/{id}/personalityZískat osobnost chatbotachatbots:read
PATCH/api/v1/chatbots/{id}/personalityAktualizovat osobnost chatbotachatbots:write
GET/api/v1/chatbots/{id}/widgetZískat nastavení widgetuchatbots:read
PATCH/api/v1/chatbots/{id}/widgetAktualizovat nastavení widgetuchatbots:write
GET/api/v1/chatbots/{id}/widget/translationsZískat překlady widgetuchatbots:read
PUT/api/v1/chatbots/{id}/widget/translationsNahradit překlady widgetuchatbots:write
GET/api/v1/chatbots/{id}/embedZískat embed kódchatbots:read
POST/api/v1/chatbots/{id}/embed/confirmPotvrdit embedchatbots:write
GET/api/v1/chatbots/{id}/learning-phaseZískat nastavení učící fázechatbots:read
PATCH/api/v1/chatbots/{id}/learning-phaseAktualizovat nastavení učící fázechatbots:write
POST/api/v1/chatbots/{id}/learning-phase/endUkončit učící fázichatbots:write
GET/api/v1/chatbots/{id}/instructionsVýpis hlavních instrukcíchatbots:read
POST/api/v1/chatbots/{id}/instructionsPřidat hlavní instrukcichatbots:write
PUT/api/v1/chatbots/{id}/instructions/reorderPřeskládat hlavní instrukcechatbots:write
POST/api/v1/chatbots/{id}/instructions/improveVylepšit instrukce pomocí AIchatbots:write
GET/api/v1/instructions/{id}Získat hlavní instrukcichatbots:read
PATCH/api/v1/instructions/{id}Aktualizovat hlavní instrukcichatbots:write
DELETE/api/v1/instructions/{id}Smazat hlavní instrukcichatbots:write
GET/api/v1/chatbot-templatesVýpis šablon chatbotůchatbots:read

Knowledge base

MethodPathPopisScope
GET/api/v1/chatbots/{id}/knowledgePřehled knowledge baseknowledge:read
GET/api/v1/chatbots/{id}/documentsVýpis dokumentů pro chatbotaknowledge:read
POST/api/v1/chatbots/{id}/documentsNahrát dokumentknowledge:write
POST/api/v1/chatbots/{id}/documents/presignPřipravit presigned upload dokumentuknowledge:write
GET/api/v1/documents/{id}Získat dokumentknowledge:read
DELETE/api/v1/documents/{id}Smazat dokumentknowledge:write
POST/api/v1/documents/{id}/confirmPotvrdit presigned uploadknowledge:write
GET/api/v1/chatbots/{id}/crawl/limitsLimity crawlováníknowledge:read
POST/api/v1/chatbots/{id}/crawl/previewNáhled skenování webuknowledge:write
GET/api/v1/chatbots/{id}/crawlVýpis crawl jobůknowledge:read
POST/api/v1/chatbots/{id}/crawlSpustit crawlknowledge:write
GET/api/v1/crawl-jobs/{jobId}Získat crawl jobknowledge:read
POST/api/v1/crawl-jobs/{jobId}/cancelZrušit crawl jobknowledge:write
GET/api/v1/chatbots/{id}/pagesVýpis procházených stránekknowledge:read
POST/api/v1/chatbots/{id}/pagesPřidat jednotlivé URLknowledge:write
POST/api/v1/chatbots/{id}/pages/bulk-deleteHromadné smazání procházených stránekknowledge:write
GET/api/v1/pages/{id}Získat procházenou stránkuknowledge:read
DELETE/api/v1/pages/{id}Smazat procházenou stránkuknowledge:write
POST/api/v1/pages/{id}/recrawlZnovu projít stránkuknowledge:write
GET/api/v1/chatbots/{id}/websitesVýpis procházených webůknowledge:read
DELETE/api/v1/chatbots/{id}/websites/{domain}Smazat webknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawlZnovu projít webknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawl/cancelZrušit znovu-procházení webuknowledge:write

FAQs

MethodPathPopisScope
GET/api/v1/chatbots/{id}/faqsVýpis FAQ pro chatbotafaqs:read
POST/api/v1/chatbots/{id}/faqsVytvořit FAQfaqs:write
POST/api/v1/chatbots/{id}/faqs/bulkHromadný import FAQfaqs:write
POST/api/v1/chatbots/{id}/faqs/reorderPřeskládat FAQfaqs:write
GET/api/v1/chatbots/{id}/faqs/embedZískat embed kód FAQ widgetuchatbots:read
POST/api/v1/chatbots/{id}/faqs/purge-cacheVyčistit vzdálené cache FAQfaqs:write
GET/api/v1/faqs/{id}Získat FAQfaqs:read
PATCH/api/v1/faqs/{id}Aktualizovat FAQfaqs:write
DELETE/api/v1/faqs/{id}Smazat FAQfaqs:write
PUT/api/v1/faqs/{id}/translationsAktualizovat překlady FAQfaqs:write
POST/api/v1/faqs/{id}/translatePřeložit FAQ pomocí AIfaqs:write
GET/api/v1/chatbots/{id}/faq-suggestionsVýpis návrhů FAQfaqs:read
POST/api/v1/chatbots/{id}/faq-suggestions/generateGenerovat návrhy FAQ z knowledge basefaqs:write
GET/api/v1/faq-suggestions/{id}Získat návrh FAQfaqs:read
POST/api/v1/faq-suggestions/{id}/approveSchválit návrh FAQfaqs:write
POST/api/v1/faq-suggestions/{id}/rejectOdmítnout návrh FAQfaqs:write
GET/api/v1/chatbots/{id}/faq-categoriesVýpis kategorií FAQfaqs:read
POST/api/v1/chatbots/{id}/faq-categoriesVytvořit kategorii FAQfaqs:write
POST/api/v1/chatbots/{id}/faq-categories/reorderPřeskládat kategorie FAQfaqs:write
GET/api/v1/faq-categories/{id}Získat kategorii FAQfaqs:read
PATCH/api/v1/faq-categories/{id}Aktualizovat kategorii FAQfaqs:write
DELETE/api/v1/faq-categories/{id}Smazat kategorii FAQfaqs:write
PUT/api/v1/faq-categories/{id}/translationsAktualizovat překlady kategorie FAQfaqs:write
GET/api/v1/chatbots/{id}/faq-widget-settingsZískat nastavení FAQ widgetuchatbots:read
PATCH/api/v1/chatbots/{id}/faq-widget-settingsAktualizovat nastavení FAQ widgetuchatbots:write

Chaty, zpětná vazba & Improvement Agent

MethodPathPopisScope
GET/api/v1/chatsVýpis chat sessionchats:read
GET/api/v1/chats/{sessionId}Získat chat sessionchats:read
PATCH/api/v1/chats/{sessionId}Nastavit kategorii důvěry chatuchats:write
POST/api/v1/chats/{sessionId}/feedbackOhodnotit chat (Good / Needs Work)chats:write
POST/api/v1/chats/{sessionId}/feedback/dismissOdmítnout revizi chatuchats:write
POST/api/v1/chats/{sessionId}/improveSpustit Improvement Agent pro chatchatbots:write
GET/api/v1/chatbots/{id}/feedbackVýpis revizí chatů daného chatbotachats:read
GET/api/v1/chatbots/{id}/feedback/statsStatistické karty revizí chatuchats:read
GET/api/v1/feedback/{id}Získat revizi chatuchats:read
PATCH/api/v1/feedback/{id}Přepsat závažnost revizechats:write
POST/api/v1/feedback/{id}/improvement-sessionSpustit Improvement Agent pro revizichatbots:write
GET/api/v1/chatbots/{id}/confidenceZískat stav důvěryanalytics:read
GET/api/v1/chatbots/{id}/confidence-categoriesVýpis kategorií důvěrychats:read
POST/api/v1/chatbots/{id}/confidence-categoriesVytvořit kategorii důvěrychatbots:write
PATCH/api/v1/confidence-categories/{id}Aktualizovat kategorii důvěrychatbots:write
DELETE/api/v1/confidence-categories/{id}Smazat kategorii důvěrychatbots:write
POST/api/v1/confidence-categories/{id}/mergeSloučit kategorie důvěrychatbots:write
GET/api/v1/chatbots/{id}/improvement-sessionsVýpis improvement sessionchatbots:read
GET/api/v1/improvement-sessions/{id}Získat improvement sessionchatbots:read
POST/api/v1/improvement-sessions/{id}/messagesPoslat zprávu Improvement Agentovichatbots:write
POST/api/v1/improvement-sessions/{id}/completeDokončit improvement sessionchatbots:write
POST/api/v1/improvement-sessions/{id}/resetResetovat improvement sessionchatbots:write
POST/api/v1/improvement-proposals/{id}/applyAplikovat návrh zlepšeníchatbots:write
POST/api/v1/improvement-proposals/{id}/rejectOdmítnout návrh zlepšeníchatbots:write
POST/api/v1/improvement-proposals/{id}/simulationsSimulovat návrh zlepšeníchatbots:write
POST/api/v1/improvement-simulations/{id}/assessmentOhodnotit výsledek simulacechatbots:write

Leads

MethodPathPopisScope
GET/api/v1/leadsVýpis leadůleads:read
POST/api/v1/leadsVytvořit leadleads:write
GET/api/v1/leads/{id}Získat leadleads:read
PATCH/api/v1/leads/{id}Aktualizovat leadleads:write
DELETE/api/v1/leads/{id}Smazat leadleads:write
POST/api/v1/leads/{id}/assignPřiřadit leadleads:write
POST/api/v1/leads/bulk-statusHromadná aktualizace stavu leadůleads:write
GET/api/v1/leads/statsStatistiky leadůleads:read
GET/api/v1/leads/exportExport leadůleads:read
GET/api/v1/chatbots/{id}/lead-configZískat konfiguraci zachytávání leadůleads:read
PUT/api/v1/chatbots/{id}/lead-configAktualizovat konfiguraci zachytávání leadůleads:write
GET/api/v1/chatbots/{id}/lead-categoriesVýpis kategorií leadůleads:read
POST/api/v1/chatbots/{id}/lead-categoriesVytvořit kategorii leadůleads:write
GET/api/v1/lead-categories/{id}Získat kategorii leadůleads:read
PATCH/api/v1/lead-categories/{id}Aktualizovat kategorii leadůleads:write
DELETE/api/v1/lead-categories/{id}Smazat kategorii leadůleads:write
PUT/api/v1/lead-categories/{id}/users/{userId}Přiřadit člena ke kategorii leadůleads:write
DELETE/api/v1/lead-categories/{id}/users/{userId}Odebrat člena z kategorie leadůleads:write

Kontaktní formuláře

MethodPathPopisScope
GET/api/v1/chatbots/{id}/formsVýpis kontaktních formulářůforms:read
POST/api/v1/chatbots/{id}/formsVytvořit kontaktní formulářforms:write
GET/api/v1/forms/{id}Získat kontaktní formulářforms:read
PATCH/api/v1/forms/{id}Aktualizovat kontaktní formulářforms:write
DELETE/api/v1/forms/{id}Smazat kontaktní formulářforms:write
GET/api/v1/forms/{id}/submissionsVýpis odeslaných formulářůforms:read
GET/api/v1/forms/{id}/statsStatistiky odeslaných formulářůforms:read
GET/api/v1/submissions/{id}Získat odeslaný formulářforms:read
PATCH/api/v1/submissions/{id}Přezkoumat odeslaný formulářforms:write
DELETE/api/v1/submissions/{id}Smazat odeslaný formulářforms:write

Live chat

MethodPathPopisScope
GET/api/v1/live-chat/availabilityZískat vlastní dostupnost pro live chatchats:read
PUT/api/v1/live-chat/availabilityNastavit vlastní dostupnost pro live chatchats:write
POST/api/v1/live-chat/heartbeatPoslat presence heartbeatchats:write
GET/api/v1/live-chat/agentsVýpis dostupných live chat agentůchats:read
GET/api/v1/live-chat/sessionsVýpis live chat sessionchats:read
GET/api/v1/live-chat/sessions/{sessionId}Získat live chat sessionchats:read
POST/api/v1/live-chat/sessions/{sessionId}/assignPřevzít live chat (přiřadí se vlastníkovi klíče)chats:write
POST/api/v1/live-chat/sessions/{sessionId}/messagesPoslat zprávu jako agentchats:write
POST/api/v1/live-chat/sessions/{sessionId}/closeUkončit live chatchats:write

Analytika

MethodPathPopisScope
GET/api/v1/analyticsZískat přehled analytikyanalytics:read
GET/api/v1/analytics/activityZískat časové řady aktivit chatůanalytics:read
GET/api/v1/analytics/chatbotsVýpis statistik výkonu po chatbotechanalytics:read
GET/api/v1/analytics/chatbots/{id}Získat analytiku chatbotaanalytics:read
GET/api/v1/analytics/leadsZískat funnel leadůanalytics:read
GET/api/v1/analytics/formsZískat statistiky odeslaných formulářůanalytics:read
GET/api/v1/activityZískat souhrn pozornosti (attention summary)analytics:read

Společnost & tým

MethodPathPopisScope
GET/api/v1/companyZískat společnostany key
PATCH/api/v1/companyAktualizovat společnostcompany:write
GET/api/v1/company/settingsZískat nastavení společnosticompany:read
PATCH/api/v1/company/settingsAktualizovat nastavení společnosticompany:write
DELETE/api/v1/company/logoOdebrat logo společnosticompany:write
GET/api/v1/company/membersVýpis členů týmucompany:read
PATCH/api/v1/company/members/{userId}Změnit roli členacompany:write
DELETE/api/v1/company/members/{userId}Odebrat člena týmucompany:write
GET/api/v1/company/invitesVýpis pozvánekcompany:read
POST/api/v1/company/invitesPozvat člena týmucompany:write
DELETE/api/v1/company/invites/{id}Zrušit pozvánkucompany:write
POST/api/v1/company/invites/{id}/resendZnovu odeslat pozvánkucompany:write

Email Assistant

MethodPathPopisScope
GET/api/v1/email/connectionsVýpis připojení schránek (mailbox connections)email:read
GET/api/v1/email/connections/{id}Získat připojení schránkyemail:read
PATCH/api/v1/email/connections/{id}Aktualizovat připojení schránkyemail:write
DELETE/api/v1/email/connections/{id}Odpojit schránkuemail:write
GET/api/v1/email/connections/{id}/categoriesVýpis emailových kategoriíemail:read
POST/api/v1/email/connections/{id}/categoriesVytvořit emailovou kategoriiemail:write
GET/api/v1/email/connections/{id}/foldersVýpis mail složekemail:read
POST/api/v1/email/connections/{id}/foldersVytvořit mail složkuemail:write
GET/api/v1/email/connections/{id}/activityVýpis logu emailové aktivityemail:read
GET/api/v1/email/categories/{id}Získat emailovou kategoriiemail:read
PATCH/api/v1/email/categories/{id}Aktualizovat emailovou kategoriiemail:write
DELETE/api/v1/email/categories/{id}Smazat emailovou kategoriiemail:write
GET/api/v1/email/contactsVýpis emailových kontaktůemail:read
GET/api/v1/email/contacts/{id}Získat emailový kontaktemail:read
PATCH/api/v1/email/contacts/{id}Aktualizovat emailový kontaktemail:write
DELETE/api/v1/email/contacts/{id}Smazat emailový kontaktemail:write

Účet & notifikace

MethodPathPopisScope
GET/api/v1/meZískat kontext klíče (whoami)any key
GET/api/v1/account/usageZískat plán a využitíany key
GET/api/v1/notificationsVýpis notifikacíany key
DELETE/api/v1/notificationsSmazat staré přečtené notifikaceany key
GET/api/v1/notifications/unread-countZískat počet nepřečtených notifikacíany key
POST/api/v1/notifications/mark-all-readOznačit všechny notifikace jako přečtenéany key
GET/api/v1/notifications/{id}Získat notifikaciany key
PATCH/api/v1/notifications/{id}Označit notifikaci jako přečtenouany key

Blog (platforma)

MethodPathPopisScope
GET/api/v1/blogVýpis blog postůany key
POST/api/v1/blogVytvořit blog postany key
POST/api/v1/blog/assetsNahrát asset pro blogany key
GET/api/v1/blog/{id}Získat blog postany key
PATCH/api/v1/blog/{id}Aktualizovat blog postany key
DELETE/api/v1/blog/{id}Smazat blog postany key
POST/api/v1/blog/{id}/translationsZařadit překlady blogu do frontyany key

Potřebujete pomoc? Kontaktujte náš support tým →

Předchozí
Shopify Integrace
Další
Integrace MCP serveru