KezdőlapDokumentáció

REST API

A ChatReact REST API v1 programozott hozzáférést biztosít a támogatott irányítópult-műveletekhez: chatbotok, tudásbázis és feltérképezés, strukturált árak, GYIK, csevegés felülvizsgálat és az Improvement Agent, leadek, kapcsolatfelvételi űrlapok, élő chat, cég és csapat, az Email Assistant, elemzések és értesítések. A böngészőhöz kötött műveletek (fizetések, postafiók engedélyezés, passkeys, fiók törlése és API-kulcs-kezelés) az irányítópulton maradnak.

Inkább egy AI-asszisztenssel beszélne? Ugyanezek a képességek elérhetők MCP eszközként — lásd a MCP Server Integration. Az interaktív API Explorer kérésekkel és válaszsémákkal a /api-reference alatt található, ahol letöltheti az OpenAPI 3.0 specifikációt is.

Hitelesítés

  1. Menjen a Irányítópult → Cég → API fülre és kattintson a API-kulcs létrehozása gombra
  2. Válasszon nevet és adja meg a kulcs számára szükséges jogosultsági köröket (lásd alább)
  3. Másolja ki a kulcsot — cr_-sel kezdődik és csak egyszer jelenik meg

Küldje el a kulcsot minden kérésnél:

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

Egy X-API-Key: cr_your_api_key fejléc is elfogadott. Az API-kulcsok egy céghez tartoznak, és a cég tulajdonosának jogosultságaival hajtódnak végre; a tervkorlátok és funkciózárok pontosan úgy érvényesülnek, mint az irányítópulton.

Az API-hozzáférés fizetős csomagokon érhető el — lásd az Pricing page-t. A kulcsokat bármikor visszavonhatja az irányítópulton.

Jogosultsági körök (Scopes)

Minden kulcs egy vagy több scope-pal rendelkezik. Egy végpont 403-et ad vissza, ha a kulcs nem rendelkezik a szükséges scope-bal.

ScopeJogosultságok
chatbots:read / chatbots:writeChatbot konfiguráció: persona, nyelvek, widget, viselkedés, korlátozások, alaputasítások, beágyazó kód, tanulási fázis, chatbot sablonok, GYIK widget beállítások
knowledge:read / knowledge:writeTudásbázis: dokumentumok, webhelyfeltérképezés, feltérképezett oldalak
faqs:read / faqs:writeGYIK-ek, GYIK kategóriák, javaslatok, fordítások
chats:read / chats:writeCsevegéstörténet, csevegésértékelések, bizalmassági kategóriák, élő chat (ügynöki műveletekhez chats:write szükséges)
leads:read / leads:writeLeadek, lead kategóriák, lead rögzítési beállítások, export
forms:read / forms:writeKapcsolatfelvételi űrlapok és beküldések
analytics:readStatisztikák, aktivitássorozatok, tölcsérek, bizalmassági státusz
company:read / company:writeCégprofil és beállítások, csapattagok, meghívók
email:read / email:writeEmail Assistant kapcsolatok, kategóriák, névjegyek, aktivitás
prices:readStrukturált ár bejegyzések olvasása, revíziók, jogosultság és javaslatok
prices:writeÁrtervezetek létrehozása és szerkesztése, CSV importálása és javaslat alkalmazása tervezetként; a cég tulajdonosát igényli
prices:approvePontos verziók jóváhagyása vagy bejegyzések archiválása; a cég tulajdonosát igényli
blog:read / blog:writePlatform blog tartalom (ChatReact belső)
bármely érvényes kulcs/v1/me, fiókhasználat, az Ön értesítései

Konvenciók

  • Alap URL: https://www.chatreact.ai/api/v1, JSON bemenet és kimenet (Content-Type: application/json).
  • Válaszok: { "success": true, "data": … }; listák "pagination": { "total", "page", "pageSize", "totalPages" } mezőt adnak hozzá. Használja a page és pageSize (max 100) paramétereket listavégpontoknál; néhány végpont kurzor alapú lapozást kínál (cursor / nextCursor).
  • Hibák: { "success": false, "error": "message", "code": "BAD_REQUEST" } opcionális details mezővel validációs hibákhoz. Státuszkódok: 400 érvénytelen bemenet, 401 hiányzó vagy érvénytelen kulcs, 403 hiányzó scope, a terv funkciója nincs benne vagy nem elegendő szerepkör, 404 erőforrás nem található (más cégek erőforrásaira is vonatkozik), 409 ütközés, 429 túl sok kérés (rate limit túllépés).
  • Részleges frissítések: PATCH végpontok csak az elküldött mezőket módosítják; ismeretlen mezők elutasításra kerülnek.
  • Rate limit: 30 kérés percenként IP-címenként.
  • Hosszú futású műveletek (feltérképezések, AI-generálás, fordítások) gyorsan visszatérnek egy munkával vagy eredménnyel, amelyet lekérdezhet; ezek a terv token- és feltérképezési keretét használják.

Végpontok

Prices & services

A mentés, szerkesztés, importálás és javaslat alkalmazása tervezeteket hoz létre jóváhagyás nélkül. A jóváhagyás és archiválás pontos verziókat vizsgál; egy elavult verzió ütközést ad vissza. A meglévő kulcsok automatikusan nem kapnak ár-jogosultságot. Csak a cég tulajdonosa adhat írási vagy jóváhagyási jogosultságot. Az ügyfél munkafolyamatához lásd: Prices & services.

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/pricesLista az árbejegyzésekről és jogosultságrólprices:read
POST/api/v1/chatbots/{id}/pricesTervezet létrehozásaprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}Részletek és lapozható előzmények olvasásaprices:read
PATCH/api/v1/chatbots/{id}/prices/{itemId}Szerkesztett tervezet létrehozása egy várt verzió alapjánprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}/stateTeljes elem állapotának olvasásaprices:read
POST/api/v1/chatbots/{id}/prices/{itemId}/approvePontos verzió jóváhagyásaprices:approve
POST/api/v1/chatbots/{id}/prices/{itemId}/archivePontos verzió archiválásaprices:approve
POST/api/v1/chatbots/{id}/prices/approve-manyExplicit verzió kiválasztás atomikus jóváhagyásaprices:approve
POST/api/v1/chatbots/{id}/prices/importCSV-tervezetek importálása stabil importazonosítóvalprices:write
GET/api/v1/chatbots/{id}/prices/suggestionsÁrjavaslatok listázásaprices:read
POST/api/v1/chatbots/{id}/prices/suggestions/{suggestionId}/applyKiválasztott javaslat alkalmazása tervezetkéntprices:write

Chatbotok

MethodPathDescriptionScope
GET/api/v1/chatbotsChatbotok listázásachatbots:read
POST/api/v1/chatbotsChatbot létrehozásachatbots:write
GET/api/v1/chatbots/{id}Chatbot lekérésechatbots:read
PATCH/api/v1/chatbots/{id}Chatbot frissítésechatbots:write
DELETE/api/v1/chatbots/{id}Chatbot törlésechatbots:write
GET/api/v1/chatbots/{id}/personalityChatbot személyiségének lekérésechatbots:read
PATCH/api/v1/chatbots/{id}/personalityChatbot személyiségének frissítésechatbots:write
GET/api/v1/chatbots/{id}/widgetWidget beállítások lekérésechatbots:read
PATCH/api/v1/chatbots/{id}/widgetWidget beállítások frissítésechatbots:write
GET/api/v1/chatbots/{id}/widget/translationsWidget fordítások lekérésechatbots:read
PUT/api/v1/chatbots/{id}/widget/translationsWidget fordítások cseréjechatbots:write
GET/api/v1/chatbots/{id}/embedBeágyazó kód lekérésechatbots:read
POST/api/v1/chatbots/{id}/embed/confirmBeágyazás megerősítésechatbots:write
GET/api/v1/chatbots/{id}/learning-phaseTanulási fázis beállításainak lekérésechatbots:read
PATCH/api/v1/chatbots/{id}/learning-phaseTanulási fázis beállításainak frissítésechatbots:write
POST/api/v1/chatbots/{id}/learning-phase/endTanulási fázis lezárásachatbots:write
GET/api/v1/chatbots/{id}/instructionsAlaputasítások listázásachatbots:read
POST/api/v1/chatbots/{id}/instructionsAlaputasítás hozzáadásachatbots:write
PUT/api/v1/chatbots/{id}/instructions/reorderAlaputasítások átrendezésechatbots:write
POST/api/v1/chatbots/{id}/instructions/improveUtasítások javítása AI-velchatbots:write
GET/api/v1/instructions/{id}Alaputasítás lekérésechatbots:read
PATCH/api/v1/instructions/{id}Alaputasítás frissítésechatbots:write
DELETE/api/v1/instructions/{id}Alaputasítás törlésechatbots:write
GET/api/v1/chatbot-templatesChatbot sablonok listázásachatbots:read

Tudásbázis

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/knowledgeTudásbázis áttekintésknowledge:read
GET/api/v1/chatbots/{id}/documentsDokumentumok listázása chatbothozknowledge:read
POST/api/v1/chatbots/{id}/documentsDokumentum feltöltéseknowledge:write
POST/api/v1/chatbots/{id}/documents/presignDokumentum feltöltés előzetes aláírása (presign)knowledge:write
GET/api/v1/documents/{id}Dokumentum lekéréseknowledge:read
DELETE/api/v1/documents/{id}Dokumentum törléseknowledge:write
POST/api/v1/documents/{id}/confirmPresigned feltöltés megerősítéseknowledge:write
GET/api/v1/chatbots/{id}/crawl/limitsFeltérképezési kvótákknowledge:read
POST/api/v1/chatbots/{id}/crawl/previewWeboldal előnézet szkenneléseknowledge:write
GET/api/v1/chatbots/{id}/crawlFeltérképezési munkák listájaknowledge:read
POST/api/v1/chatbots/{id}/crawlFeltérképezés indításaknowledge:write
GET/api/v1/crawl-jobs/{jobId}Feltérképezési munka lekéréseknowledge:read
POST/api/v1/crawl-jobs/{jobId}/cancelFeltérképezési munka megszakításaknowledge:write
GET/api/v1/chatbots/{id}/pagesFeltérképezett oldalak listázásaknowledge:read
POST/api/v1/chatbots/{id}/pagesEgyetlen URL hozzáadásaknowledge:write
POST/api/v1/chatbots/{id}/pages/bulk-deleteFeltérképezett oldalak tömeges törléseknowledge:write
GET/api/v1/pages/{id}Feltérképezett oldal lekéréseknowledge:read
DELETE/api/v1/pages/{id}Feltérképezett oldal törléseknowledge:write
POST/api/v1/pages/{id}/recrawlOldal újrafeltérképezéseknowledge:write
GET/api/v1/chatbots/{id}/websitesFeltérképezett webhelyek listázásaknowledge:read
DELETE/api/v1/chatbots/{id}/websites/{domain}Webhely törléseknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawlWebhely újrafeltérképezéseknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawl/cancelWebhely újrafeltérképezésének megszakításaknowledge:write

GYIK (FAQs)

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/faqsGYIK-ek listázása chatbothozfaqs:read
POST/api/v1/chatbots/{id}/faqsGYIK létrehozásafaqs:write
POST/api/v1/chatbots/{id}/faqs/bulkGYIK tömeges importálásafaqs:write
POST/api/v1/chatbots/{id}/faqs/reorderGYIK átrendezésefaqs:write
GET/api/v1/chatbots/{id}/faqs/embedGYIK widget beágyazó kód lekérésechatbots:read
POST/api/v1/chatbots/{id}/faqs/purge-cacheTávoli GYIK cache-k törlésefaqs:write
GET/api/v1/faqs/{id}GYIK lekérésefaqs:read
PATCH/api/v1/faqs/{id}GYIK frissítésefaqs:write
DELETE/api/v1/faqs/{id}GYIK törlésefaqs:write
PUT/api/v1/faqs/{id}/translationsGYIK fordítások frissítésefaqs:write
POST/api/v1/faqs/{id}/translateAI-általi GYIK fordításfaqs:write
GET/api/v1/chatbots/{id}/faq-suggestionsGYIK-javaslatok listázásafaqs:read
POST/api/v1/chatbots/{id}/faq-suggestions/generateGYIK-javaslatok generálása a tudásbázisbólfaqs:write
GET/api/v1/faq-suggestions/{id}GYIK-javaslat lekérésefaqs:read
POST/api/v1/faq-suggestions/{id}/approveGYIK-javaslat jóváhagyásafaqs:write
POST/api/v1/faq-suggestions/{id}/rejectGYIK-javaslat elutasításafaqs:write
GET/api/v1/chatbots/{id}/faq-categoriesGYIK kategóriák listázásafaqs:read
POST/api/v1/chatbots/{id}/faq-categoriesGYIK kategória létrehozásafaqs:write
POST/api/v1/chatbots/{id}/faq-categories/reorderGYIK kategóriák átrendezésefaqs:write
GET/api/v1/faq-categories/{id}GYIK kategória lekérésefaqs:read
PATCH/api/v1/faq-categories/{id}GYIK kategória frissítésefaqs:write
DELETE/api/v1/faq-categories/{id}GYIK kategória törlésefaqs:write
PUT/api/v1/faq-categories/{id}/translationsGYIK kategória fordításainak frissítésefaqs:write
GET/api/v1/chatbots/{id}/faq-widget-settingsGYIK widget beállítások lekérésechatbots:read
PATCH/api/v1/chatbots/{id}/faq-widget-settingsGYIK widget beállítások frissítésechatbots:write

Csevegések, visszajelzés & Improvement Agent

MethodPathDescriptionScope
GET/api/v1/chatsCsevegési munkamenetek listázásachats:read
GET/api/v1/chats/{sessionId}Csevegési munkamenet lekérésechats:read
PATCH/api/v1/chats/{sessionId}Csevegés bizalmassági kategória beállításachats:write
POST/api/v1/chats/{sessionId}/feedbackCsevegés értékelése (Jó / Javítandó)chats:write
POST/api/v1/chats/{sessionId}/feedback/dismissCsevegés felülvizsgálat elutasításachats:write
POST/api/v1/chats/{sessionId}/improveImprovement Agent indítása csevegéshezchatbots:write
GET/api/v1/chatbots/{id}/feedbackChatbot csevegésfelülvizsgálatok listázásachats:read
GET/api/v1/chatbots/{id}/feedback/statsCsevegésfelülvizsgálati stat kártyákchats:read
GET/api/v1/feedback/{id}Csevegésfelülvizsgálat lekérésechats:read
PATCH/api/v1/feedback/{id}Felülvizsgálat súlyosságának felülírásachats:write
POST/api/v1/feedback/{id}/improvement-sessionImprovement Agent indítása felülvizsgálathozchatbots:write
GET/api/v1/chatbots/{id}/confidenceBizalmassági státusz lekéréseanalytics:read
GET/api/v1/chatbots/{id}/confidence-categoriesBizalmassági kategóriák listázásachats:read
POST/api/v1/chatbots/{id}/confidence-categoriesBizalmassági kategória létrehozásachatbots:write
PATCH/api/v1/confidence-categories/{id}Bizalmassági kategória frissítésechatbots:write
DELETE/api/v1/confidence-categories/{id}Bizalmassági kategória törlésechatbots:write
POST/api/v1/confidence-categories/{id}/mergeBizalmassági kategóriák összevonásachatbots:write
GET/api/v1/chatbots/{id}/improvement-sessionsFejlesztési munkamenetek listázásachatbots:read
GET/api/v1/improvement-sessions/{id}Fejlesztési munkamenet lekérésechatbots:read
POST/api/v1/improvement-sessions/{id}/messagesÜzenet küldése az Improvement Agent-hezchatbots:write
POST/api/v1/improvement-sessions/{id}/completeFejlesztési munkamenet befejezésechatbots:write
POST/api/v1/improvement-sessions/{id}/resetFejlesztési munkamenet visszaállításachatbots:write
POST/api/v1/improvement-proposals/{id}/applyFejlesztési javaslat alkalmazásachatbots:write
POST/api/v1/improvement-proposals/{id}/rejectFejlesztési javaslat elutasításachatbots:write
POST/api/v1/improvement-proposals/{id}/simulationsFejlesztési javaslat szimulálásachatbots:write
POST/api/v1/improvement-simulations/{id}/assessmentSzimulációs eredmény értékelésechatbots:write

Leadek

MethodPathDescriptionScope
GET/api/v1/leadsLeadek listázásaleads:read
POST/api/v1/leadsLead létrehozásaleads:write
GET/api/v1/leads/{id}Lead lekéréseleads:read
PATCH/api/v1/leads/{id}Lead frissítéseleads:write
DELETE/api/v1/leads/{id}Lead törléseleads:write
POST/api/v1/leads/{id}/assignLead hozzárendeléseleads:write
POST/api/v1/leads/bulk-statusLead státusz tömeges frissítéseleads:write
GET/api/v1/leads/statsLead statisztikákleads:read
GET/api/v1/leads/exportLead exportálásaleads:read
GET/api/v1/chatbots/{id}/lead-configLead rögzítési konfiguráció lekéréseleads:read
PUT/api/v1/chatbots/{id}/lead-configLead rögzítési konfiguráció frissítéseleads:write
GET/api/v1/chatbots/{id}/lead-categoriesLead kategóriák listázásaleads:read
POST/api/v1/chatbots/{id}/lead-categoriesLead kategória létrehozásaleads:write
GET/api/v1/lead-categories/{id}Lead kategória lekéréseleads:read
PATCH/api/v1/lead-categories/{id}Lead kategória frissítéseleads:write
DELETE/api/v1/lead-categories/{id}Lead kategória törléseleads:write
PUT/api/v1/lead-categories/{id}/users/{userId}Tag hozzárendelése lead kategóriáhozleads:write
DELETE/api/v1/lead-categories/{id}/users/{userId}Tag eltávolítása lead kategóriábólleads:write

Kapcsolatfelvételi űrlapok

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/formsKapcsolatfelvételi űrlapok listázásaforms:read
POST/api/v1/chatbots/{id}/formsKapcsolatfelvételi űrlap létrehozásaforms:write
GET/api/v1/forms/{id}Kapcsolatfelvételi űrlap lekéréseforms:read
PATCH/api/v1/forms/{id}Kapcsolatfelvételi űrlap frissítéseforms:write
DELETE/api/v1/forms/{id}Kapcsolatfelvételi űrlap törléseforms:write
GET/api/v1/forms/{id}/submissionsBeküldések listázásaforms:read
GET/api/v1/forms/{id}/statsBeküldési statisztikákforms:read
GET/api/v1/submissions/{id}Beküldés lekéréseforms:read
PATCH/api/v1/submissions/{id}Beküldés felülvizsgálataforms:write
DELETE/api/v1/submissions/{id}Beküldés törléseforms:write

Élő chat

MethodPathDescriptionScope
GET/api/v1/live-chat/availabilitySaját élő chat elérhetőség lekérésechats:read
PUT/api/v1/live-chat/availabilitySaját élő chat elérhetőség beállításachats:write
POST/api/v1/live-chat/heartbeatJelenlét heartbeat küldésechats:write
GET/api/v1/live-chat/agentsElérhető élő chat ügynökök listázásachats:read
GET/api/v1/live-chat/sessionsÉlő chat munkamenetek listázásachats:read
GET/api/v1/live-chat/sessions/{sessionId}Élő chat munkamenet lekérésechats:read
POST/api/v1/live-chat/sessions/{sessionId}/assignÉlő chat átvétele (hozzárendelés a kulcs tulajdonosához)chats:write
POST/api/v1/live-chat/sessions/{sessionId}/messagesÜzenet küldése ügynökkéntchats:write
POST/api/v1/live-chat/sessions/{sessionId}/closeÉlő chat lezárásachats:write

Elemzések (Analytics)

MethodPathDescriptionScope
GET/api/v1/analyticsElemzések áttekintése lekéréseanalytics:read
GET/api/v1/analytics/activityCsevegés aktivitássorozat lekéréseanalytics:read
GET/api/v1/analytics/chatbotsChatbotonkénti teljesítmény statisztikák listázásaanalytics:read
GET/api/v1/analytics/chatbots/{id}Chatbot elemzések lekéréseanalytics:read
GET/api/v1/analytics/leadsLead tölcsér lekéréseanalytics:read
GET/api/v1/analytics/formsBeküldési statisztikák lekéréseanalytics:read
GET/api/v1/activityFigyelem összegzés lekéréseanalytics:read

Cég & csapat

MethodPathDescriptionScope
GET/api/v1/companyCég lekérésebármely kulcs
PATCH/api/v1/companyCég frissítésecompany:write
GET/api/v1/company/settingsCégbeállítások lekérésecompany:read
PATCH/api/v1/company/settingsCégbeállítások frissítésecompany:write
DELETE/api/v1/company/logoCég logójának eltávolításacompany:write
GET/api/v1/company/membersCsapattagok listázásacompany:read
PATCH/api/v1/company/members/{userId}Tag szerepkörének megváltoztatásacompany:write
DELETE/api/v1/company/members/{userId}Csapattag eltávolításacompany:write
GET/api/v1/company/invitesMeghívók listázásacompany:read
POST/api/v1/company/invitesCsapattag meghívásacompany:write
DELETE/api/v1/company/invites/{id}Meghívás visszavonásacompany:write
POST/api/v1/company/invites/{id}/resendMeghívás újraküldésecompany:write

Email Assistant

MethodPathDescriptionScope
GET/api/v1/email/connectionsPostafiók-kapcsolatok listázásaemail:read
GET/api/v1/email/connections/{id}Postafiók-kapcsolat lekéréseemail:read
PATCH/api/v1/email/connections/{id}Postafiók-kapcsolat frissítéseemail:write
DELETE/api/v1/email/connections/{id}Postafiók lecsatlakoztatásaemail:write
GET/api/v1/email/connections/{id}/categoriesEmail kategóriák listázásaemail:read
POST/api/v1/email/connections/{id}/categoriesEmail kategória létrehozásaemail:write
GET/api/v1/email/connections/{id}/foldersLevelezési mappák listázásaemail:read
POST/api/v1/email/connections/{id}/foldersLevelezési mappa létrehozásaemail:write
GET/api/v1/email/connections/{id}/activityEmail aktivitási napló listázásaemail:read
GET/api/v1/email/categories/{id}Email kategória lekéréseemail:read
PATCH/api/v1/email/categories/{id}Email kategória frissítéseemail:write
DELETE/api/v1/email/categories/{id}Email kategória törléseemail:write
GET/api/v1/email/contactsEmail névjegyek listázásaemail:read
GET/api/v1/email/contacts/{id}Email névjegy lekéréseemail:read
PATCH/api/v1/email/contacts/{id}Email névjegy frissítéseemail:write
DELETE/api/v1/email/contacts/{id}Email névjegy törléseemail:write

Fiók & értesítések

MethodPathDescriptionScope
GET/api/v1/meKulcs kontextus lekérése (whoami)bármely kulcs
GET/api/v1/account/usageTerv és használat lekérésebármely kulcs
GET/api/v1/notificationsÉrtesítések listázásabármely kulcs
DELETE/api/v1/notificationsRégi olvasott értesítések törlésebármely kulcs
GET/api/v1/notifications/unread-countOlvasatlan értesítések számabármely kulcs
POST/api/v1/notifications/mark-all-readMinden értesítés olvasottként jelölésebármely kulcs
GET/api/v1/notifications/{id}Értesítés lekérésebármely kulcs
PATCH/api/v1/notifications/{id}Értesítés olvasottként jelölésebármely kulcs

Blog (platform)

MethodPathDescriptionScope
GET/api/v1/blogBlogbejegyzések listázásabármely kulcs
POST/api/v1/blogBlogbejegyzés létrehozásabármely kulcs
POST/api/v1/blog/assetsBlog asset feltöltésebármely kulcs
GET/api/v1/blog/{id}Blogbejegyzés lekérésebármely kulcs
PATCH/api/v1/blog/{id}Blogbejegyzés frissítésebármely kulcs
DELETE/api/v1/blog/{id}Blogbejegyzés törlésebármely kulcs
POST/api/v1/blog/{id}/translationsBlogfordítások sorba állításabármely kulcs

Szüksége van segítségre? Lépjen kapcsolatba ügyféltámogatásunkkal →