ChatReact
HemDokumentation

REST API

ChatReact REST API v1 ger er programmatisk åtkomst till stödda operationer i instrumentpanelen: chatbottar, kunskapsbas och crawling, strukturerade priser, vanliga frågor, chatgranskning och Improvement Agent, leads, kontaktformulär, livechatt, företag och team, Email Assistant, analys och aviseringar. Åtgärder som kräver webbläsaren (betalningar, mailbox-auktorisation, passkeys, kontoborttagning och API-nyckelhantering) sker fortfarande i instrumentpanelen.

Föredrar ni att prata med en AI-assistent? Samma funktioner finns som MCP-verktyg — se MCP Server Integration. Den interaktiva API-explorern med request- och response-scheman finns på /api-reference, där ni också kan ladda ner OpenAPI 3.0-specifikationen.

Autentisering

  1. Gå till Översikt → Företag → API-fliken och klicka Skapa API-nyckel
  2. Välj ett namn och de behörighetsscopes nyckeln behöver (se nedan)
  3. Kopiera nyckeln — den börjar med cr_ och visas endast en gång

Skicka nyckeln med varje förfrågan:

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

En X-API-Key: cr_your_api_key-header accepteras också. API-nycklar tillhör ett företag och utförs med företagsägarens behörigheter; planbegränsningar och feature-gates gäller exakt som i instrumentpanelen.

API-åtkomst finns på betalplaner — se Pricing page. Nycklar kan återkallas när som helst från instrumentpanelen.

Scopes

Varje nyckel bär en eller flera scopes. En endpoint returnerar 403 när nyckeln saknar det erforderliga scopet.

ScopeGer
chatbots:read / chatbots:writeChatbot-konfiguration: persona, språk, widget, beteende, begränsningar, kärninstruktioner, embed-kod, inlärningsfas, chatbot-mallar, FAQ-widget-inställningar
knowledge:read / knowledge:writeKunskapsbas: dokument, webbplats-crawling, crawlad innehåll
faqs:read / faqs:writeFAQ, FAQ-kategorier, förslag, översättningar
chats:read / chats:writeChathistorik, chatbetyg, confidence-kategorier, livechatt (agentåtgärder kräver chats:write)
leads:read / leads:writeLeads, lead-kategorier, inställningar för lead capture, export
forms:read / forms:writeKontaktformulär och inskickade formulär
analytics:readStatistik, tidsserier för aktivitet, funnels, confidence-status
company:read / company:writeFöretagsprofil och inställningar, teammedlemmar, inbjudningar
email:read / email:writeEmail Assistant-anslutningar, kategorier, kontakter, aktivitet
prices:readLäs strukturerade prisposter, revisioner, eligibility och förslag
prices:writeSkapa och redigera priskonton, importera CSV och tillämpa ett förslag som utkast; kräver företagsägaren
prices:approveGodkänn exakta versioner eller arkivera poster; kräver företagsägaren
blog:read / blog:writePlattformens blogginnehåll (ChatReact internt)
any valid key/v1/me, kontobruk, era aviseringar

Konventioner

  • Base URL: https://www.chatreact.ai/api/v1, JSON in och ut (Content-Type: application/json).
  • Svar: { "success": true, "data": … }; listor lägger till "pagination": { "total", "page", "pageSize", "totalPages" }. Använd page och pageSize (max 100) på lista-endpoints; vissa endpoints erbjuder cursor-paginering (cursor / nextCursor).
  • Fel: { "success": false, "error": "message", "code": "BAD_REQUEST" } med valfri details för valideringsfel. Statuskoder: 400 ogiltig input, 401 saknad eller ogiltig nyckel, 403 saknat scope, planfunktion ej inkluderad eller otillräcklig roll, 404 resurs hittades inte (även för resurser tillhörande andra företag), 409 konflikt, 429 hastighetsbegränsning överskriden.
  • Partiella uppdateringar: PATCH-endpoints ändrar endast de fält ni skickar; okända fält avvisas.
  • Rate limit: 30 förfrågningar per minut per IP-adress.
  • Långkörande operationer (crawls, AI-generering, översättningar) returnerar snabbt med ett jobb eller resultat som ni kan poll:a; de förbrukar token- och crawl-budgeten i er plan.

Endpoints

Prices & services

Att spara, redigera, importera och tillämpa ett förslag skapar utkast utan godkännande. Godkännande- och arkiveringsoperationer granskar exakta versioner; en föråldrad version returnerar konflikt. Befintliga nycklar får inte prisbehörigheter automatiskt. Endast företagsägaren kan bevilja skriv- eller godkännanderättigheter. För kundflödet, se Prices & services.

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/pricesLista prisposter och eligibilityprices:read
POST/api/v1/chatbots/{id}/pricesSkapa ett utkastprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}Läs detaljer och paginerad historikprices:read
PATCH/api/v1/chatbots/{id}/prices/{itemId}Skapa ett redigerat utkast från en förväntad versionprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}/stateLäs fullständig item-statusprices:read
POST/api/v1/chatbots/{id}/prices/{itemId}/approveGodkänn en exakt versionprices:approve
POST/api/v1/chatbots/{id}/prices/{itemId}/archiveArkivera en exakt versionprices:approve
POST/api/v1/chatbots/{id}/prices/approve-manyGodkänn ett explicit versionsval atomisktprices:approve
POST/api/v1/chatbots/{id}/prices/importImportera CSV-utkast med ett stabilt import-IDprices:write
GET/api/v1/chatbots/{id}/prices/suggestionsLista prisförslagprices:read
POST/api/v1/chatbots/{id}/prices/suggestions/{suggestionId}/applyTillämpa ett valt förslag som utkastprices:write

Chatbots

MethodPathDescriptionScope
GET/api/v1/chatbotsLista chatbottarchatbots:read
POST/api/v1/chatbotsSkapa chatbotchatbots:write
GET/api/v1/chatbots/{id}Hämta chatbotchatbots:read
PATCH/api/v1/chatbots/{id}Uppdatera chatbotchatbots:write
DELETE/api/v1/chatbots/{id}Radera chatbotchatbots:write
GET/api/v1/chatbots/{id}/personalityHämta chatbot-personlighetchatbots:read
PATCH/api/v1/chatbots/{id}/personalityUppdatera chatbot-personlighetchatbots:write
GET/api/v1/chatbots/{id}/widgetHämta widget-inställningarchatbots:read
PATCH/api/v1/chatbots/{id}/widgetUppdatera widget-inställningarchatbots:write
GET/api/v1/chatbots/{id}/widget/translationsHämta widget-översättningarchatbots:read
PUT/api/v1/chatbots/{id}/widget/translationsErsätt widget-översättningarchatbots:write
GET/api/v1/chatbots/{id}/embedHämta embed-kodchatbots:read
POST/api/v1/chatbots/{id}/embed/confirmBekräfta embedchatbots:write
GET/api/v1/chatbots/{id}/learning-phaseHämta inlärningsfas-inställningarchatbots:read
PATCH/api/v1/chatbots/{id}/learning-phaseUppdatera inlärningsfas-inställningarchatbots:write
POST/api/v1/chatbots/{id}/learning-phase/endAvsluta inlärningsfaschatbots:write
GET/api/v1/chatbots/{id}/instructionsLista kärninstruktionerchatbots:read
POST/api/v1/chatbots/{id}/instructionsLägg till kärninstruktionchatbots:write
PUT/api/v1/chatbots/{id}/instructions/reorderOmdisponera kärninstruktionerchatbots:write
POST/api/v1/chatbots/{id}/instructions/improveFörbättra instruktioner med AIchatbots:write
GET/api/v1/instructions/{id}Hämta kärninstruktionchatbots:read
PATCH/api/v1/instructions/{id}Uppdatera kärninstruktionchatbots:write
DELETE/api/v1/instructions/{id}Radera kärninstruktionchatbots:write
GET/api/v1/chatbot-templatesLista chatbot-mallarchatbots:read

Kunskapsbas

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/knowledgeÖversikt av kunskapsbasknowledge:read
GET/api/v1/chatbots/{id}/documentsLista dokument för chatbotknowledge:read
POST/api/v1/chatbots/{id}/documentsLadda upp dokumentknowledge:write
POST/api/v1/chatbots/{id}/documents/presignPresignera dokumentuppladdningknowledge:write
GET/api/v1/documents/{id}Hämta dokumentknowledge:read
DELETE/api/v1/documents/{id}Radera dokumentknowledge:write
POST/api/v1/documents/{id}/confirmBekräfta presignerad uppladdningknowledge:write
GET/api/v1/chatbots/{id}/crawl/limitsCrawl-gränserknowledge:read
POST/api/v1/chatbots/{id}/crawl/previewFörhandsgranska webbplatsgenomsökningknowledge:write
GET/api/v1/chatbots/{id}/crawlLista crawl-jobbknowledge:read
POST/api/v1/chatbots/{id}/crawlStarta crawlknowledge:write
GET/api/v1/crawl-jobs/{jobId}Hämta crawl-jobbknowledge:read
POST/api/v1/crawl-jobs/{jobId}/cancelAvbryt crawl-jobbknowledge:write
GET/api/v1/chatbots/{id}/pagesLista crawlade sidorknowledge:read
POST/api/v1/chatbots/{id}/pagesLägg till enstaka URLknowledge:write
POST/api/v1/chatbots/{id}/pages/bulk-deleteMassradera crawlade sidorknowledge:write
GET/api/v1/pages/{id}Hämta crawlad sidaknowledge:read
DELETE/api/v1/pages/{id}Radera crawlad sidaknowledge:write
POST/api/v1/pages/{id}/recrawlRecrawl sidaknowledge:write
GET/api/v1/chatbots/{id}/websitesLista crawlade webbplatserknowledge:read
DELETE/api/v1/chatbots/{id}/websites/{domain}Radera webbplatsknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawlRecrawl webbplatsknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawl/cancelAvbryt webbplats-recrawlknowledge:write

FAQs

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/faqsLista FAQ för chatbotfaqs:read
POST/api/v1/chatbots/{id}/faqsSkapa FAQfaqs:write
POST/api/v1/chatbots/{id}/faqs/bulkMassimportera FAQfaqs:write
POST/api/v1/chatbots/{id}/faqs/reorderOmdisponera FAQfaqs:write
GET/api/v1/chatbots/{id}/faqs/embedHämta FAQ-widget embed-kodchatbots:read
POST/api/v1/chatbots/{id}/faqs/purge-cacheRensa fjärr-cache för FAQfaqs:write
GET/api/v1/faqs/{id}Hämta FAQfaqs:read
PATCH/api/v1/faqs/{id}Uppdatera FAQfaqs:write
DELETE/api/v1/faqs/{id}Radera FAQfaqs:write
PUT/api/v1/faqs/{id}/translationsUppdatera FAQ-översättningarfaqs:write
POST/api/v1/faqs/{id}/translateAI-översätt FAQfaqs:write
GET/api/v1/chatbots/{id}/faq-suggestionsLista FAQ-förslagfaqs:read
POST/api/v1/chatbots/{id}/faq-suggestions/generateGenerera FAQ-förslag från kunskapsbasfaqs:write
GET/api/v1/faq-suggestions/{id}Hämta FAQ-förslagfaqs:read
POST/api/v1/faq-suggestions/{id}/approveGodkänn FAQ-förslagfaqs:write
POST/api/v1/faq-suggestions/{id}/rejectAvvisa FAQ-förslagfaqs:write
GET/api/v1/chatbots/{id}/faq-categoriesLista FAQ-kategorierfaqs:read
POST/api/v1/chatbots/{id}/faq-categoriesSkapa FAQ-kategorifaqs:write
POST/api/v1/chatbots/{id}/faq-categories/reorderOmdisponera FAQ-kategorierfaqs:write
GET/api/v1/faq-categories/{id}Hämta FAQ-kategorifaqs:read
PATCH/api/v1/faq-categories/{id}Uppdatera FAQ-kategorifaqs:write
DELETE/api/v1/faq-categories/{id}Radera FAQ-kategorifaqs:write
PUT/api/v1/faq-categories/{id}/translationsUppdatera FAQ-kategori-översättningarfaqs:write
GET/api/v1/chatbots/{id}/faq-widget-settingsHämta FAQ-widget-inställningarchatbots:read
PATCH/api/v1/chatbots/{id}/faq-widget-settingsUppdatera FAQ-widget-inställningarchatbots:write

Chattar, feedback & Improvement Agent

MethodPathDescriptionScope
GET/api/v1/chatsLista chatt-sessionerchats:read
GET/api/v1/chats/{sessionId}Hämta chatt-sessionchats:read
PATCH/api/v1/chats/{sessionId}Sätt chat confidence-kategorichats:write
POST/api/v1/chats/{sessionId}/feedbackBetygsätt chatt (Bra / Behöver arbete)chats:write
POST/api/v1/chats/{sessionId}/feedback/dismissAvfärda chattgranskningchats:write
POST/api/v1/chats/{sessionId}/improveStarta Improvement Agent för chattchatbots:write
GET/api/v1/chatbots/{id}/feedbackLista chattgranskningar för en chatbotchats:read
GET/api/v1/chatbots/{id}/feedback/statsStat-kort för chattgranskningchats:read
GET/api/v1/feedback/{id}Hämta chattgranskningchats:read
PATCH/api/v1/feedback/{id}Överstyr granskningsallvarlighetchats:write
POST/api/v1/feedback/{id}/improvement-sessionStarta Improvement Agent för granskningchatbots:write
GET/api/v1/chatbots/{id}/confidenceHämta confidence-statusanalytics:read
GET/api/v1/chatbots/{id}/confidence-categoriesLista confidence-kategorierchats:read
POST/api/v1/chatbots/{id}/confidence-categoriesSkapa confidence-kategorichatbots:write
PATCH/api/v1/confidence-categories/{id}Uppdatera confidence-kategorichatbots:write
DELETE/api/v1/confidence-categories/{id}Radera confidence-kategorichatbots:write
POST/api/v1/confidence-categories/{id}/mergeSlå ihop confidence-kategorierchatbots:write
GET/api/v1/chatbots/{id}/improvement-sessionsLista förbättringssessionerchatbots:read
GET/api/v1/improvement-sessions/{id}Hämta förbättringssessionchatbots:read
POST/api/v1/improvement-sessions/{id}/messagesSkicka meddelande till Improvement Agentchatbots:write
POST/api/v1/improvement-sessions/{id}/completeAvsluta förbättringssessionchatbots:write
POST/api/v1/improvement-sessions/{id}/resetÅterställ förbättringssessionchatbots:write
POST/api/v1/improvement-proposals/{id}/applyTillämpa förbättringsförslagchatbots:write
POST/api/v1/improvement-proposals/{id}/rejectAvvisa förbättringsförslagchatbots:write
POST/api/v1/improvement-proposals/{id}/simulationsSimulera förbättringsförslagchatbots:write
POST/api/v1/improvement-simulations/{id}/assessmentBetygsätt simuleringsresultatchatbots:write

Leads

MethodPathDescriptionScope
GET/api/v1/leadsLista leadsleads:read
POST/api/v1/leadsSkapa leadleads:write
GET/api/v1/leads/{id}Hämta leadleads:read
PATCH/api/v1/leads/{id}Uppdatera leadleads:write
DELETE/api/v1/leads/{id}Radera leadleads:write
POST/api/v1/leads/{id}/assignTilldela leadleads:write
POST/api/v1/leads/bulk-statusMassuppdatera lead-statusleads:write
GET/api/v1/leads/statsLead-statistikleads:read
GET/api/v1/leads/exportExportera leadsleads:read
GET/api/v1/chatbots/{id}/lead-configHämta lead capture-konfigurationleads:read
PUT/api/v1/chatbots/{id}/lead-configUppdatera lead capture-konfigurationleads:write
GET/api/v1/chatbots/{id}/lead-categoriesLista lead-kategorierleads:read
POST/api/v1/chatbots/{id}/lead-categoriesSkapa lead-kategorileads:write
GET/api/v1/lead-categories/{id}Hämta lead-kategorileads:read
PATCH/api/v1/lead-categories/{id}Uppdatera lead-kategorileads:write
DELETE/api/v1/lead-categories/{id}Radera lead-kategorileads:write
PUT/api/v1/lead-categories/{id}/users/{userId}Tilldela medlem till lead-kategorileads:write
DELETE/api/v1/lead-categories/{id}/users/{userId}Ta bort medlem från lead-kategorileads:write

Kontaktformulär

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/formsLista kontaktformulärforms:read
POST/api/v1/chatbots/{id}/formsSkapa kontaktformulärforms:write
GET/api/v1/forms/{id}Hämta kontaktformulärforms:read
PATCH/api/v1/forms/{id}Uppdatera kontaktformulärforms:write
DELETE/api/v1/forms/{id}Radera kontaktformulärforms:write
GET/api/v1/forms/{id}/submissionsLista formulärinskickforms:read
GET/api/v1/forms/{id}/statsStatistik för formulärinskickforms:read
GET/api/v1/submissions/{id}Hämta formulärinskickforms:read
PATCH/api/v1/submissions/{id}Granska formulärinskickforms:write
DELETE/api/v1/submissions/{id}Radera formulärinskickforms:write

Live chat

MethodPathDescriptionScope
GET/api/v1/live-chat/availabilityHämta egen livechat-tillgänglighetchats:read
PUT/api/v1/live-chat/availabilitySätt egen livechat-tillgänglighetchats:write
POST/api/v1/live-chat/heartbeatSkicka närvaropuls (heartbeat)chats:write
GET/api/v1/live-chat/agentsLista tillgängliga livechat-agenterchats:read
GET/api/v1/live-chat/sessionsLista livechat-sessionerchats:read
GET/api/v1/live-chat/sessions/{sessionId}Hämta livechat-sessionchats:read
POST/api/v1/live-chat/sessions/{sessionId}/assignTa över livechat (tilldela till nyckelägare)chats:write
POST/api/v1/live-chat/sessions/{sessionId}/messagesSkicka meddelande som agentchats:write
POST/api/v1/live-chat/sessions/{sessionId}/closeAvsluta livechatchats:write

Analys

MethodPathDescriptionScope
GET/api/v1/analyticsHämta analysöversiktanalytics:read
GET/api/v1/analytics/activityHämta chattaktivitets-tidsserieranalytics:read
GET/api/v1/analytics/chatbotsLista per-chatbot prestandastatistikanalytics:read
GET/api/v1/analytics/chatbots/{id}Hämta chatbot-analysanalytics:read
GET/api/v1/analytics/leadsHämta lead-funnelanalytics:read
GET/api/v1/analytics/formsHämta statistik för formulärinskickanalytics:read
GET/api/v1/activityHämta uppmärksamhetssammanfattninganalytics:read

Företag & team

MethodPathDescriptionScope
GET/api/v1/companyHämta företagany key
PATCH/api/v1/companyUppdatera företagcompany:write
GET/api/v1/company/settingsHämta företagsinställningarcompany:read
PATCH/api/v1/company/settingsUppdatera företagsinställningarcompany:write
DELETE/api/v1/company/logoTa bort företagslogotypcompany:write
GET/api/v1/company/membersLista teammedlemmarcompany:read
PATCH/api/v1/company/members/{userId}Ändra medlems rollcompany:write
DELETE/api/v1/company/members/{userId}Ta bort teammedlemcompany:write
GET/api/v1/company/invitesLista inbjudningarcompany:read
POST/api/v1/company/invitesBjuda in teammedlemcompany:write
DELETE/api/v1/company/invites/{id}Avbryt inbjudancompany:write
POST/api/v1/company/invites/{id}/resendSkicka om inbjudancompany:write

Email Assistant

MethodPathDescriptionScope
GET/api/v1/email/connectionsLista mailbox-anslutningaremail:read
GET/api/v1/email/connections/{id}Hämta mailbox-anslutningemail:read
PATCH/api/v1/email/connections/{id}Uppdatera mailbox-anslutningemail:write
DELETE/api/v1/email/connections/{id}Koppla bort mailboxemail:write
GET/api/v1/email/connections/{id}/categoriesLista email-kategorieremail:read
POST/api/v1/email/connections/{id}/categoriesSkapa email-kategoriemail:write
GET/api/v1/email/connections/{id}/foldersLista mailmapparemail:read
POST/api/v1/email/connections/{id}/foldersSkapa mailmappemail:write
GET/api/v1/email/connections/{id}/activityLista email-aktivitetloggemail:read
GET/api/v1/email/categories/{id}Hämta email-kategoriemail:read
PATCH/api/v1/email/categories/{id}Uppdatera email-kategoriemail:write
DELETE/api/v1/email/categories/{id}Radera email-kategoriemail:write
GET/api/v1/email/contactsLista email-kontakteremail:read
GET/api/v1/email/contacts/{id}Hämta email-kontaktemail:read
PATCH/api/v1/email/contacts/{id}Uppdatera email-kontaktemail:write
DELETE/api/v1/email/contacts/{id}Radera email-kontaktemail:write

Konto & aviseringar

MethodPathDescriptionScope
GET/api/v1/meHämta nyckelkontext (whoami)any key
GET/api/v1/account/usageHämta plan och användningany key
GET/api/v1/notificationsLista aviseringarany key
DELETE/api/v1/notificationsRadera gamla lästa aviseringarany key
GET/api/v1/notifications/unread-countHämta antal olästa aviseringarany key
POST/api/v1/notifications/mark-all-readMarkera alla aviseringar som lästaany key
GET/api/v1/notifications/{id}Hämta aviseringany key
PATCH/api/v1/notifications/{id}Markera avisering som lästany key

Blogg (plattform)

MethodPathDescriptionScope
GET/api/v1/blogLista blogginläggany key
POST/api/v1/blogSkapa blogginläggany key
POST/api/v1/blog/assetsLadda upp blogg-resursany key
GET/api/v1/blog/{id}Hämta blogginläggany key
PATCH/api/v1/blog/{id}Uppdatera blogginläggany key
DELETE/api/v1/blog/{id}Radera blogginläggany key
POST/api/v1/blog/{id}/translationsKöa bloggöversättningarany key

Behöver ni hjälp? Kontakta vårt supportteam →

Föregående
Shopify-integration
Nästa
MCP Serverintegration