ChatReact
DomovDokumentacija

REST API

REST API v1 ChatReact vam omogoča programatičen dostop do podprtih operacij na nadzorni plošči: klepetalni roboti, baza znanja in indeksiranje, strukturirane cene, FAQ, pregled klepetov in Improvement Agent, leads, kontaktni obrazci, live chat, podjetje in ekipa, Email Assistant, analitika in obvestila. Dejavnosti, vezane na brskalnik (plačila, pooblaščenje poštnega predala, passkeys, izbris računa in upravljanje API ključev) ostanejo v nadzorni plošči.

Raje komunicirate z AI pomočnikom? Enake zmogljivosti so na voljo kot MCP orodja — glejte MCP Server Integration. Interaktivni API Explorer z shemami zahtev in odgovorov je na /api-reference, kjer lahko tudi prenesete OpenAPI 3.0 specifikacijo.

Avtentikacija

  1. Pojdite v Nadzorna plošča → Podjetje → API zavihek in kliknite Ustvari API ključ
  2. Izberite ime in dovoljenja (obsege), ki jih potrebuje ključ (glejte spodaj)
  3. Kopirajte ključ — začne se z cr_ in je viden samo enkrat

Pošljite ključ z vsako zahtevo:

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

Sprejema se tudi X-API-Key: cr_your_api_key header. API ključi pripadajo enemu podjetju in se izvršujejo z dovoljenji lastnika podjetja; omejitve načrta in feature gate-i veljajo enako kot v nadzorni plošči.

API dostop je na voljo na plačljivih načrtih — glejte Pricing page. Ključe lahko kadarkoli prekličete iz nadzorne plošče.

Obsegi (Scopes)

Vsak ključ nosi enega ali več obsegov. Končna točka vrne 403, če ključ nima zahtevane pooblastilne obsega.

ScopeGrants
chatbots:read / chatbots:writeKonfiguracija chatbotov: persona, jeziki, widget, vedenje, omejitve, osnovna navodila, embed koda, faza učenja, predloge chatbotov, nastavitve FAQ widgeta
knowledge:read / knowledge:writeBaza znanja: dokumenti, indeksiranje spletnih strani, indeksirane strani
faqs:read / faqs:writeFAQ, kategorije FAQ, predlogi, prevodi
chats:read / chats:writeZgodovina klepetov, ocene klepetov, kategorije zaupanja, live chat (akcije agentov zahtevajo chats:write)
leads:read / leads:writeLeads, kategorije leadov, nastavitve zajema leadov, izvoz
forms:read / forms:writeKontaktni obrazci in oddaje
analytics:readStatistika, serije aktivnosti, lijaki, status zaupanja
company:read / company:writeProfil podjetja in nastavitve, člani ekipe, povabila
email:read / email:writeEmail Assistant povezave, kategorije, kontakti, aktivnost
prices:readBranje strukturiranih vnosov cen, revizije, upravičenost in predlogi
prices:writeUstvarjanje in urejanje osnutkov cen, uvoz CSV in uporaba predloga kot osnutek; zahteva lastnika podjetja
prices:approvePotrditev natančnih različic ali arhiviranje vnosov; zahteva lastnika podjetja
blog:read / blog:writeVsebina platformnega bloga (notranje za ChatReact)
any valid key/v1/me, uporaba računa, vaša obvestila

Konvencije

  • Base URL: https://www.chatreact.ai/api/v1, JSON v vhodu in izhodu (Content-Type: application/json).
  • Odgovori: { "success": true, "data": … }; seznami dodajo "pagination": { "total", "page", "pageSize", "totalPages" }. Na endpointih za sezname uporabljajte page in pageSize (največ 100); nekateri endpointi ponujajo cursor paginacijo (cursor / nextCursor).
  • Napake: { "success": false, "error": "message", "code": "BAD_REQUEST" } z izbirnim details za validacijske napake. Statusne kode: 400 neveljaven vnos, 401 manjkajoč ali neveljaven ključ, 403 manjkajoč obseg, funkcija načrta ni vključena ali nezadostna vloga, 404 vir ni najden (tudi za vire drugih podjetij), 409 konflikt, 429 prekoračitev omejitve zahtevkov.
  • Delne posodobitve: PATCH endpointi spreminjajo le polja, ki jih pošljete; neznana polja so zavrnjena.
  • Omejitev zahtevkov: 30 zahtevkov na minuto na IP naslov.
  • Dolgotrajne operacije (indeksiranje, AI generacija, prevodi) se vrnejo hitro z nalogo ali rezultatom, ki ga lahko polirate; porabijo žeton in indeksacijski proračun vašega načrta.

Končne točke

Prices & services

Shranjevanje, urejanje, uvažanje in uporaba predloga ustvarijo osnutke brez odobritve. Operacije odobritve in arhiviranja pregledajo natančne različice; zastarela različica vrne konflikt. Obstoječi ključi samodejno ne pridobijo dovoljenj za cene. Le lastnik podjetja lahko dodeli pisna ali odobritvena dovoljenja. Za potek dela stranke glejte Prices & services.

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/pricesSeznam vnosov cen in upravičenostprices:read
POST/api/v1/chatbots/{id}/pricesUstvari osnutekprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}Preberi podrobnosti in strani z zgodovinoprices:read
PATCH/api/v1/chatbots/{id}/prices/{itemId}Ustvari urejen osnutek iz pričakovane različiceprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}/statePreberi celotno stanje elementaprices:read
POST/api/v1/chatbots/{id}/prices/{itemId}/approvePotrdi natančno različicoprices:approve
POST/api/v1/chatbots/{id}/prices/{itemId}/archiveArhiviraj natančno različicoprices:approve
POST/api/v1/chatbots/{id}/prices/approve-manyAtomarno potrditev izrecne izbire različiceprices:approve
POST/api/v1/chatbots/{id}/prices/importUvoz CSV osnutkov s stabilnim ID uvozaprices:write
GET/api/v1/chatbots/{id}/prices/suggestionsSeznam predlogov cenprices:read
POST/api/v1/chatbots/{id}/prices/suggestions/{suggestionId}/applyUporabi izbran predlog kot osnutekprices:write

Chatbots

MethodPathDescriptionScope
GET/api/v1/chatbotsSeznam chatbotovchatbots:read
POST/api/v1/chatbotsUstvari chatbotchatbots:write
GET/api/v1/chatbots/{id}Pridobi chatbotchatbots:read
PATCH/api/v1/chatbots/{id}Posodobi chatbotchatbots:write
DELETE/api/v1/chatbots/{id}Izbriši chatbotchatbots:write
GET/api/v1/chatbots/{id}/personalityPridobi osebnost chatbotachatbots:read
PATCH/api/v1/chatbots/{id}/personalityPosodobi osebnost chatbotachatbots:write
GET/api/v1/chatbots/{id}/widgetPridobi nastavitve widgetachatbots:read
PATCH/api/v1/chatbots/{id}/widgetPosodobi nastavitve widgetachatbots:write
GET/api/v1/chatbots/{id}/widget/translationsPridobi prevode widgetachatbots:read
PUT/api/v1/chatbots/{id}/widget/translationsZamenjaj prevode widgetachatbots:write
GET/api/v1/chatbots/{id}/embedPridobi embed kodochatbots:read
POST/api/v1/chatbots/{id}/embed/confirmPotrdi embedchatbots:write
GET/api/v1/chatbots/{id}/learning-phasePridobi nastavitve faze učenjachatbots:read
PATCH/api/v1/chatbots/{id}/learning-phasePosodobi nastavitve faze učenjachatbots:write
POST/api/v1/chatbots/{id}/learning-phase/endZaključi fazo učenjachatbots:write
GET/api/v1/chatbots/{id}/instructionsSeznam osnovnih navodilchatbots:read
POST/api/v1/chatbots/{id}/instructionsDodaj osnovno navodilochatbots:write
PUT/api/v1/chatbots/{id}/instructions/reorderPreureditev osnovnih navodilchatbots:write
POST/api/v1/chatbots/{id}/instructions/improveIzboljšaj navodila z AIchatbots:write
GET/api/v1/instructions/{id}Pridobi osnovno navodilochatbots:read
PATCH/api/v1/instructions/{id}Posodobi osnovno navodilochatbots:write
DELETE/api/v1/instructions/{id}Izbriši osnovno navodilochatbots:write
GET/api/v1/chatbot-templatesSeznam predlog chatbotovchatbots:read

Knowledge base

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/knowledgePregled baze znanjaknowledge:read
GET/api/v1/chatbots/{id}/documentsSeznam dokumentov za chatbotaknowledge:read
POST/api/v1/chatbots/{id}/documentsNaloži dokumentknowledge:write
POST/api/v1/chatbots/{id}/documents/presignPredpodpiši nalaganje dokumentaknowledge:write
GET/api/v1/documents/{id}Pridobi dokumentknowledge:read
DELETE/api/v1/documents/{id}Izbriši dokumentknowledge:write
POST/api/v1/documents/{id}/confirmPotrdi predpodpisano nalaganjeknowledge:write
GET/api/v1/chatbots/{id}/crawl/limitsOmejitve indeksiranjaknowledge:read
POST/api/v1/chatbots/{id}/crawl/previewPredogled skeniranja spletne straniknowledge:write
GET/api/v1/chatbots/{id}/crawlSeznam opravil indeksiranjaknowledge:read
POST/api/v1/chatbots/{id}/crawlZačni indeksiranjeknowledge:write
GET/api/v1/crawl-jobs/{jobId}Pridobi opravilo indeksiranjaknowledge:read
POST/api/v1/crawl-jobs/{jobId}/cancelPrekliči opravilo indeksiranjaknowledge:write
GET/api/v1/chatbots/{id}/pagesSeznam indeksiranih straniknowledge:read
POST/api/v1/chatbots/{id}/pagesDodaj en URLknowledge:write
POST/api/v1/chatbots/{id}/pages/bulk-deleteMasovno brisanje indeksiranih straniknowledge:write
GET/api/v1/pages/{id}Pridobi indeksirano stranknowledge:read
DELETE/api/v1/pages/{id}Izbriši indeksirano stranknowledge:write
POST/api/v1/pages/{id}/recrawlPonovno indeksiraj stranknowledge:write
GET/api/v1/chatbots/{id}/websitesSeznam indeksiranih spletnih mestknowledge:read
DELETE/api/v1/chatbots/{id}/websites/{domain}Izbriši spletno mestoknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawlPonovno indeksiraj spletno mestoknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawl/cancelPrekliči ponovno indeksiranje spletnega mestaknowledge:write

FAQs

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/faqsSeznam FAQ za chatbotafaqs:read
POST/api/v1/chatbots/{id}/faqsUstvari FAQfaqs:write
POST/api/v1/chatbots/{id}/faqs/bulkMasovni uvoz FAQfaqs:write
POST/api/v1/chatbots/{id}/faqs/reorderPreureditev FAQfaqs:write
GET/api/v1/chatbots/{id}/faqs/embedPridobi embed kodo FAQ widgetachatbots:read
POST/api/v1/chatbots/{id}/faqs/purge-cacheIzprazni oddaljene FAQ cache-efaqs:write
GET/api/v1/faqs/{id}Pridobi FAQfaqs:read
PATCH/api/v1/faqs/{id}Posodobi FAQfaqs:write
DELETE/api/v1/faqs/{id}Izbriši FAQfaqs:write
PUT/api/v1/faqs/{id}/translationsPosodobi prevode FAQfaqs:write
POST/api/v1/faqs/{id}/translateAI-prevod FAQfaqs:write
GET/api/v1/chatbots/{id}/faq-suggestionsSeznam predlogov FAQfaqs:read
POST/api/v1/chatbots/{id}/faq-suggestions/generateGeneriraj predloge FAQ iz baze znanjafaqs:write
GET/api/v1/faq-suggestions/{id}Pridobi predlog FAQfaqs:read
POST/api/v1/faq-suggestions/{id}/approvePotrdi predlog FAQfaqs:write
POST/api/v1/faq-suggestions/{id}/rejectZavrni predlog FAQfaqs:write
GET/api/v1/chatbots/{id}/faq-categoriesSeznam kategorij FAQfaqs:read
POST/api/v1/chatbots/{id}/faq-categoriesUstvari kategorijo FAQfaqs:write
POST/api/v1/chatbots/{id}/faq-categories/reorderPreureditev kategorij FAQfaqs:write
GET/api/v1/faq-categories/{id}Pridobi kategorijo FAQfaqs:read
PATCH/api/v1/faq-categories/{id}Posodobi kategorijo FAQfaqs:write
DELETE/api/v1/faq-categories/{id}Izbriši kategorijo FAQfaqs:write
PUT/api/v1/faq-categories/{id}/translationsPosodobi prevode kategorije FAQfaqs:write
GET/api/v1/chatbots/{id}/faq-widget-settingsPridobi nastavitve FAQ widgetachatbots:read
PATCH/api/v1/chatbots/{id}/faq-widget-settingsPosodobi nastavitve FAQ widgetachatbots:write

Klepeti, povratne informacije & Improvement Agent

MethodPathDescriptionScope
GET/api/v1/chatsSeznam sej klepetachats:read
GET/api/v1/chats/{sessionId}Pridobi sejo klepetachats:read
PATCH/api/v1/chats/{sessionId}Nastavi kategorijo zaupanja klepetachats:write
POST/api/v1/chats/{sessionId}/feedbackOcenite klepet (Good / Needs Work)chats:write
POST/api/v1/chats/{sessionId}/feedback/dismissZavrni pregled klepetachats:write
POST/api/v1/chats/{sessionId}/improveZaženi Improvement Agent za klepetchatbots:write
GET/api/v1/chatbots/{id}/feedbackSeznam pregledov klepetov za chatbotachats:read
GET/api/v1/chatbots/{id}/feedback/statsStatistične kartice pregledov klepetovchats:read
GET/api/v1/feedback/{id}Pridobi pregled klepetachats:read
PATCH/api/v1/feedback/{id}Prepišite resnost pregledachats:write
POST/api/v1/feedback/{id}/improvement-sessionZaženi Improvement Agent za pregledchatbots:write
GET/api/v1/chatbots/{id}/confidencePridobi status zaupanjaanalytics:read
GET/api/v1/chatbots/{id}/confidence-categoriesSeznam kategorij zaupanjachats:read
POST/api/v1/chatbots/{id}/confidence-categoriesUstvari kategorijo zaupanjachatbots:write
PATCH/api/v1/confidence-categories/{id}Posodobi kategorijo zaupanjachatbots:write
DELETE/api/v1/confidence-categories/{id}Izbriši kategorijo zaupanjachatbots:write
POST/api/v1/confidence-categories/{id}/mergeZdruži kategorije zaupanjachatbots:write
GET/api/v1/chatbots/{id}/improvement-sessionsSeznam izboljšavnih sejchatbots:read
GET/api/v1/improvement-sessions/{id}Pridobi izboljšavno sejochatbots:read
POST/api/v1/improvement-sessions/{id}/messagesPošlji sporočilo Improvement Agentuchatbots:write
POST/api/v1/improvement-sessions/{id}/completeZaključi izboljšavno sejochatbots:write
POST/api/v1/improvement-sessions/{id}/resetPonastavi izboljšavno sejochatbots:write
POST/api/v1/improvement-proposals/{id}/applyUporabi izboljšavni predlogchatbots:write
POST/api/v1/improvement-proposals/{id}/rejectZavrni izboljšavni predlogchatbots:write
POST/api/v1/improvement-proposals/{id}/simulationsSimuliraj izboljšavni predlogchatbots:write
POST/api/v1/improvement-simulations/{id}/assessmentOcenite rezultat simulacijechatbots:write

Leads

MethodPathDescriptionScope
GET/api/v1/leadsSeznam leadovleads:read
POST/api/v1/leadsUstvari leadleads:write
GET/api/v1/leads/{id}Pridobi leadleads:read
PATCH/api/v1/leads/{id}Posodobi leadleads:write
DELETE/api/v1/leads/{id}Izbriši leadleads:write
POST/api/v1/leads/{id}/assignDodeli leadleads:write
POST/api/v1/leads/bulk-statusMasovna posodobitev statusa leadovleads:write
GET/api/v1/leads/statsStatistika leadovleads:read
GET/api/v1/leads/exportIzvoz leadovleads:read
GET/api/v1/chatbots/{id}/lead-configPridobi konfiguracijo zajema leadovleads:read
PUT/api/v1/chatbots/{id}/lead-configPosodobi konfiguracijo zajema leadovleads:write
GET/api/v1/chatbots/{id}/lead-categoriesSeznam kategorij leadovleads:read
POST/api/v1/chatbots/{id}/lead-categoriesUstvari kategorijo leadovleads:write
GET/api/v1/lead-categories/{id}Pridobi kategorijo leadovleads:read
PATCH/api/v1/lead-categories/{id}Posodobi kategorijo leadovleads:write
DELETE/api/v1/lead-categories/{id}Izbriši kategorijo leadovleads:write
PUT/api/v1/lead-categories/{id}/users/{userId}Dodeli člana kategoriji leadovleads:write
DELETE/api/v1/lead-categories/{id}/users/{userId}Odstrani člana iz kategorije leadovleads:write

Kontaktni obrazci

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/formsSeznam kontaktnih obrazcevforms:read
POST/api/v1/chatbots/{id}/formsUstvari kontaktni obrazecforms:write
GET/api/v1/forms/{id}Pridobi kontaktni obrazecforms:read
PATCH/api/v1/forms/{id}Posodobi kontaktni obrazecforms:write
DELETE/api/v1/forms/{id}Izbriši kontaktni obrazecforms:write
GET/api/v1/forms/{id}/submissionsSeznam oddaj obrazcevforms:read
GET/api/v1/forms/{id}/statsStatistika oddaj obrazcevforms:read
GET/api/v1/submissions/{id}Pridobi oddajo obrazcaforms:read
PATCH/api/v1/submissions/{id}Pregled oddaje obrazcaforms:write
DELETE/api/v1/submissions/{id}Izbriši oddajo obrazcaforms:write

Live chat

MethodPathDescriptionScope
GET/api/v1/live-chat/availabilityPridobi lastno razpoložljivost za live chatchats:read
PUT/api/v1/live-chat/availabilityNastavi lastno razpoložljivost za live chatchats:write
POST/api/v1/live-chat/heartbeatPošlji heartbeat prisotnostichats:write
GET/api/v1/live-chat/agentsSeznam razpoložljivih agentov za live chatchats:read
GET/api/v1/live-chat/sessionsSeznam sej live chatachats:read
GET/api/v1/live-chat/sessions/{sessionId}Pridobi sejo live chatachats:read
POST/api/v1/live-chat/sessions/{sessionId}/assignPrevzemi live chat (dodeli lastniku ključa)chats:write
POST/api/v1/live-chat/sessions/{sessionId}/messagesPošlji sporočilo kot agentchats:write
POST/api/v1/live-chat/sessions/{sessionId}/closeZaključi live chatchats:write

Analitika

MethodPathDescriptionScope
GET/api/v1/analyticsPridobi pregled analitikeanalytics:read
GET/api/v1/analytics/activityPridobi serijo aktivnosti klepetaanalytics:read
GET/api/v1/analytics/chatbotsSeznam statistike učinkovitosti po chatbotuanalytics:read
GET/api/v1/analytics/chatbots/{id}Pridobi analitiko chatbotaanalytics:read
GET/api/v1/analytics/leadsPridobi lijak leadovanalytics:read
GET/api/v1/analytics/formsPridobi statistiko oddaj obrazcevanalytics:read
GET/api/v1/activityPridobi povzetek pozornostianalytics:read

Podjetje & ekipa

MethodPathDescriptionScope
GET/api/v1/companyPridobi podjetjeany key
PATCH/api/v1/companyPosodobi podjetjecompany:write
GET/api/v1/company/settingsPridobi nastavitve podjetjacompany:read
PATCH/api/v1/company/settingsPosodobi nastavitve podjetjacompany:write
DELETE/api/v1/company/logoOdstrani logo podjetjacompany:write
GET/api/v1/company/membersSeznam članov ekipecompany:read
PATCH/api/v1/company/members/{userId}Spremeni vlogo članacompany:write
DELETE/api/v1/company/members/{userId}Odstrani člana ekipecompany:write
GET/api/v1/company/invitesSeznam povabilcompany:read
POST/api/v1/company/invitesPovabi člana ekipecompany:write
DELETE/api/v1/company/invites/{id}Prekliči povabilocompany:write
POST/api/v1/company/invites/{id}/resendPonovno pošlji povabilocompany:write

Email Assistant

MethodPathDescriptionScope
GET/api/v1/email/connectionsSeznam povezav poštnih predalovemail:read
GET/api/v1/email/connections/{id}Pridobi povezavo poštnega predalaemail:read
PATCH/api/v1/email/connections/{id}Posodobi povezavo poštnega predalaemail:write
DELETE/api/v1/email/connections/{id}Odklopi poštni predalemail:write
GET/api/v1/email/connections/{id}/categoriesSeznam e-poštnih kategorijemail:read
POST/api/v1/email/connections/{id}/categoriesUstvari e-poštno kategorijoemail:write
GET/api/v1/email/connections/{id}/foldersSeznam map pošteemail:read
POST/api/v1/email/connections/{id}/foldersUstvari mapo pošteemail:write
GET/api/v1/email/connections/{id}/activitySeznam dnevnika aktivnosti e-pošteemail:read
GET/api/v1/email/categories/{id}Pridobi e-poštno kategorijoemail:read
PATCH/api/v1/email/categories/{id}Posodobi e-poštno kategorijoemail:write
DELETE/api/v1/email/categories/{id}Izbriši e-poštno kategorijoemail:write
GET/api/v1/email/contactsSeznam e-poštnih kontaktovemail:read
GET/api/v1/email/contacts/{id}Pridobi e-poštni kontaktemail:read
PATCH/api/v1/email/contacts/{id}Posodobi e-poštni kontaktemail:write
DELETE/api/v1/email/contacts/{id}Izbriši e-poštni kontaktemail:write

Račun & obvestila

MethodPathDescriptionScope
GET/api/v1/mePridobi kontekst ključa (whoami)any key
GET/api/v1/account/usagePridobi načrt in uporaboany key
GET/api/v1/notificationsSeznam obvestilany key
DELETE/api/v1/notificationsIzbriši stara prebrana obvestilaany key
GET/api/v1/notifications/unread-countPridobi število neprebranih obvestilany key
POST/api/v1/notifications/mark-all-readOznači vsa obvestila kot prebranaany key
GET/api/v1/notifications/{id}Pridobi obvestiloany key
PATCH/api/v1/notifications/{id}Označi obvestilo kot prebranoany key

Blog (platforma)

MethodPathDescriptionScope
GET/api/v1/blogSeznam objav na bloguany key
POST/api/v1/blogUstvari objavo na bloguany key
POST/api/v1/blog/assetsNaloži asset za blogany key
GET/api/v1/blog/{id}Pridobi objavo na bloguany key
PATCH/api/v1/blog/{id}Posodobi objavo na bloguany key
DELETE/api/v1/blog/{id}Izbriši objavo na bloguany key
POST/api/v1/blog/{id}/translationsVstavi objave v čakalno vrsto za prevodeany key

Potrebujete pomoč? Kontaktirajte našo podporo →

Prejšnje
Shopify integracija
Naslednje
Integracija MCP strežnika