ChatReact
Paġna ewlenijaDokumentazzjoni

REST API

Il-REST API v1 ta' ChatReact jagħti aċċess programmatiku għall-operazzjonijiet appoġġjati mid-dashboard: chatbots, knowledge base u crawling, prezzijiet strutturati, FAQs, reviżjoni tal-chat u l-Improvement Agent, leads, formoli ta' kuntatt, live chat, kumpanija u tim, l-Email Assistant, analitika u notifications. Azzjonijiet li jeħtieġu browser (pagamenti, awtorizzazzjoni tal-mailbox, passkeys, tħassir tal-kont u maniġment tal-API key) jibqgħu fid-dashboard.

Preferi titkellem ma' assistent AI? L-istess funzjonalitajiet huma disponibbli bħala għodod MCP — ara MCP Server Integration. L-API Explorer interattiv b'skemi ta' request u response jinsab f/api-reference, fejn tista' wkoll tniżżel l-OpenAPI 3.0 specification.

Awtentikazzjoni

  1. Mur Dashboard → Kumpanija → tab API u ikklikkja Oħloq Ċavetta API
  2. Agħżel isem u s-scopes ta' permessi li l-key għandu bżonn (ara hawn taħt)
  3. Kopja l-key — jibda b'cr_ u jintwera darba biss

Ibgħat il-key ma' kull talba:

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

Intlaqa' wkoll header X-API-Key: cr_your_api_key. L-API keys jaqgħu taħt kumpanija waħda u joperaw bil-permessi tal-propjetarju tal-kumpanija; il-limiti tal-pjan u l-feature gates japplikaw eżattament kif fid-dashboard.

L-aċċess għall-API huwa disponibbli fuq il-pjanni mħallsa — ara l-Pricing page. Il-keys jistgħu jiġu revokati fi kwalunkwe ħin mid-dashboard.

Scopes

Kull key iġorr wieħed jew aktar scopes. Endpoint jirritorna 403 meta l-key jonqos mis-scope meħtieġ.

ScopeGrants
chatbots:read / chatbots:writeKonfigurazzjoni tal-chatbot: persona, lingwi, widget, comportament, restrizzjonijiet, core instructions, embed code, learning phase, templates tal-chatbot, settings tal-FAQ widget
knowledge:read / knowledge:writeKnowledge base: dokumenti, crawling tal-websajt, paġni skannjati
faqs:read / faqs:writeFAQs, kategoriji tal-FAQ, suġġerimenti, traduzzjonijiet
chats:read / chats:writeStorja tal-chat, ratings tal-chat, kategoriji ta' kunfidenza, live chat (azzjonijiet tal-aġent jeħtieġu chats:write)
leads:read / leads:writeLeads, kategoriji ta' lead, settings ta' lead capture, esportazzjoni
forms:read / forms:writeFormoli ta' kuntatt u submissions
analytics:readStatistiċi, series ta' attività, funnels, status ta' kunfidenza
company:read / company:writeProfil u settings tal-kumpanija, membri tat-tim, invitations
email:read / email:writeKonnessjonijiet tal-Email Assistant, kategoriji, kuntatti, attività
prices:readAqra entitajiet ta' prezz strutturat, reviżjonijiet, eligibility u suġġerimenti
prices:writeOħloq u editja drafts ta' prezz, importa CSV u applikaxxi suġġeriment bħala draft; jeħtieġ il-propjetarju tal-kumpanija
prices:approveApprova verżjonijiet eżatti jew arkivja entitajiet; jeħtieġ il-propjetarju tal-kumpanija
blog:read / blog:writeKontenut tal-blog tal-pjattaforma (intern ta' ChatReact)
any valid key/v1/me, użu tal-kont, in-notifications tiegħek

Konvenzjonijiet

  • Base URL: https://www.chatreact.ai/api/v1, JSON in u out (Content-Type: application/json).
  • Risposti: { "success": true, "data": … }; lists iżidu "pagination": { "total", "page", "pageSize", "totalPages" }. Uża page u pageSize (massimu 100) fuq endpoints li jirritornaw lists; xi endpoints joffru pagination bi-cursor (cursor / nextCursor).
  • Żbalji: { "success": false, "error": "message", "code": "BAD_REQUEST" } b'details fakultattiv għal żbalji ta' validazzjoni. Status codes: 400 input invalida, 401 key nieqes jew invalida, 403 scope nieqes, feature tal-pjan mhux inkluż jew rwol insuffiċjenti, 404 riżorsa mhux misjuba (anke għal riżorsi ta' kumpaniji oħra), 409 kunflitt, 429 limiti ta' rata ġew mgħaġġla.
  • Aġġornamenti parzjali: endpoints PATCH jinbidlu biss il-kampijiet li tibgħat; kampijiet mhux magħrufa jiġu rifiutati.
  • Rate limit: 30 requests kull minuta għal kull indirizz IP.
  • Operazzjonijiet li jdumu fit-tul (crawl, ġenerazzjoni AI, traduzzjonijiet) jirritornaw malajr b'job jew result li tista' tpoġġa poll għalih; jikkonsumaw it-token u l-bajġet ta' crawl tal-pjan tiegħek.

Endpoints

Prices & services

Is-salvjar, editjar, import u l-applikazzjoni ta' suġġeriment joħolqu drafts mingħajr approvazzjoni. Operazzjonijiet ta' approvazzjoni u arkivjar jikkontrollaw verżjonijiet eżatti; verżjoni stantjata tirritorna kunflitt. Il-keys eżistenti ma jiksbux permessi ta' prezz awtomatikament. Biss il-propjetarju tal-kumpanija jista' jagħti permessi ta' kitba jew approvazzjoni. Għall-workflow tal-klijent, ara Prices & services.

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/pricesLista ta' entitajiet ta' prezz u eligibilityprices:read
POST/api/v1/chatbots/{id}/pricesOħloq draftprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}Aqra dettalji u history paginatprices:read
PATCH/api/v1/chatbots/{id}/prices/{itemId}Oħloq draft imeditjat minn verżjoni mistenniprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}/stateAqra state sħiħ tal-itemprices:read
POST/api/v1/chatbots/{id}/prices/{itemId}/approveApprova verżjoni eżattaprices:approve
POST/api/v1/chatbots/{id}/prices/{itemId}/archiveArkivja verżjoni eżattaprices:approve
POST/api/v1/chatbots/{id}/prices/approve-manyApprova selezzjoni ta' verżjoni esplicita atomikamentprices:approve
POST/api/v1/chatbots/{id}/prices/importImporta drafts CSV b'ID ta' import stabbliprices:write
GET/api/v1/chatbots/{id}/prices/suggestionsLista ta' suġġerimenti ta' prezzprices:read
POST/api/v1/chatbots/{id}/prices/suggestions/{suggestionId}/applyApplika suġġeriment magħżul bħala draftprices:write

Chatbots

MethodPathDescriptionScope
GET/api/v1/chatbotsLista ta' chatbotschatbots:read
POST/api/v1/chatbotsOħloq chatbotchatbots:write
GET/api/v1/chatbots/{id}Aħdem chatbot (Get)chatbots:read
PATCH/api/v1/chatbots/{id}Aġġorna chatbotchatbots:write
DELETE/api/v1/chatbots/{id}Ħassar chatbotchatbots:write
GET/api/v1/chatbots/{id}/personalityAħdem personality tal-chatbotchatbots:read
PATCH/api/v1/chatbots/{id}/personalityAġġorna personality tal-chatbotchatbots:write
GET/api/v1/chatbots/{id}/widgetAħdem settings tal-widgetchatbots:read
PATCH/api/v1/chatbots/{id}/widgetAġġorna settings tal-widgetchatbots:write
GET/api/v1/chatbots/{id}/widget/translationsAħdem traduzzjonijiet tal-widgetchatbots:read
PUT/api/v1/chatbots/{id}/widget/translationsIbdel traduzzjonijiet tal-widgetchatbots:write
GET/api/v1/chatbots/{id}/embedAħdem embed codechatbots:read
POST/api/v1/chatbots/{id}/embed/confirmKkonferma embedchatbots:write
GET/api/v1/chatbots/{id}/learning-phaseAħdem settings tal-learning-phasechatbots:read
PATCH/api/v1/chatbots/{id}/learning-phaseAġġorna settings tal-learning-phasechatbots:write
POST/api/v1/chatbots/{id}/learning-phase/endItlaq il-learning phasechatbots:write
GET/api/v1/chatbots/{id}/instructionsLista ta' core instructionschatbots:read
POST/api/v1/chatbots/{id}/instructionsŻid core instructionchatbots:write
PUT/api/v1/chatbots/{id}/instructions/reorderRiorganizza core instructionschatbots:write
POST/api/v1/chatbots/{id}/instructions/improveIttejjeb instructions bl-AIchatbots:write
GET/api/v1/instructions/{id}Aħdem core instructionchatbots:read
PATCH/api/v1/instructions/{id}Aġġorna core instructionchatbots:write
DELETE/api/v1/instructions/{id}Ħassar core instructionchatbots:write
GET/api/v1/chatbot-templatesLista ta' templates tal-chatbotchatbots:read

Knowledge base

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/knowledgeOverview tal-knowledge baseknowledge:read
GET/api/v1/chatbots/{id}/documentsLista ta' dokumenti għal chatbotknowledge:read
POST/api/v1/chatbots/{id}/documentsUpload dokumentknowledge:write
POST/api/v1/chatbots/{id}/documents/presignPresign għall-upload tad-dokumentknowledge:write
GET/api/v1/documents/{id}Aħdem dokumentknowledge:read
DELETE/api/v1/documents/{id}Ħassar dokumentknowledge:write
POST/api/v1/documents/{id}/confirmIkkonferma presigned uploadknowledge:write
GET/api/v1/chatbots/{id}/crawl/limitsLimiti tal-crawlknowledge:read
POST/api/v1/chatbots/{id}/crawl/previewPreview ta' website scanknowledge:write
GET/api/v1/chatbots/{id}/crawlLista ta' crawl jobsknowledge:read
POST/api/v1/chatbots/{id}/crawlIbda crawlknowledge:write
GET/api/v1/crawl-jobs/{jobId}Aħdem crawl jobknowledge:read
POST/api/v1/crawl-jobs/{jobId}/cancelIkkanċella crawl jobknowledge:write
GET/api/v1/chatbots/{id}/pagesLista ta' crawled pagesknowledge:read
POST/api/v1/chatbots/{id}/pagesŻid URL wieħedknowledge:write
POST/api/v1/chatbots/{id}/pages/bulk-deleteBulk-delete ta' crawled pagesknowledge:write
GET/api/v1/pages/{id}Aħdem crawled pageknowledge:read
DELETE/api/v1/pages/{id}Ħassar crawled pageknowledge:write
POST/api/v1/pages/{id}/recrawlRe-crawl pageknowledge:write
GET/api/v1/chatbots/{id}/websitesLista ta' crawled websitesknowledge:read
DELETE/api/v1/chatbots/{id}/websites/{domain}Ħassar websiteknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawlRe-crawl websiteknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawl/cancelIkkanċella re-crawl tal-websiteknowledge:write

FAQs

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/faqsLista ta' FAQs għal chatbotfaqs:read
POST/api/v1/chatbots/{id}/faqsOħloq FAQfaqs:write
POST/api/v1/chatbots/{id}/faqs/bulkImport bulk ta' FAQsfaqs:write
POST/api/v1/chatbots/{id}/faqs/reorderRiorganizza FAQsfaqs:write
GET/api/v1/chatbots/{id}/faqs/embedAħdem embed code tal-FAQ widgetchatbots:read
POST/api/v1/chatbots/{id}/faqs/purge-cachePurge caches remoti tal-FAQfaqs:write
GET/api/v1/faqs/{id}Aħdem FAQfaqs:read
PATCH/api/v1/faqs/{id}Aġġorna FAQfaqs:write
DELETE/api/v1/faqs/{id}Ħassar FAQfaqs:write
PUT/api/v1/faqs/{id}/translationsAġġorna traduzzjonijiet tal-FAQfaqs:write
POST/api/v1/faqs/{id}/translateTraduzzjoni AI tal-FAQfaqs:write
GET/api/v1/chatbots/{id}/faq-suggestionsLista ta' suġġerimenti tal-FAQfaqs:read
POST/api/v1/chatbots/{id}/faq-suggestions/generateĠenera suġġerimenti tal-FAQ mill-knowledge basefaqs:write
GET/api/v1/faq-suggestions/{id}Aħdem suġġeriment tal-FAQfaqs:read
POST/api/v1/faq-suggestions/{id}/approveApprova suġġeriment tal-FAQfaqs:write
POST/api/v1/faq-suggestions/{id}/rejectIrrifiuta suġġeriment tal-FAQfaqs:write
GET/api/v1/chatbots/{id}/faq-categoriesLista ta' kategoriji tal-FAQfaqs:read
POST/api/v1/chatbots/{id}/faq-categoriesOħloq kategorija tal-FAQfaqs:write
POST/api/v1/chatbots/{id}/faq-categories/reorderRiorganizza kategoriji tal-FAQfaqs:write
GET/api/v1/faq-categories/{id}Aħdem kategorija tal-FAQfaqs:read
PATCH/api/v1/faq-categories/{id}Aġġorna kategorija tal-FAQfaqs:write
DELETE/api/v1/faq-categories/{id}Ħassar kategorija tal-FAQfaqs:write
PUT/api/v1/faq-categories/{id}/translationsAġġorna traduzzjonijiet ta' kategorija tal-FAQfaqs:write
GET/api/v1/chatbots/{id}/faq-widget-settingsAħdem settings tal-FAQ widgetchatbots:read
PATCH/api/v1/chatbots/{id}/faq-widget-settingsAġġorna settings tal-FAQ widgetchatbots:write

Chats, feedback & Improvement Agent

MethodPathDescriptionScope
GET/api/v1/chatsLista ta' sessions tal-chatchats:read
GET/api/v1/chats/{sessionId}Aħdem session tal-chatchats:read
PATCH/api/v1/chats/{sessionId}Settja kategorija ta' kunfidenza tal-chatchats:write
POST/api/v1/chats/{sessionId}/feedbackRata chat (Good / Needs Work)chats:write
POST/api/v1/chats/{sessionId}/feedback/dismissDismiss reviżjoni tal-chatchats:write
POST/api/v1/chats/{sessionId}/improveIbda Improvement Agent għal chatchatbots:write
GET/api/v1/chatbots/{id}/feedbackLista ta' reviżjonijiet tal-chat ta' chatbotchats:read
GET/api/v1/chatbots/{id}/feedback/statsStat cards ta' reviżjoni tal-chatchats:read
GET/api/v1/feedback/{id}Aħdem reviżjoni tal-chatchats:read
PATCH/api/v1/feedback/{id}Override severity tar-reviżjonichats:write
POST/api/v1/feedback/{id}/improvement-sessionIbda Improvement Agent għal reviżjonichatbots:write
GET/api/v1/chatbots/{id}/confidenceAħdem status ta' kunfidenzaanalytics:read
GET/api/v1/chatbots/{id}/confidence-categoriesLista ta' kategoriji ta' kunfidenzachats:read
POST/api/v1/chatbots/{id}/confidence-categoriesOħloq kategorija ta' kunfidenzachatbots:write
PATCH/api/v1/confidence-categories/{id}Aġġorna kategorija ta' kunfidenzachatbots:write
DELETE/api/v1/confidence-categories/{id}Ħassar kategorija ta' kunfidenzachatbots:write
POST/api/v1/confidence-categories/{id}/mergeMerge kategoriji ta' kunfidenzachatbots:write
GET/api/v1/chatbots/{id}/improvement-sessionsLista ta' sessions ta' improvementchatbots:read
GET/api/v1/improvement-sessions/{id}Aħdem session ta' improvementchatbots:read
POST/api/v1/improvement-sessions/{id}/messagesIbgħat messaġġ lill-Improvement Agentchatbots:write
POST/api/v1/improvement-sessions/{id}/completeKompleta session ta' improvementchatbots:write
POST/api/v1/improvement-sessions/{id}/resetReset session ta' improvementchatbots:write
POST/api/v1/improvement-proposals/{id}/applyApplika proposta ta' improvementchatbots:write
POST/api/v1/improvement-proposals/{id}/rejectIrrifiuta proposta ta' improvementchatbots:write
POST/api/v1/improvement-proposals/{id}/simulationsSimula proposta ta' improvementchatbots:write
POST/api/v1/improvement-simulations/{id}/assessmentRata result tas-simulazzjonichatbots:write

Leads

MethodPathDescriptionScope
GET/api/v1/leadsLista ta' leadsleads:read
POST/api/v1/leadsOħloq leadleads:write
GET/api/v1/leads/{id}Aħdem leadleads:read
PATCH/api/v1/leads/{id}Aġġorna leadleads:write
DELETE/api/v1/leads/{id}Ħassar leadleads:write
POST/api/v1/leads/{id}/assignAssenja leadleads:write
POST/api/v1/leads/bulk-statusBulk update status ta' leadleads:write
GET/api/v1/leads/statsStatistiċi ta' leadleads:read
GET/api/v1/leads/exportEsporta leadsleads:read
GET/api/v1/chatbots/{id}/lead-configAħdem konfigurazzjoni ta' lead captureleads:read
PUT/api/v1/chatbots/{id}/lead-configAġġorna konfigurazzjoni ta' lead captureleads:write
GET/api/v1/chatbots/{id}/lead-categoriesLista ta' kategoriji ta' leadleads:read
POST/api/v1/chatbots/{id}/lead-categoriesOħloq kategorija ta' leadleads:write
GET/api/v1/lead-categories/{id}Aħdem kategorija ta' leadleads:read
PATCH/api/v1/lead-categories/{id}Aġġorna kategorija ta' leadleads:write
DELETE/api/v1/lead-categories/{id}Ħassar kategorija ta' leadleads:write
PUT/api/v1/lead-categories/{id}/users/{userId}Assenja membru għal kategorija ta' leadleads:write
DELETE/api/v1/lead-categories/{id}/users/{userId}Neħħi membru minn kategorija ta' leadleads:write

Contact forms

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/formsLista ta' contact formsforms:read
POST/api/v1/chatbots/{id}/formsOħloq contact formforms:write
GET/api/v1/forms/{id}Aħdem contact formforms:read
PATCH/api/v1/forms/{id}Aġġorna contact formforms:write
DELETE/api/v1/forms/{id}Ħassar contact formforms:write
GET/api/v1/forms/{id}/submissionsLista ta' submissions tal-formforms:read
GET/api/v1/forms/{id}/statsStatistiċi ta' submissions tal-formforms:read
GET/api/v1/submissions/{id}Aħdem submission tal-formforms:read
PATCH/api/v1/submissions/{id}Reviżjoni ta' submission tal-formforms:write
DELETE/api/v1/submissions/{id}Ħassar submission tal-formforms:write

Live chat

MethodPathDescriptionScope
GET/api/v1/live-chat/availabilityAħdem disponibbiltà tiegħek għall-live chatchats:read
PUT/api/v1/live-chat/availabilitySettja disponibbiltà tiegħek għall-live chatchats:write
POST/api/v1/live-chat/heartbeatIbgħat presence heartbeatchats:write
GET/api/v1/live-chat/agentsLista ta' aġenti disponibbli għall-live chatchats:read
GET/api/v1/live-chat/sessionsLista ta' sessions tal-live chatchats:read
GET/api/v1/live-chat/sessions/{sessionId}Aħdem session tal-live chatchats:read
POST/api/v1/live-chat/sessions/{sessionId}/assignĦu live chat (assenja lill-propjetarju tal-key)chats:write
POST/api/v1/live-chat/sessions/{sessionId}/messagesIbgħat messaġġ bħala aġentchats:write
POST/api/v1/live-chat/sessions/{sessionId}/closeEnd live chatchats:write

Analitika

MethodPathDescriptionScope
GET/api/v1/analyticsAħdem overview tal-analitikaanalytics:read
GET/api/v1/analytics/activityAħdem series ta' attività tal-chatanalytics:read
GET/api/v1/analytics/chatbotsLista ta' stats ta' performance per-chatbotanalytics:read
GET/api/v1/analytics/chatbots/{id}Aħdem analitika tal-chatbotanalytics:read
GET/api/v1/analytics/leadsAħdem funnel tal-leadanalytics:read
GET/api/v1/analytics/formsAħdem stats tas-submissions tal-formanalytics:read
GET/api/v1/activityAħdem attention summaryanalytics:read

Kumpanija & tim

MethodPathDescriptionScope
GET/api/v1/companyAħdem kumpanijaany key
PATCH/api/v1/companyAġġorna kumpanijacompany:write
GET/api/v1/company/settingsAħdem settings tal-kumpanijacompany:read
PATCH/api/v1/company/settingsAġġorna settings tal-kumpanijacompany:write
DELETE/api/v1/company/logoNeħħi logo tal-kumpanijacompany:write
GET/api/v1/company/membersLista ta' membri tat-timcompany:read
PATCH/api/v1/company/members/{userId}Ibdel rwol tal-membrucompany:write
DELETE/api/v1/company/members/{userId}Neħħi membru tat-timcompany:write
GET/api/v1/company/invitesLista ta' invitationscompany:read
POST/api/v1/company/invitesIvvita membru tat-timcompany:write
DELETE/api/v1/company/invites/{id}Ikkanċella invitationcompany:write
POST/api/v1/company/invites/{id}/resendIritorna invitationcompany:write

Email Assistant

MethodPathDescriptionScope
GET/api/v1/email/connectionsLista ta' konnessjonijiet ta' mailboxemail:read
GET/api/v1/email/connections/{id}Aħdem konnessjoni tal-mailboxemail:read
PATCH/api/v1/email/connections/{id}Aġġorna konnessjoni tal-mailboxemail:write
DELETE/api/v1/email/connections/{id}Iċċekkja mailbox (disconnect)email:write
GET/api/v1/email/connections/{id}/categoriesLista ta' kategoriji tal-emailemail:read
POST/api/v1/email/connections/{id}/categoriesOħloq kategorija tal-emailemail:write
GET/api/v1/email/connections/{id}/foldersLista ta' folders tal-mailemail:read
POST/api/v1/email/connections/{id}/foldersOħloq folder tal-mailemail:write
GET/api/v1/email/connections/{id}/activityLista ta' log tal-attività tal-emailemail:read
GET/api/v1/email/categories/{id}Aħdem kategorija tal-emailemail:read
PATCH/api/v1/email/categories/{id}Aġġorna kategorija tal-emailemail:write
DELETE/api/v1/email/categories/{id}Ħassar kategorija tal-emailemail:write
GET/api/v1/email/contactsLista ta' kuntatti tal-emailemail:read
GET/api/v1/email/contacts/{id}Aħdem kuntatt tal-emailemail:read
PATCH/api/v1/email/contacts/{id}Aġġorna kuntatt tal-emailemail:write
DELETE/api/v1/email/contacts/{id}Ħassar kuntatt tal-emailemail:write

Kont u notifications

MethodPathDescriptionScope
GET/api/v1/meAħdem key context (whoami)any key
GET/api/v1/account/usageAħdem pjan u użuany key
GET/api/v1/notificationsLista ta' notificationsany key
DELETE/api/v1/notificationsĦassar notifications qodma u mqrawany key
GET/api/v1/notifications/unread-countAħdem count ta' notifications mhux mqrajjinany key
POST/api/v1/notifications/mark-all-readMark all notifications as readany key
GET/api/v1/notifications/{id}Aħdem notificationany key
PATCH/api/v1/notifications/{id}Mark notification bħala mqraany key

Blog (pjattaforma)

MethodPathDescriptionScope
GET/api/v1/blogLista ta' posts tal-blogany key
POST/api/v1/blogOħloq post tal-blogany key
POST/api/v1/blog/assetsUpload asset tal-blogany key
GET/api/v1/blog/{id}Aħdem post tal-blogany key
PATCH/api/v1/blog/{id}Aġġorna post tal-blogany key
DELETE/api/v1/blog/{id}Ħassar post tal-blogany key
POST/api/v1/blog/{id}/translationsQueue traduzzjonijiet tal-blogany key

Bżonn għajnuna? Ikkuntattja lit-tim tas-support →

Preċedenti
Integrazjoni ma' Shopify
Li jmiss
Integrazjoni tal-Server MCP