REST API
ChatReactin REST API v1 antaa ohjelmallisen pääsyn tuettuihin hallintapaneelin toimintoihin: chatbotit, tietopohja ja indeksointi, rakenteelliset hinnat, usein kysytyt kysymykset (FAQ), chat-arvostelut ja Improvement Agent, liidit, yhteydenottolomakkeet, live-chat, yritys ja tiimi, Email Assistant, analytiikka ja ilmoitukset. Selain-rajapinnat (maksut, postilaatikon valtuutus, passkeys, tilin poisto ja API-avainten hallinta) pysyvät hallintapaneelissa.
Haluatteko mieluummin keskustella AI-avustajan kanssa? Samanlaiset ominaisuudet ovat saatavilla myös MCP-työkaluina — katso MCP Server Integration . Interaktiivinen API Explorer pyyntö- ja vastausskeemoineen löytyy osoitteesta /api-reference , josta voit myös ladata OpenAPI 3.0 -määrittelyn.
Autentikointi
Siirry kohtaan Kojelauta → Yritys → API -välilehti ja klikkaa Luo API-avain
Valitse nimi ja avaimen tarvitsemat käyttöoikeudet (katso alla)
Kopioi avain — se alkaa merkillä cr_ ja näytetään vain kerran
Lähetä avain jokaisessa pyynnössä:
curl https://www.chatreact.ai/api/v1/chatbots \
-H "Authorization: Bearer cr_your_api_key"
X-API-Key: cr_your_api_key-otsikko hyväksytään myös. API-avaimet kuuluvat yhdelle yritykselle ja suoritetaan yrityksen omistajan oikeuksin; suunnitelmarajoitukset ja ominaisuuksien käyttöehdot pätevät täsmälleen kuten hallintapaneelissa.
API-käyttö on saatavilla maksullisilla suunnitelmilla — katso Hinnoittelu-sivu . Avaimet voidaan mitätöidä milloin tahansa hallintapaneelista.
Oikeudet (Scopes)
Jokainen avain kantaa yhtä tai useampaa scopea. Päätepiste palauttaa 403, jos avainltä puuttuu vaadittu scope.
Scope Myöntää chatbots:read / chatbots:writeChatbotin konfiguraatio: persoonallisuus, kielet, widget, käyttäytyminen, rajoitukset, ydinohjeet, upotuskoodi, oppimisvaihe, chatbot-mallit, FAQ-widgetin asetukset knowledge:read / knowledge:writeTietopohja: dokumentit, verkkosivujen indeksointi, indeksoidut sivut faqs:read / faqs:writeFAQ:t, FAQ-kategoriat, ehdotukset, käännökset chats:read / chats:writeChat-historia, chat-arvostelut, luottamuskategoriat, live-chat (agenttitoimet vaativat chats:write) leads:read / leads:writeLiidit, liidikategoriat, liidien keräysasetukset, vienti forms:read / forms:writeYhteydenottolomakkeet ja lähetykset analytics:readTilastot, aktiviteettisarjat, suppilot, luottamustila company:read / company:writeYritysprofiili ja asetukset, tiimin jäsenet, kutsut email:read / email:writeEmail Assistant -yhteydet, kategoriat, kontaktit, aktiviteetti prices:readLue rakenteellisia hintaeriä, revisiot, kelpoisuus ja ehdotukset prices:writeLuo ja muokkaa hintaluonnoksia, tuo CSV ja käytä ehdotusta luonnoksena; vaatii yrityksen omistajan prices:approveHyväksy täsmällisiä versioita tai arkistoi merkinnät; vaatii yrityksen omistajan blog:read / blog:writePlatform-blogisisältö (ChatReact sisäinen) any valid key /v1/me, tilin käyttö, omat ilmoituksesi
Konventiot
Perusosoite : https://www.chatreact.ai/api/v1, JSON sisään ja ulos (Content-Type: application/json).Vastaukset : { "success": true, "data": … }; listaukset lisäävät "pagination": { "total", "page", "pageSize", "totalPages" }. Käytä page ja pageSize (maks. 100) listapäätepisteillä; joillain päätepisteillä on kursori-paginointi (cursor / nextCursor).Virheet : { "success": false, "error": "message", "code": "BAD_REQUEST" } valinnaisella details kentällä validointivirheille. Status-koodit: 400 virheellinen syöte, 401 puuttuva tai virheellinen avain, 403 puuttuva scope, ominaisuus ei kuulu suunnitelmaan tai rooli on riittämätön, 404 resurssia ei löydy (myös muiden yritysten resurssit), 409 konflikti, 429 ylitetty nopeusrajoitus.Osittaiset päivitykset : PATCH-päätepisteet muuttavat vain lähettämiäsi kenttiä; tuntemattomat kentät hylätään.Nopeusrajoitus : 30 pyyntöä minuutissa per IP-osoite.Pitkät operaatiot (indeksoinnit, AI-generointi, käännökset) palauttavat nopeasti työn tai tuloksen, jota voit pollata; ne kuluttavat suunnitelmasi token- ja indeksointibudjetin.
Päätepisteet
Hinnat & palvelut
Tallennus, muokkaus, tuonti ja ehdotuksen soveltaminen luovat hyväksymättömiä luonnoksia. Hyväksyntä- ja arkistotoimet käsittelevät täsmällisiä versioita; vanhentunut versio palauttaa konfliktin. Olemassa olevat avaimet eivät saa hinnanmuokkausoikeuksia automaattisesti. Vain yrityksen omistaja voi myöntää kirjoitus- tai hyväksymisoikeuksia. Asiakasprosessia varten katso Prices & services .
Method Path Description Scope GET/api/v1/chatbots/{id}/pricesListaa hintaerät ja kelpoisuus prices:readPOST/api/v1/chatbots/{id}/pricesLuo luonnos prices:writeGET/api/v1/chatbots/{id}/prices/{itemId}Lue tiedot ja sivutettu historia prices:readPATCH/api/v1/chatbots/{id}/prices/{itemId}Luo muokattu luonnos odotetusta versiosta prices:writeGET/api/v1/chatbots/{id}/prices/{itemId}/stateLue koko kohteen tila prices:readPOST/api/v1/chatbots/{id}/prices/{itemId}/approveHyväksy täsmällinen versio prices:approvePOST/api/v1/chatbots/{id}/prices/{itemId}/archiveArkistoi täsmällinen versio prices:approvePOST/api/v1/chatbots/{id}/prices/approve-manyHyväksy eksplisiittinen versiovalinta atomisesti prices:approvePOST/api/v1/chatbots/{id}/prices/importTuo CSV-luonnoksia vakaalla tuontitunnisteella prices:writeGET/api/v1/chatbots/{id}/prices/suggestionsListaa hintaehdotukset prices:readPOST/api/v1/chatbots/{id}/prices/suggestions/{suggestionId}/applyKäytä valittu ehdotus luonnoksena prices:write
Chatbotit
Method Path Description Scope GET/api/v1/chatbotsListaa chatbotit chatbots:readPOST/api/v1/chatbotsLuo chatbot chatbots:writeGET/api/v1/chatbots/{id}Hae chatbot chatbots:readPATCH/api/v1/chatbots/{id}Päivitä chatbot chatbots:writeDELETE/api/v1/chatbots/{id}Poista chatbot chatbots:writeGET/api/v1/chatbots/{id}/personalityHae chatbotin persoonallisuus chatbots:readPATCH/api/v1/chatbots/{id}/personalityPäivitä chatbotin persoonallisuus chatbots:writeGET/api/v1/chatbots/{id}/widgetHae widget-asetukset chatbots:readPATCH/api/v1/chatbots/{id}/widgetPäivitä widget-asetukset chatbots:writeGET/api/v1/chatbots/{id}/widget/translationsHae widget-käännökset chatbots:readPUT/api/v1/chatbots/{id}/widget/translationsKorvaa widget-käännökset chatbots:writeGET/api/v1/chatbots/{id}/embedHae upotuskoodi chatbots:readPOST/api/v1/chatbots/{id}/embed/confirmVahvista upotus chatbots:writeGET/api/v1/chatbots/{id}/learning-phaseHae oppimisvaiheen asetukset chatbots:readPATCH/api/v1/chatbots/{id}/learning-phasePäivitä oppimisvaiheen asetukset chatbots:writePOST/api/v1/chatbots/{id}/learning-phase/endLopeta oppimisvaihe chatbots:writeGET/api/v1/chatbots/{id}/instructionsListaa ydinohjeet chatbots:readPOST/api/v1/chatbots/{id}/instructionsLisää ydinohje chatbots:writePUT/api/v1/chatbots/{id}/instructions/reorderJärjestä ydinohjeet chatbots:writePOST/api/v1/chatbots/{id}/instructions/improveParanna ohjeita AI:lla chatbots:writeGET/api/v1/instructions/{id}Hae ydinohje chatbots:readPATCH/api/v1/instructions/{id}Päivitä ydinohje chatbots:writeDELETE/api/v1/instructions/{id}Poista ydinohje chatbots:writeGET/api/v1/chatbot-templatesListaa chatbot-mallit chatbots:read
Tietopohja
Method Path Description Scope GET/api/v1/chatbots/{id}/knowledgeTietopohjan yleiskatsaus knowledge:readGET/api/v1/chatbots/{id}/documentsListaa dokumentit chatbotille knowledge:readPOST/api/v1/chatbots/{id}/documentsLataa dokumentti knowledge:writePOST/api/v1/chatbots/{id}/documents/presignPresign-dokumentin lataus knowledge:writeGET/api/v1/documents/{id}Hae dokumentti knowledge:readDELETE/api/v1/documents/{id}Poista dokumentti knowledge:writePOST/api/v1/documents/{id}/confirmVahvista presigned-lataus knowledge:writeGET/api/v1/chatbots/{id}/crawl/limitsIndeksointirajat knowledge:readPOST/api/v1/chatbots/{id}/crawl/previewEsikatsele verkkosivun skannausta knowledge:writeGET/api/v1/chatbots/{id}/crawlListaa indeksointityöt knowledge:readPOST/api/v1/chatbots/{id}/crawlAloita indeksointi knowledge:writeGET/api/v1/crawl-jobs/{jobId}Hae indeksointityö knowledge:readPOST/api/v1/crawl-jobs/{jobId}/cancelPeru indeksointityö knowledge:writeGET/api/v1/chatbots/{id}/pagesListaa indeksoidut sivut knowledge:readPOST/api/v1/chatbots/{id}/pagesLisää yksittäinen URL knowledge:writePOST/api/v1/chatbots/{id}/pages/bulk-deletePoista indeksoidut sivut massana knowledge:writeGET/api/v1/pages/{id}Hae indeksoitu sivu knowledge:readDELETE/api/v1/pages/{id}Poista indeksoitu sivu knowledge:writePOST/api/v1/pages/{id}/recrawlIndeksoi sivu uudelleen knowledge:writeGET/api/v1/chatbots/{id}/websitesListaa indeksoidut verkkosivustot knowledge:readDELETE/api/v1/chatbots/{id}/websites/{domain}Poista verkkosivusto knowledge:writePOST/api/v1/chatbots/{id}/websites/{domain}/recrawlIndeksoi verkkosivusto uudelleen knowledge:writePOST/api/v1/chatbots/{id}/websites/{domain}/recrawl/cancelPeru verkkosivuston uudelleenindeksointi knowledge:write
FAQ:t
Method Path Description Scope GET/api/v1/chatbots/{id}/faqsListaa chatbotin FAQ:t faqs:readPOST/api/v1/chatbots/{id}/faqsLuo FAQ faqs:writePOST/api/v1/chatbots/{id}/faqs/bulkTuo FAQ:t massana faqs:writePOST/api/v1/chatbots/{id}/faqs/reorderJärjestä FAQ:t faqs:writeGET/api/v1/chatbots/{id}/faqs/embedHae FAQ-widgetin upotuskoodi chatbots:readPOST/api/v1/chatbots/{id}/faqs/purge-cacheTyhjennä etä-FQA-välimuistit faqs:writeGET/api/v1/faqs/{id}Hae FAQ faqs:readPATCH/api/v1/faqs/{id}Päivitä FAQ faqs:writeDELETE/api/v1/faqs/{id}Poista FAQ faqs:writePUT/api/v1/faqs/{id}/translationsPäivitä FAQ-käännökset faqs:writePOST/api/v1/faqs/{id}/translateKäännä FAQ AI:lla faqs:writeGET/api/v1/chatbots/{id}/faq-suggestionsListaa FAQ-ehdotukset faqs:readPOST/api/v1/chatbots/{id}/faq-suggestions/generateGeneroi FAQ-ehdotuksia tietopohjasta faqs:writeGET/api/v1/faq-suggestions/{id}Hae FAQ-ehdotus faqs:readPOST/api/v1/faq-suggestions/{id}/approveHyväksy FAQ-ehdotus faqs:writePOST/api/v1/faq-suggestions/{id}/rejectHylkää FAQ-ehdotus faqs:writeGET/api/v1/chatbots/{id}/faq-categoriesListaa FAQ-kategoriat faqs:readPOST/api/v1/chatbots/{id}/faq-categoriesLuo FAQ-kategoria faqs:writePOST/api/v1/chatbots/{id}/faq-categories/reorderJärjestä FAQ-kategoriat faqs:writeGET/api/v1/faq-categories/{id}Hae FAQ-kategoria faqs:readPATCH/api/v1/faq-categories/{id}Päivitä FAQ-kategoria faqs:writeDELETE/api/v1/faq-categories/{id}Poista FAQ-kategoria faqs:writePUT/api/v1/faq-categories/{id}/translationsPäivitä FAQ-kategorian käännökset faqs:writeGET/api/v1/chatbots/{id}/faq-widget-settingsHae FAQ-widgetin asetukset chatbots:readPATCH/api/v1/chatbots/{id}/faq-widget-settingsPäivitä FAQ-widgetin asetukset chatbots:write
Chatit, palaute & Improvement Agent
Method Path Description Scope GET/api/v1/chatsListaa chat-istunnot chats:readGET/api/v1/chats/{sessionId}Hae chat-istunto chats:readPATCH/api/v1/chats/{sessionId}Aseta chatin luottamusluokka chats:writePOST/api/v1/chats/{sessionId}/feedbackArvioi chat (Good / Needs Work) chats:writePOST/api/v1/chats/{sessionId}/feedback/dismissHylkää chat-arvostelu chats:writePOST/api/v1/chats/{sessionId}/improveKäynnistä Improvement Agent chatille chatbots:writeGET/api/v1/chatbots/{id}/feedbackListaa chatbotin chat-arvostelut chats:readGET/api/v1/chatbots/{id}/feedback/statsChat-arvostelujen tilakortit chats:readGET/api/v1/feedback/{id}Hae chat-arvostelu chats:readPATCH/api/v1/feedback/{id}Ylikirjoita arvostelun vakavuus chats:writePOST/api/v1/feedback/{id}/improvement-sessionKäynnistä Improvement Agent arvostelulle chatbots:writeGET/api/v1/chatbots/{id}/confidenceHae luottamustila analytics:readGET/api/v1/chatbots/{id}/confidence-categoriesListaa luottamusluokat chats:readPOST/api/v1/chatbots/{id}/confidence-categoriesLuo luottamusluokka chatbots:writePATCH/api/v1/confidence-categories/{id}Päivitä luottamusluokka chatbots:writeDELETE/api/v1/confidence-categories/{id}Poista luottamusluokka chatbots:writePOST/api/v1/confidence-categories/{id}/mergeYhdistä luottamusluokkia chatbots:writeGET/api/v1/chatbots/{id}/improvement-sessionsListaa parannussessiot chatbots:readGET/api/v1/improvement-sessions/{id}Hae parannussessio chatbots:readPOST/api/v1/improvement-sessions/{id}/messagesLähetä viesti Improvement Agentille chatbots:writePOST/api/v1/improvement-sessions/{id}/completeMerkitse parannussessio valmiiksi chatbots:writePOST/api/v1/improvement-sessions/{id}/resetNollaa parannussessio chatbots:writePOST/api/v1/improvement-proposals/{id}/applyKäytä parannusehdotus chatbots:writePOST/api/v1/improvement-proposals/{id}/rejectHylkää parannusehdotus chatbots:writePOST/api/v1/improvement-proposals/{id}/simulationsSimuloi parannusehdotus chatbots:writePOST/api/v1/improvement-simulations/{id}/assessmentArvioi simulaation tulos chatbots:write
Liidit
Method Path Description Scope GET/api/v1/leadsListaa liidit leads:readPOST/api/v1/leadsLuo liidi leads:writeGET/api/v1/leads/{id}Hae liidi leads:readPATCH/api/v1/leads/{id}Päivitä liidi leads:writeDELETE/api/v1/leads/{id}Poista liidi leads:writePOST/api/v1/leads/{id}/assignMääritä liidi leads:writePOST/api/v1/leads/bulk-statusPäivitä liidien tilaa massana leads:writeGET/api/v1/leads/statsLiidien tilastot leads:readGET/api/v1/leads/exportVie liidit leads:readGET/api/v1/chatbots/{id}/lead-configHae liidin keräyskonfiguraatio leads:readPUT/api/v1/chatbots/{id}/lead-configPäivitä liidin keräyskonfiguraatio leads:writeGET/api/v1/chatbots/{id}/lead-categoriesListaa liidikategoriat leads:readPOST/api/v1/chatbots/{id}/lead-categoriesLuo liidikategoria leads:writeGET/api/v1/lead-categories/{id}Hae liidikategoria leads:readPATCH/api/v1/lead-categories/{id}Päivitä liidikategoria leads:writeDELETE/api/v1/lead-categories/{id}Poista liidikategoria leads:writePUT/api/v1/lead-categories/{id}/users/{userId}Määritä jäsen liidikategoriaan leads:writeDELETE/api/v1/lead-categories/{id}/users/{userId}Poista jäsen liidikategoriasta leads:write
Yhteydenottolomakkeet
Method Path Description Scope GET/api/v1/chatbots/{id}/formsListaa yhteydenottolomakkeet forms:readPOST/api/v1/chatbots/{id}/formsLuo yhteydenottolomake forms:writeGET/api/v1/forms/{id}Hae yhteydenottolomake forms:readPATCH/api/v1/forms/{id}Päivitä yhteydenottolomake forms:writeDELETE/api/v1/forms/{id}Poista yhteydenottolomake forms:writeGET/api/v1/forms/{id}/submissionsListaa lomakkeen lähetykset forms:readGET/api/v1/forms/{id}/statsLomakkeen lähetys -tilastot forms:readGET/api/v1/submissions/{id}Hae lomakkeen lähetys forms:readPATCH/api/v1/submissions/{id}Arvioi lomakkeen lähetys forms:writeDELETE/api/v1/submissions/{id}Poista lomakkeen lähetys forms:write
Live chat
Method Path Description Scope GET/api/v1/live-chat/availabilityHae oma live-chatin tavoitettavuus chats:readPUT/api/v1/live-chat/availabilityAseta oma live-chatin tavoitettavuus chats:writePOST/api/v1/live-chat/heartbeatLähetä presence-heartbeat chats:writeGET/api/v1/live-chat/agentsListaa saatavilla olevat live-chat-agentit chats:readGET/api/v1/live-chat/sessionsListaa live-chat-istunnot chats:readGET/api/v1/live-chat/sessions/{sessionId}Hae live-chat-istunto chats:readPOST/api/v1/live-chat/sessions/{sessionId}/assignOta live-chat (määritetään avaimen omistajalle) chats:writePOST/api/v1/live-chat/sessions/{sessionId}/messagesLähetä viesti agenttina chats:writePOST/api/v1/live-chat/sessions/{sessionId}/closeLopeta live-chat chats:write
Analytiikka
Method Path Description Scope GET/api/v1/analyticsHae analytiikan yleiskatsaus analytics:readGET/api/v1/analytics/activityHae chat-aktiviteettisarjat analytics:readGET/api/v1/analytics/chatbotsListaa chatbot-kohtaiset suorituskykystatistiikat analytics:readGET/api/v1/analytics/chatbots/{id}Hae chatbotin analytiikka analytics:readGET/api/v1/analytics/leadsHae liidien suppilo analytics:readGET/api/v1/analytics/formsHae lomakkeen lähetys -tilastot analytics:readGET/api/v1/activityHae huomion yhteenveto analytics:read
Yritys & tiimi
Method Path Description Scope GET/api/v1/companyHae yritys any key PATCH/api/v1/companyPäivitä yritys company:writeGET/api/v1/company/settingsHae yrityksen asetukset company:readPATCH/api/v1/company/settingsPäivitä yrityksen asetukset company:writeDELETE/api/v1/company/logoPoista yrityksen logo company:writeGET/api/v1/company/membersListaa tiimin jäsenet company:readPATCH/api/v1/company/members/{userId}Vaihda jäsenen roolia company:writeDELETE/api/v1/company/members/{userId}Poista tiimin jäsen company:writeGET/api/v1/company/invitesListaa kutsut company:readPOST/api/v1/company/invitesKutsu tiimin jäsen company:writeDELETE/api/v1/company/invites/{id}Peru kutsu company:writePOST/api/v1/company/invites/{id}/resendLähetä kutsu uudelleen company:write
Email Assistant
Method Path Description Scope GET/api/v1/email/connectionsListaa postilaatikkoyhteydet email:readGET/api/v1/email/connections/{id}Hae postilaatikkoyhteys email:readPATCH/api/v1/email/connections/{id}Päivitä postilaatikkoyhteys email:writeDELETE/api/v1/email/connections/{id}Katkaise postilaatikko email:writeGET/api/v1/email/connections/{id}/categoriesListaa sähköpostikategoriat email:readPOST/api/v1/email/connections/{id}/categoriesLuo sähköpostikategoria email:writeGET/api/v1/email/connections/{id}/foldersListaa postilaatikon kansiot email:readPOST/api/v1/email/connections/{id}/foldersLuo postilaatikon kansio email:writeGET/api/v1/email/connections/{id}/activityListaa sähköpostin aktiviteettiloki email:readGET/api/v1/email/categories/{id}Hae sähköpostikategoria email:readPATCH/api/v1/email/categories/{id}Päivitä sähköpostikategoria email:writeDELETE/api/v1/email/categories/{id}Poista sähköpostikategoria email:writeGET/api/v1/email/contactsListaa sähköpostikontaktit email:readGET/api/v1/email/contacts/{id}Hae sähköpostikontakti email:readPATCH/api/v1/email/contacts/{id}Päivitä sähköpostikontakti email:writeDELETE/api/v1/email/contacts/{id}Poista sähköpostikontakti email:write
Tili & ilmoitukset
Method Path Description Scope GET/api/v1/meHae avaimen konteksti (whoami) any key GET/api/v1/account/usageHae suunnitelma ja käyttö any key GET/api/v1/notificationsListaa ilmoitukset any key DELETE/api/v1/notificationsPoista vanhat luetut ilmoitukset any key GET/api/v1/notifications/unread-countHae lukemattomien ilmoitusten määrä any key POST/api/v1/notifications/mark-all-readMerkitse kaikki ilmoitukset luetuiksi any key GET/api/v1/notifications/{id}Hae ilmoitus any key PATCH/api/v1/notifications/{id}Merkitse ilmoitus luetuksi any key
Blogi (alusta)
Method Path Description Scope GET/api/v1/blogListaa blogikirjoitukset any key POST/api/v1/blogLuo blogikirjoitus any key POST/api/v1/blog/assetsLataa blogiresurssi any key GET/api/v1/blog/{id}Hae blogikirjoitus any key PATCH/api/v1/blog/{id}Päivitä blogikirjoitus any key DELETE/api/v1/blog/{id}Poista blogikirjoitus any key POST/api/v1/blog/{id}/translationsAseta jonoon blogin käännökset any key
Tarvitsetteko apua? Ota yhteyttä tukitiimiimme →