ChatReact
AvalehtDokumentatsioon

REST API

ChatReact REST API v1 annab teile programmipõhise ligipääsu toetatud juhtpaneeli toimingutele: vestlusbotid, teadmistebaas ja indekseerimine, struktureeritud hinnad, KKK, vestluste ülevaatus ja Improvement Agent, lead’id, kontaktivormid, reaalajas vestlus, ettevõte ja meeskond, Email Assistant, analüütika ja teavitused. Brauserisse piiratud toimingud (maksed, postkasti autoriseerimine, passkeyd, konto kustutamine ja API võtitestamine) jäävad juhtpaneelile.

Eelistate rääkida AI-abilisega? Samad võimalused on saadaval ka MCP tööriistadena — vaadake MCP Server Integration. Interaktiivne API Explorer koos päringu- ja vastuse skeemidega asub aadressil /api-reference, kust saate alla laadida ka OpenAPI 3.0 spetsifikatsiooni.

Autentimine

  1. Minge Töölauavaade → Ettevõte → API vahekaardile ja klõpsake Loo API-võti
  2. Valige nimi ja võtme õiguste ulatus (vt allpool)
  3. Kopeerige võti — see algab cr_ ja kuvatakse vaid ühe korra

Saatke võti iga päringuga:

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

X-API-Key: cr_your_api_key päis on samuti aktsepteeritav. API võtmed kuuluvad ühele ettevõttele ja täidavad toiminguid ettevõtte omaniku õigustega; plaani piirangud ja funktsioonipõhised piirangud kehtivad täpselt samamoodi nagu juhtpaneelil.

API ligipääs on saadaval tasulistel plaanidel — vt Pricing page. Võtmeid saab igal ajal juhtpaneelilt tagasi võtta.

Õigused (scopes)

Igal võtmel on üks või mitu õigust. Lõpp-punkt tagastab 403, kui võti ei oma nõutavat õigust.

ScopeGrants
chatbots:read / chatbots:writeVestlusboti konfiguratsioon: persona, keeled, widget, käitumine, piirangud, põhijuhised, embed-kood, õppetsükkel, vestlusboti mallid, KKK widgeti seaded
knowledge:read / knowledge:writeTeadmistebaas: dokumendid, veebisaidi indekseerimine, indekseeritud lehed
faqs:read / faqs:writeKKK, KKK kategooriad, soovitused, tõlked
chats:read / chats:writeVestluste ajalugu, vestluste hinnangud, usaldus-kategooriad, reaalajas vestlus (agendi toimingud vajavad chats:write)
leads:read / leads:writeLead’id, lead-kategooriad, lead-i kogumise seaded, eksport
forms:read / forms:writeKontaktivormid ja esitatud vastused
analytics:readStatistika, tegevussarja andmed, konversioonilehtrid, usalduse staatus
company:read / company:writeEttevõtte profiil ja seaded, meeskonnaliikmed, kutsed
email:read / email:writeEmail Assistant ühendused, kategooriad, kontaktid, tegevused
prices:readStruktureeritud hinna kirjetega lugemine, revisjonid, sobivus ja soovitused
prices:writeHindade mustandite loomine ja redigeerimine, CSV import ja soovituse rakendamine mustandina; nõuab ettevõtte omanikku
prices:approveTäpse versiooni kinnitamine või kirjete arhiveerimine; nõuab ettevõtte omanikku
blog:read / blog:writePlatvormi blogisisu (ChatReact sisemine)
any valid key/v1/me, konto kasutus, teie teavitused

Konventsioonid

  • Baasaadress: https://www.chatreact.ai/api/v1, JSON sisend ja väljund (Content-Type: application/json).
  • Vastused: { "success": true, "data": … }; loendite puhul lisatakse "pagination": { "total", "page", "pageSize", "totalPages" }. Kasutage page ja pageSize (maks. 100) loendi lõpp-punktidel; mõnel lõpp-punktil on kursori-pagineerimine (cursor / nextCursor).
  • Vead: { "success": false, "error": "message", "code": "BAD_REQUEST" } koos valikulise details väljaga valideerimisvigade jaoks. Staatuse koodid: 400 vale sisend, 401 puudu või vigane võti, 403 puudu olev õigus, plaani funktsioon puudub või roll ebapiisav, 404 ressurss puudub (sh teiste ettevõtete ressursid), 409 konflikt, 429 kiirusepiirang ületatud.
  • Osalised uuendused: PATCH lõpp-punktid muudavad ainult välju, mida saadate; tundmatud väljad lükatakse tagasi.
  • Kiirusepiirang: 30 päringut minutis ühe IP-aadressi kohta.
  • Pikalt kestvad toimingud (indekseerimised, AI genereerimine, tõlked) tagastavad kiiresti töö või tulemuse, mida saate küsida; need tarbivad teie plaani token- ja indekseerimiskvooti.

Lõpp-punktid

Hinnad ja teenused

Hoidmine, redigeerimine, importimine ja soovituse rakendamine loovad kinnitusteta mustandid. Kinnituse ja arhiveerimise toimingud vaatlevad täpseid versioone; aegunud versioon tagastab konflikti. Olemasolevad võtmed ei saa automaatselt hinnakirja õigusi. Ainult ettevõtte omanik saab anda kirjutus- või kinnitamisõigusi. Klienditöövoo kohta vaadake Prices & services.

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/pricesHindakirjete ja sobivuse väljanäitamineprices:read
POST/api/v1/chatbots/{id}/pricesMustandi loomineprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}Detailide ja leheküljestatud ajaloo lugemineprices:read
PATCH/api/v1/chatbots/{id}/prices/{itemId}Muudetud mustandi loomine eeldatavast versioonistprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}/stateTäieliku kirje oleku lugemineprices:read
POST/api/v1/chatbots/{id}/prices/{itemId}/approveTäpse versiooni kinnitamineprices:approve
POST/api/v1/chatbots/{id}/prices/{itemId}/archiveTäpse versiooni arhiveerimineprices:approve
POST/api/v1/chatbots/{id}/prices/approve-manyTäieliku versioonivaliku atomaarne kinnitamineprices:approve
POST/api/v1/chatbots/{id}/prices/importCSV-mustandite import stabiilse import-ID-gaprices:write
GET/api/v1/chatbots/{id}/prices/suggestionsHinnasoovituste loeteluprices:read
POST/api/v1/chatbots/{id}/prices/suggestions/{suggestionId}/applyValitud soovituse rakendamine mustandinaprices:write

Vestlusbotid

MethodPathDescriptionScope
GET/api/v1/chatbotsVestlusbotide loeteluchatbots:read
POST/api/v1/chatbotsVestlusboti loominechatbots:write
GET/api/v1/chatbots/{id}Vestlusboti päringchatbots:read
PATCH/api/v1/chatbots/{id}Vestlusboti uuendaminechatbots:write
DELETE/api/v1/chatbots/{id}Vestlusboti kustutaminechatbots:write
GET/api/v1/chatbots/{id}/personalityVestlusboti isiksuse päringchatbots:read
PATCH/api/v1/chatbots/{id}/personalityVestlusboti isiksuse uuendaminechatbots:write
GET/api/v1/chatbots/{id}/widgetWidgeti seadete päringchatbots:read
PATCH/api/v1/chatbots/{id}/widgetWidgeti seadete uuendaminechatbots:write
GET/api/v1/chatbots/{id}/widget/translationsWidgeti tõlgete päringchatbots:read
PUT/api/v1/chatbots/{id}/widget/translationsWidgeti tõlgete asendaminechatbots:write
GET/api/v1/chatbots/{id}/embedEmbed-koodi päringchatbots:read
POST/api/v1/chatbots/{id}/embed/confirmEmbed-koodi kinnitaminechatbots:write
GET/api/v1/chatbots/{id}/learning-phaseÕppetsükli seadete päringchatbots:read
PATCH/api/v1/chatbots/{id}/learning-phaseÕppetsükli seadete uuendaminechatbots:write
POST/api/v1/chatbots/{id}/learning-phase/endÕppetsükli lõpetaminechatbots:write
GET/api/v1/chatbots/{id}/instructionsPõhijuhiste loeteluchatbots:read
POST/api/v1/chatbots/{id}/instructionsPõhijuhise lisaminechatbots:write
PUT/api/v1/chatbots/{id}/instructions/reorderPõhijuhiste järjekorra muutminechatbots:write
POST/api/v1/chatbots/{id}/instructions/improveJuhiste parandamine AI abilchatbots:write
GET/api/v1/instructions/{id}Põhijuhise päringchatbots:read
PATCH/api/v1/instructions/{id}Põhijuhise uuendaminechatbots:write
DELETE/api/v1/instructions/{id}Põhijuhise kustutaminechatbots:write
GET/api/v1/chatbot-templatesVestlusboti mallide loeteluchatbots:read

Teadmistebaas

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/knowledgeTeadmistebaasi ülevaadeknowledge:read
GET/api/v1/chatbots/{id}/documentsDokumendi loetelu vestlusboti jaoksknowledge:read
POST/api/v1/chatbots/{id}/documentsDokumendi üleslaadimineknowledge:write
POST/api/v1/chatbots/{id}/documents/presignEelallkirjastatud dokumendi üleslaadimineknowledge:write
GET/api/v1/documents/{id}Dokumendi päringknowledge:read
DELETE/api/v1/documents/{id}Dokumendi kustutamineknowledge:write
POST/api/v1/documents/{id}/confirmEelallkirjastatud üleslaadimise kinnitamineknowledge:write
GET/api/v1/chatbots/{id}/crawl/limitsIndekeerimispiirangudknowledge:read
POST/api/v1/chatbots/{id}/crawl/previewVeebisaidi skaneeringu eelvaadeknowledge:write
GET/api/v1/chatbots/{id}/crawlIndekeerimistööde loeteluknowledge:read
POST/api/v1/chatbots/{id}/crawlIndekeerimise alustamineknowledge:write
GET/api/v1/crawl-jobs/{jobId}Indekeerimistöö päringknowledge:read
POST/api/v1/crawl-jobs/{jobId}/cancelIndekeerimistöö tühistamineknowledge:write
GET/api/v1/chatbots/{id}/pagesIndekeeritud lehtede loeteluknowledge:read
POST/api/v1/chatbots/{id}/pagesÜhe URL-i lisamineknowledge:write
POST/api/v1/chatbots/{id}/pages/bulk-deleteIndekeeritud lehtede hulgikustutamineknowledge:write
GET/api/v1/pages/{id}Indekeeritud lehe päringknowledge:read
DELETE/api/v1/pages/{id}Indekeeritud lehe kustutamineknowledge:write
POST/api/v1/pages/{id}/recrawlLehe uuesti indekseerimineknowledge:write
GET/api/v1/chatbots/{id}/websitesIndekeeritud veebisaitide loeteluknowledge:read
DELETE/api/v1/chatbots/{id}/websites/{domain}Veebisaidi kustutamineknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawlVeebisaidi uuesti indekseerimineknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawl/cancelVeebisaidi uuesti indekseerimise tühistamineknowledge:write

KKK

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/faqsKKK-de loetelu vestlusboti jaoksfaqs:read
POST/api/v1/chatbots/{id}/faqsKKK loominefaqs:write
POST/api/v1/chatbots/{id}/faqs/bulkKKK-de hulgimassimportfaqs:write
POST/api/v1/chatbots/{id}/faqs/reorderKKK-de järjekorra muutminefaqs:write
GET/api/v1/chatbots/{id}/faqs/embedKKK widgeti embed-koodi päringchatbots:read
POST/api/v1/chatbots/{id}/faqs/purge-cacheKKK-de kaugtuuma puhastaminefaqs:write
GET/api/v1/faqs/{id}KKK päringfaqs:read
PATCH/api/v1/faqs/{id}KKK uuendaminefaqs:write
DELETE/api/v1/faqs/{id}KKK kustutaminefaqs:write
PUT/api/v1/faqs/{id}/translationsKKK tõlgete uuendaminefaqs:write
POST/api/v1/faqs/{id}/translateKKK AI-tõlgefaqs:write
GET/api/v1/chatbots/{id}/faq-suggestionsKKK soovituste loetelufaqs:read
POST/api/v1/chatbots/{id}/faq-suggestions/generateSoovituste genereerimine teadmistebaasistfaqs:write
GET/api/v1/faq-suggestions/{id}KKK-soovituse päringfaqs:read
POST/api/v1/faq-suggestions/{id}/approveKKK-soovituse kinnitaminefaqs:write
POST/api/v1/faq-suggestions/{id}/rejectKKK-soovituse tagasilükkaminefaqs:write
GET/api/v1/chatbots/{id}/faq-categoriesKKK kategooriate loetelufaqs:read
POST/api/v1/chatbots/{id}/faq-categoriesKKK kategooria loominefaqs:write
POST/api/v1/chatbots/{id}/faq-categories/reorderKKK kategooriate järjekorra muutminefaqs:write
GET/api/v1/faq-categories/{id}KKK kategooria päringfaqs:read
PATCH/api/v1/faq-categories/{id}KKK kategooria uuendaminefaqs:write
DELETE/api/v1/faq-categories/{id}KKK kategooria kustutaminefaqs:write
PUT/api/v1/faq-categories/{id}/translationsKKK kategooria tõlgete uuendaminefaqs:write
GET/api/v1/chatbots/{id}/faq-widget-settingsKKK widgeti seadete päringchatbots:read
PATCH/api/v1/chatbots/{id}/faq-widget-settingsKKK widgeti seadete uuendaminechatbots:write

Vestlused, tagasiside & Improvement Agent

MethodPathDescriptionScope
GET/api/v1/chatsVestlussessioonide loeteluchats:read
GET/api/v1/chats/{sessionId}Vestlussessiooni päringchats:read
PATCH/api/v1/chats/{sessionId}Vestluse usalduskategooria määraminechats:write
POST/api/v1/chats/{sessionId}/feedbackVestluse hindamine (Hea / Vajab parandamist)chats:write
POST/api/v1/chats/{sessionId}/feedback/dismissVestluse ülevaatuse hülgamise toimingchats:write
POST/api/v1/chats/{sessionId}/improveImprovement Agenti käivitamine vestluse jaokschatbots:write
GET/api/v1/chatbots/{id}/feedbackVestlusülevaatuste loetelu vestlusboti kohtachats:read
GET/api/v1/chatbots/{id}/feedback/statsVestluse ülevaatuse statistika kaartide päringchats:read
GET/api/v1/feedback/{id}Ülevaatuse päringchats:read
PATCH/api/v1/feedback/{id}Ülevaatuse raskusastme määramine üle kirjutadeschats:write
POST/api/v1/feedback/{id}/improvement-sessionImprovement Agenti käivitamine ülevaatuse jaokschatbots:write
GET/api/v1/chatbots/{id}/confidenceUsalduse staatuse päringanalytics:read
GET/api/v1/chatbots/{id}/confidence-categoriesUsalduse kategooriate loeteluchats:read
POST/api/v1/chatbots/{id}/confidence-categoriesUsalduse kategooria loominechatbots:write
PATCH/api/v1/confidence-categories/{id}Usalduse kategooria uuendaminechatbots:write
DELETE/api/v1/confidence-categories/{id}Usalduse kategooria kustutaminechatbots:write
POST/api/v1/confidence-categories/{id}/mergeUsalduse kategooriate ühendaminechatbots:write
GET/api/v1/chatbots/{id}/improvement-sessionsParandussessioonide loeteluchatbots:read
GET/api/v1/improvement-sessions/{id}Parandussessiooni päringchatbots:read
POST/api/v1/improvement-sessions/{id}/messagesSõnumi saatmine Improvement Agentilechatbots:write
POST/api/v1/improvement-sessions/{id}/completeParandussessiooni lõpetaminechatbots:write
POST/api/v1/improvement-sessions/{id}/resetParandussessiooni lähtestaminechatbots:write
POST/api/v1/improvement-proposals/{id}/applyParandusettepaneku rakendaminechatbots:write
POST/api/v1/improvement-proposals/{id}/rejectParandusettepaneku tagasilükkaminechatbots:write
POST/api/v1/improvement-proposals/{id}/simulationsParandusettepaneku simuleeriminechatbots:write
POST/api/v1/improvement-simulations/{id}/assessmentSimulatsiooni tulemuse hindaminechatbots:write

Lead’id

MethodPathDescriptionScope
GET/api/v1/leadsLead’ide loeteluleads:read
POST/api/v1/leadsLeadi loomineleads:write
GET/api/v1/leads/{id}Leadi päringleads:read
PATCH/api/v1/leads/{id}Leadi uuendamineleads:write
DELETE/api/v1/leads/{id}Leadi kustutamineleads:write
POST/api/v1/leads/{id}/assignLeadi määramineleads:write
POST/api/v1/leads/bulk-statusLeadi staatuse hulgipäringu uuendamineleads:write
GET/api/v1/leads/statsLeadi statistikaleads:read
GET/api/v1/leads/exportLead’ide eksportleads:read
GET/api/v1/chatbots/{id}/lead-configLeadi kogumise konfiguratsiooni päringleads:read
PUT/api/v1/chatbots/{id}/lead-configLeadi kogumise konfiguratsiooni uuendamineleads:write
GET/api/v1/chatbots/{id}/lead-categoriesLeadi kategooriate loeteluleads:read
POST/api/v1/chatbots/{id}/lead-categoriesLeadi kategooria loomineleads:write
GET/api/v1/lead-categories/{id}Leadi kategooria päringleads:read
PATCH/api/v1/lead-categories/{id}Leadi kategooria uuendamineleads:write
DELETE/api/v1/lead-categories/{id}Leadi kategooria kustutamineleads:write
PUT/api/v1/lead-categories/{id}/users/{userId}Meeskonnaliikme määramine leadi kategooriasseleads:write
DELETE/api/v1/lead-categories/{id}/users/{userId}Meeskonnaliikme eemaldamine leadi kategooriastleads:write

Kontaktivormid

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/formsKontaktivormide loeteluforms:read
POST/api/v1/chatbots/{id}/formsKontaktivormi loomineforms:write
GET/api/v1/forms/{id}Kontaktivormi päringforms:read
PATCH/api/v1/forms/{id}Kontaktivormi uuendamineforms:write
DELETE/api/v1/forms/{id}Kontaktivormi kustutamineforms:write
GET/api/v1/forms/{id}/submissionsVormide esitamiste loeteluforms:read
GET/api/v1/forms/{id}/statsVormiesituste statistikaforms:read
GET/api/v1/submissions/{id}Vormiesituse päringforms:read
PATCH/api/v1/submissions/{id}Vormiesituse ülevaatusforms:write
DELETE/api/v1/submissions/{id}Vormiesituse kustutamineforms:write

Reaalajas vestlus

MethodPathDescriptionScope
GET/api/v1/live-chat/availabilityOma reaalajas vestluse kättesaadavuse päringchats:read
PUT/api/v1/live-chat/availabilityOma reaalajas vestluse kättesaadavuse määraminechats:write
POST/api/v1/live-chat/heartbeatOleku heartbeat'i saatminechats:write
GET/api/v1/live-chat/agentsSaadavalolevate reaalajas agentide loeteluchats:read
GET/api/v1/live-chat/sessionsReaalajas vestluse sessioonide loeteluchats:read
GET/api/v1/live-chat/sessions/{sessionId}Reaalajas vestluse sessiooni päringchats:read
POST/api/v1/live-chat/sessions/{sessionId}/assignReaalajas vestluse ettevõtmine (määra võtme omaniku peale)chats:write
POST/api/v1/live-chat/sessions/{sessionId}/messagesSõnumi saatmine agendinachats:write
POST/api/v1/live-chat/sessions/{sessionId}/closeReaalajas vestluse lõpetaminechats:write

Analüütika

MethodPathDescriptionScope
GET/api/v1/analyticsAnalüütika ülevaadeanalytics:read
GET/api/v1/analytics/activityVestluste tegevussarja andmedanalytics:read
GET/api/v1/analytics/chatbotsVestlusboti kaupa tulemuslikkuse statistika loeteluanalytics:read
GET/api/v1/analytics/chatbots/{id}Vestlusboti analüütika päringanalytics:read
GET/api/v1/analytics/leadsLead’i lehtri päringanalytics:read
GET/api/v1/analytics/formsVormiesituste statistika päringanalytics:read
GET/api/v1/activityTähelepanu kokkuvõtte päringanalytics:read

Ettevõte & meeskond

MethodPathDescriptionScope
GET/api/v1/companyEttevõtte päringany key
PATCH/api/v1/companyEttevõtte uuendaminecompany:write
GET/api/v1/company/settingsEttevõtte seadete päringcompany:read
PATCH/api/v1/company/settingsEttevõtte seadete uuendaminecompany:write
DELETE/api/v1/company/logoEttevõtte logo eemaldaminecompany:write
GET/api/v1/company/membersMeeskonnaliikmete loetelucompany:read
PATCH/api/v1/company/members/{userId}Liikme rolli muutminecompany:write
DELETE/api/v1/company/members/{userId}Meeskonnaliikme eemaldaminecompany:write
GET/api/v1/company/invitesKutsete loetelucompany:read
POST/api/v1/company/invitesMeeskonnaliikme kutsuminecompany:write
DELETE/api/v1/company/invites/{id}Kutse tühistaminecompany:write
POST/api/v1/company/invites/{id}/resendKutse uuesti saatminecompany:write

Email Assistant

MethodPathDescriptionScope
GET/api/v1/email/connectionsPostkastikonnektsioonide loeteluemail:read
GET/api/v1/email/connections/{id}Postkastikonnektsiooni päringemail:read
PATCH/api/v1/email/connections/{id}Postkastikonnektsiooni uuendamineemail:write
DELETE/api/v1/email/connections/{id}Postkasti lahtiühendamineemail:write
GET/api/v1/email/connections/{id}/categoriesE-kirja kategooriate loeteluemail:read
POST/api/v1/email/connections/{id}/categoriesE-kirja kategooria loomineemail:write
GET/api/v1/email/connections/{id}/foldersPostkastifoldrite loeteluemail:read
POST/api/v1/email/connections/{id}/foldersPostkastifoldri loomineemail:write
GET/api/v1/email/connections/{id}/activityE-kirjade tegevuste logi loeteluemail:read
GET/api/v1/email/categories/{id}E-kirja kategooria päringemail:read
PATCH/api/v1/email/categories/{id}E-kirja kategooria uuendamineemail:write
DELETE/api/v1/email/categories/{id}E-kirja kategooria kustutamineemail:write
GET/api/v1/email/contactsE-kontaktide loeteluemail:read
GET/api/v1/email/contacts/{id}E-kontakti päringemail:read
PATCH/api/v1/email/contacts/{id}E-kontakti uuendamineemail:write
DELETE/api/v1/email/contacts/{id}E-kontakti kustutamineemail:write

Konto & teavitused

MethodPathDescriptionScope
GET/api/v1/meVõtme konteksti päring (whoami)any key
GET/api/v1/account/usagePlaani ja kasutuse päringany key
GET/api/v1/notificationsTeavituste loeteluany key
DELETE/api/v1/notificationsVanade loetud teavituste kustutamineany key
GET/api/v1/notifications/unread-countLugemata teavituste arvu päringany key
POST/api/v1/notifications/mark-all-readMärgi kõik teavitused loetuksany key
GET/api/v1/notifications/{id}Teavituse päringany key
PATCH/api/v1/notifications/{id}Märgi teavitus loetuksany key

Blogi (platvorm)

MethodPathDescriptionScope
GET/api/v1/blogBlogipostituste loeteluany key
POST/api/v1/blogBlogipostituse loomineany key
POST/api/v1/blog/assetsBlogi vara üleslaadimineany key
GET/api/v1/blog/{id}Blogipostituse päringany key
PATCH/api/v1/blog/{id}Blogipostituse uuendamineany key
DELETE/api/v1/blog/{id}Blogipostituse kustutamineany key
POST/api/v1/blog/{id}/translationsBlogi tõlgete järjekorda panekany key

Vajad abi? Võta ühendust meie tugitiimiga →

Eelmine
Shopify integratsioon
Järgmine
MCP-serveri integratsioon