PočetnaDokumentacija

REST API

ChatReact REST API v1 pruža vam programski pristup podržanim operacijama iz kontrolne ploče: chatboti, baza znanja i crawling, strukturirane cijene, FAQ-ovi, pregled chatova i Improvement Agent, leadovi, kontakt forme, live chat, tvrtka i tim, Email Assistant, analitika i notifikacije. Radnje vezane uz preglednik (plaćanja, autorizacija poštanskog sandučića, passkey-evi, brisanje računa i upravljanje API ključevima) ostaju u kontrolnoj ploči.

Preferirate razgovarati s AI asistentom? Iste mogućnosti dostupne su kao MCP alati — pogledajte MCP Server Integration. Interaktivni API Explorer s shemama zahtjeva i odgovora nalazi se na /api-reference, gdje također možete preuzeti OpenAPI 3.0 specifikaciju.

Autentikacija

  1. Idite na Nadzorna ploča → Tvrtka → API karticu i kliknite Stvori API ključ
  2. Odaberite naziv i dozvole (scopeove) koje ključ treba (vidi dolje)
  3. Kopirajte ključ — počinje s cr_ i prikazuje se samo jednom

Pošaljite ključ sa svakim zahtjevom:

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

Prihvaćen je i X-API-Key: cr_your_api_key header. API ključevi pripadaju jednoj tvrtki i izvršavaju se s dozvolama vlasnika tvrtke; ograničenja plana i feature gateovi primjenjuju se isto kao u kontrolnoj ploči.

API pristup dostupan je na plaćenim planovima — pogledajte Pricing page. Ključevi se mogu opozvati u bilo kojem trenutku iz kontrolne ploče.

Scopeovi

Svaki ključ nosi jedan ili više scopeova. Endpoint vraća 403 kada ključu nedostaje potrebni scope.

ScopeDaje
chatbots:read / chatbots:writeKonfiguracija chatbota: persona, jezici, widget, ponašanje, ograničenja, osnovne instrukcije, embed kod, faza učenja, predlošci chatbota, postavke FAQ widgeta
knowledge:read / knowledge:writeBaza znanja: dokumenti, crawling weba, crawlane stranice
faqs:read / faqs:writeFAQ-ovi, kategorije FAQ-ova, prijedlozi, prijevodi
chats:read / chats:writePovijest chatova, ocjene chatova, kategorije povjerenja, live chat (akcije agenta trebaju chats:write)
leads:read / leads:writeLeadovi, kategorije leadova, postavke prikupljanja leadova, izvoz
forms:read / forms:writeKontakt forme i prijave
analytics:readStatistika, vremenske serije aktivnosti, funneli, status povjerenja
company:read / company:writeProfil tvrtke i postavke, članovi tima, pozivnice
email:read / email:writeEmail Assistant veze, kategorije, kontakti, aktivnost
prices:readČitanje strukturiranih unosa cijena, revizije, podobnost i prijedlozi
prices:writeKreiranje i uređivanje nacrta cijena, uvoz CSV-a i primjena prijedloga kao nacrt; zahtijeva vlasnika tvrtke
prices:approveOdobravanje točnih verzija ili arhiviranje unosa; zahtijeva vlasnika tvrtke
blog:read / blog:writeSadržaj platform bloga (ChatReact interno)
any valid key/v1/me, korištenje računa, vaše notifikacije

Konvencije

  • Base URL: https://www.chatreact.ai/api/v1, JSON ulaz i izlaz (Content-Type: application/json).
  • Odgovori: { "success": true, "data": … }; liste dodaju "pagination": { "total", "page", "pageSize", "totalPages" }. Koristite page i pageSize (max 100) na endpointima za liste; neki endpointi nude cursor paginaciju (cursor / nextCursor).
  • Greške: { "success": false, "error": "message", "code": "BAD_REQUEST" } s opcionalnim details za validacijske greške. Statusni kodovi: 400 neispravan unos, 401 nedostajući ili neispravan ključ, 403 nedostajući scope, feature plana nije uključen ili nedovoljna uloga, 404 resurs nije pronađen (također za resurse drugih tvrtki), 409 konflikt, 429 prekoračenje rate limita.
  • Djelomična ažuriranja: PATCH endpointi mijenjaju samo polja koja pošaljete; nepoznata polja se odbacuju.
  • Rate limit: 30 zahtjeva po minuti po IP adresi.
  • Dugotrajne operacije (crawling, AI generiranje, prijevodi) vraćaju se brzo s poslom ili rezultatom koji možete pollati; one troše tokene i crawl budžet vašeg plana.

Endpointi

Prices & services

Spremanje, uređivanje, uvoz i primjena prijedloga kreiraju nacrte bez odobrenja. Operacije odobravanja i arhiviranja pregledavaju točne verzije; zastarjela verzija vraća konflikt. Postojeći ključevi ne dobivaju automatski dozvole za cijene. Samo vlasnik tvrtke može dodijeliti dozvole za pisanje ili odobrenje. Za workflow klijenta, pogledajte Prices & services.

MethodPathOpisScope
GET/api/v1/chatbots/{id}/pricesPopis unosa cijena i podobnostprices:read
POST/api/v1/chatbots/{id}/pricesKreiraj nacrtprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}Pročitaj detalje i paginiranu povijestprices:read
PATCH/api/v1/chatbots/{id}/prices/{itemId}Kreiraj uređeni nacrt iz očekivane verzijeprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}/statePročitaj puni status stavkeprices:read
POST/api/v1/chatbots/{id}/prices/{itemId}/approveOdobri točnu verzijuprices:approve
POST/api/v1/chatbots/{id}/prices/{itemId}/archiveArhiviraj točnu verzijuprices:approve
POST/api/v1/chatbots/{id}/prices/approve-manyAtomskom odobritev izričite odabire verzijeprices:approve
POST/api/v1/chatbots/{id}/prices/importUvoz CSV nacrta sa stabilnim import ID-jemprices:write
GET/api/v1/chatbots/{id}/prices/suggestionsPopis prijedloga za cijeneprices:read
POST/api/v1/chatbots/{id}/prices/suggestions/{suggestionId}/applyPrimijeni odabrani prijedlog kao nacrtprices:write

Chatboti

MethodPathOpisScope
GET/api/v1/chatbotsPopis chatbotachatbots:read
POST/api/v1/chatbotsKreiraj chatbotachatbots:write
GET/api/v1/chatbots/{id}Dohvati chatbotachatbots:read
PATCH/api/v1/chatbots/{id}Ažuriraj chatbotachatbots:write
DELETE/api/v1/chatbots/{id}Izbriši chatbotachatbots:write
GET/api/v1/chatbots/{id}/personalityDohvati osobnost chatbotachatbots:read
PATCH/api/v1/chatbots/{id}/personalityAžuriraj osobnost chatbotachatbots:write
GET/api/v1/chatbots/{id}/widgetDohvati postavke widgetachatbots:read
PATCH/api/v1/chatbots/{id}/widgetAžuriraj postavke widgetachatbots:write
GET/api/v1/chatbots/{id}/widget/translationsDohvati prijevode widgetachatbots:read
PUT/api/v1/chatbots/{id}/widget/translationsZamijeni prijevode widgetachatbots:write
GET/api/v1/chatbots/{id}/embedDohvati embed kodchatbots:read
POST/api/v1/chatbots/{id}/embed/confirmPotvrdi embedchatbots:write
GET/api/v1/chatbots/{id}/learning-phaseDohvati postavke faze učenjachatbots:read
PATCH/api/v1/chatbots/{id}/learning-phaseAžuriraj postavke faze učenjachatbots:write
POST/api/v1/chatbots/{id}/learning-phase/endZavršetak faze učenjachatbots:write
GET/api/v1/chatbots/{id}/instructionsPopis osnovnih instrukcijachatbots:read
POST/api/v1/chatbots/{id}/instructionsDodaj osnovnu instrukcijuchatbots:write
PUT/api/v1/chatbots/{id}/instructions/reorderPromijeni redoslijed osnovnih instrukcijachatbots:write
POST/api/v1/chatbots/{id}/instructions/improvePoboljšaj instrukcije s AI-jemchatbots:write
GET/api/v1/instructions/{id}Dohvati osnovnu instrukcijuchatbots:read
PATCH/api/v1/instructions/{id}Ažuriraj osnovnu instrukcijuchatbots:write
DELETE/api/v1/instructions/{id}Izbriši osnovnu instrukcijuchatbots:write
GET/api/v1/chatbot-templatesPopis predložaka chatbotachatbots:read

Baza znanja

MethodPathOpisScope
GET/api/v1/chatbots/{id}/knowledgePregled baze znanjaknowledge:read
GET/api/v1/chatbots/{id}/documentsPopis dokumenata za chatbotaknowledge:read
POST/api/v1/chatbots/{id}/documentsUčitaj dokumentknowledge:write
POST/api/v1/chatbots/{id}/documents/presignPresign za upload dokumentaknowledge:write
GET/api/v1/documents/{id}Dohvati dokumentknowledge:read
DELETE/api/v1/documents/{id}Izbriši dokumentknowledge:write
POST/api/v1/documents/{id}/confirmPotvrdi presigned uploadknowledge:write
GET/api/v1/chatbots/{id}/crawl/limitsOgraničenja crawlanjaknowledge:read
POST/api/v1/chatbots/{id}/crawl/previewPregled skeniranja webaknowledge:write
GET/api/v1/chatbots/{id}/crawlPopis crawl poslovaknowledge:read
POST/api/v1/chatbots/{id}/crawlPokreni crawlknowledge:write
GET/api/v1/crawl-jobs/{jobId}Dohvati crawl posaoknowledge:read
POST/api/v1/crawl-jobs/{jobId}/cancelOtkaži crawl posaoknowledge:write
GET/api/v1/chatbots/{id}/pagesPopis crawlanih stranicaknowledge:read
POST/api/v1/chatbots/{id}/pagesDodaj pojedinačni URLknowledge:write
POST/api/v1/chatbots/{id}/pages/bulk-deleteMasovno brisanje crawlanih stranicaknowledge:write
GET/api/v1/pages/{id}Dohvati crawlanu stranicuknowledge:read
DELETE/api/v1/pages/{id}Izbriši crawlanu stranicuknowledge:write
POST/api/v1/pages/{id}/recrawlPonovno crawlaj stranicuknowledge:write
GET/api/v1/chatbots/{id}/websitesPopis crawlanih webovaknowledge:read
DELETE/api/v1/chatbots/{id}/websites/{domain}Izbriši webknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawlPonovno crawlaj webknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawl/cancelOtkaži ponovno crawlanje webaknowledge:write

FAQ-ovi

MethodPathOpisScope
GET/api/v1/chatbots/{id}/faqsPopis FAQ-ova za chatbotafaqs:read
POST/api/v1/chatbots/{id}/faqsKreiraj FAQfaqs:write
POST/api/v1/chatbots/{id}/faqs/bulkMasovni uvoz FAQ-ovafaqs:write
POST/api/v1/chatbots/{id}/faqs/reorderPromijeni redoslijed FAQ-ovafaqs:write
GET/api/v1/chatbots/{id}/faqs/embedDohvati embed kod FAQ widgetachatbots:read
POST/api/v1/chatbots/{id}/faqs/purge-cacheOčisti udaljene cache-ove FAQ-ovafaqs:write
GET/api/v1/faqs/{id}Dohvati FAQfaqs:read
PATCH/api/v1/faqs/{id}Ažuriraj FAQfaqs:write
DELETE/api/v1/faqs/{id}Izbriši FAQfaqs:write
PUT/api/v1/faqs/{id}/translationsAžuriraj prijevode FAQ kategorijafaqs:write
POST/api/v1/faqs/{id}/translateAI-prevedi FAQfaqs:write
GET/api/v1/chatbots/{id}/faq-suggestionsPopis prijedloga za FAQfaqs:read
POST/api/v1/chatbots/{id}/faq-suggestions/generateGeneriraj prijedloge za FAQ iz baze znanjafaqs:write
GET/api/v1/faq-suggestions/{id}Dohvati prijedlog FAQ-afaqs:read
POST/api/v1/faq-suggestions/{id}/approveOdobri prijedlog FAQ-afaqs:write
POST/api/v1/faq-suggestions/{id}/rejectOdbaci prijedlog FAQ-afaqs:write
GET/api/v1/chatbots/{id}/faq-categoriesPopis kategorija FAQ-ovafaqs:read
POST/api/v1/chatbots/{id}/faq-categoriesKreiraj kategoriju FAQ-afaqs:write
POST/api/v1/chatbots/{id}/faq-categories/reorderPromijeni redoslijed kategorija FAQ-ovafaqs:write
GET/api/v1/faq-categories/{id}Dohvati kategoriju FAQ-afaqs:read
PATCH/api/v1/faq-categories/{id}Ažuriraj kategoriju FAQ-afaqs:write
DELETE/api/v1/faq-categories/{id}Izbriši kategoriju FAQ-afaqs:write
PUT/api/v1/faq-categories/{id}/translationsAžuriraj prijevode kategorije FAQ-afaqs:write
GET/api/v1/chatbots/{id}/faq-widget-settingsDohvati postavke FAQ widgetachatbots:read
PATCH/api/v1/chatbots/{id}/faq-widget-settingsAžuriraj postavke FAQ widgetachatbots:write

Chatovi, feedback & Improvement Agent

MethodPathOpisScope
GET/api/v1/chatsPopis chat sesijachats:read
GET/api/v1/chats/{sessionId}Dohvati chat sesijuchats:read
PATCH/api/v1/chats/{sessionId}Postavi kategoriju povjerenja chatachats:write
POST/api/v1/chats/{sessionId}/feedbackOcijeni chat (Good / Needs Work)chats:write
POST/api/v1/chats/{sessionId}/feedback/dismissOdbaci pregled chatachats:write
POST/api/v1/chats/{sessionId}/improvePokreni Improvement Agent za chatchatbots:write
GET/api/v1/chatbots/{id}/feedbackPopis pregledâ chatova određenog chatbotachats:read
GET/api/v1/chatbots/{id}/feedback/statsStat kartice pregleda chatovachats:read
GET/api/v1/feedback/{id}Dohvati pregled chatachats:read
PATCH/api/v1/feedback/{id}Prepiši ozbiljnost pregledachats:write
POST/api/v1/feedback/{id}/improvement-sessionPokreni Improvement Agent za pregledchatbots:write
GET/api/v1/chatbots/{id}/confidenceDohvati status povjerenjaanalytics:read
GET/api/v1/chatbots/{id}/confidence-categoriesPopis kategorija povjerenjachats:read
POST/api/v1/chatbots/{id}/confidence-categoriesKreiraj kategoriju povjerenjachatbots:write
PATCH/api/v1/confidence-categories/{id}Ažuriraj kategoriju povjerenjachatbots:write
DELETE/api/v1/confidence-categories/{id}Izbriši kategoriju povjerenjachatbots:write
POST/api/v1/confidence-categories/{id}/mergeSpajanje kategorija povjerenjachatbots:write
GET/api/v1/chatbots/{id}/improvement-sessionsPopis improvement sesijachatbots:read
GET/api/v1/improvement-sessions/{id}Dohvati improvement sesijuchatbots:read
POST/api/v1/improvement-sessions/{id}/messagesPošalji poruku Improvement Agentuchatbots:write
POST/api/v1/improvement-sessions/{id}/completeZavršetak improvement sesijechatbots:write
POST/api/v1/improvement-sessions/{id}/resetResetiraj improvement sesijuchatbots:write
POST/api/v1/improvement-proposals/{id}/applyPrimijeni prijedlog poboljšanjachatbots:write
POST/api/v1/improvement-proposals/{id}/rejectOdbij prijedlog poboljšanjachatbots:write
POST/api/v1/improvement-proposals/{id}/simulationsSimuliraj prijedlog poboljšanjachatbots:write
POST/api/v1/improvement-simulations/{id}/assessmentOcijeni rezultat simulacijechatbots:write

Leadovi

MethodPathOpisScope
GET/api/v1/leadsPopis leadovaleads:read
POST/api/v1/leadsKreiraj leadaleads:write
GET/api/v1/leads/{id}Dohvati leadaleads:read
PATCH/api/v1/leads/{id}Ažuriraj leadaleads:write
DELETE/api/v1/leads/{id}Izbriši leadaleads:write
POST/api/v1/leads/{id}/assignDodijeli leadaleads:write
POST/api/v1/leads/bulk-statusMasovno ažuriranje statusa leadovaleads:write
GET/api/v1/leads/statsStatistika leadovaleads:read
GET/api/v1/leads/exportIzvoz leadovaleads:read
GET/api/v1/chatbots/{id}/lead-configDohvati konfiguraciju prikupljanja leadovaleads:read
PUT/api/v1/chatbots/{id}/lead-configAžuriraj konfiguraciju prikupljanja leadovaleads:write
GET/api/v1/chatbots/{id}/lead-categoriesPopis kategorija leadovaleads:read
POST/api/v1/chatbots/{id}/lead-categoriesKreiraj kategoriju leadovaleads:write
GET/api/v1/lead-categories/{id}Dohvati kategoriju leadovaleads:read
PATCH/api/v1/lead-categories/{id}Ažuriraj kategoriju leadovaleads:write
DELETE/api/v1/lead-categories/{id}Izbriši kategoriju leadovaleads:write
PUT/api/v1/lead-categories/{id}/users/{userId}Dodijeli člana kategoriji leadovaleads:write
DELETE/api/v1/lead-categories/{id}/users/{userId}Ukloni člana iz kategorije leadovaleads:write

Kontakt forme

MethodPathOpisScope
GET/api/v1/chatbots/{id}/formsPopis kontakt formiforms:read
POST/api/v1/chatbots/{id}/formsKreiraj kontakt formuforms:write
GET/api/v1/forms/{id}Dohvati kontakt formuforms:read
PATCH/api/v1/forms/{id}Ažuriraj kontakt formuforms:write
DELETE/api/v1/forms/{id}Izbriši kontakt formuforms:write
GET/api/v1/forms/{id}/submissionsPopis prijava formiforms:read
GET/api/v1/forms/{id}/statsStatistika prijava formiforms:read
GET/api/v1/submissions/{id}Dohvati prijavu formeforms:read
PATCH/api/v1/submissions/{id}Pregledaj prijavu formeforms:write
DELETE/api/v1/submissions/{id}Izbriši prijavu formeforms:write

Live chat

MethodPathOpisScope
GET/api/v1/live-chat/availabilityDohvati vlastitu dostupnost za live chatchats:read
PUT/api/v1/live-chat/availabilityPostavi vlastitu dostupnost za live chatchats:write
POST/api/v1/live-chat/heartbeatPošalji heartbeat prisutnostichats:write
GET/api/v1/live-chat/agentsPopis dostupnih live chat agenatachats:read
GET/api/v1/live-chat/sessionsPopis live chat sesijachats:read
GET/api/v1/live-chat/sessions/{sessionId}Dohvati live chat sesijuchats:read
POST/api/v1/live-chat/sessions/{sessionId}/assignPreuzmi live chat (dodijeli vlasniku ključa)chats:write
POST/api/v1/live-chat/sessions/{sessionId}/messagesPošalji poruku kao agentchats:write
POST/api/v1/live-chat/sessions/{sessionId}/closeZavrši live chatchats:write

Analitika

MethodPathOpisScope
GET/api/v1/analyticsDohvati pregled analitikeanalytics:read
GET/api/v1/analytics/activityDohvati vremenske serije aktivnosti chatovaanalytics:read
GET/api/v1/analytics/chatbotsPopis statistika performansi po chatbotuanalytics:read
GET/api/v1/analytics/chatbots/{id}Dohvati analitiku chatbotaanalytics:read
GET/api/v1/analytics/leadsDohvati lead funnelanalytics:read
GET/api/v1/analytics/formsDohvati statistiku prijava formianalytics:read
GET/api/v1/activityDohvati sažetak pozornostianalytics:read

Tvrtka & tim

MethodPathOpisScope
GET/api/v1/companyDohvati tvrtkuany key
PATCH/api/v1/companyAžuriraj tvrtkucompany:write
GET/api/v1/company/settingsDohvati postavke tvrtkecompany:read
PATCH/api/v1/company/settingsAžuriraj postavke tvrtkecompany:write
DELETE/api/v1/company/logoUkloni logo tvrtkecompany:write
GET/api/v1/company/membersPopis članova timacompany:read
PATCH/api/v1/company/members/{userId}Promijeni ulogu članacompany:write
DELETE/api/v1/company/members/{userId}Ukloni člana timacompany:write
GET/api/v1/company/invitesPopis pozivnicacompany:read
POST/api/v1/company/invitesPozovi člana timacompany:write
DELETE/api/v1/company/invites/{id}Otkaži pozivnicucompany:write
POST/api/v1/company/invites/{id}/resendPonovno pošalji pozivnicucompany:write

Email Assistant

MethodPathOpisScope
GET/api/v1/email/connectionsPopis veza sandučićaemail:read
GET/api/v1/email/connections/{id}Dohvati vezu sandučićaemail:read
PATCH/api/v1/email/connections/{id}Ažuriraj vezu sandučićaemail:write
DELETE/api/v1/email/connections/{id}Prekini vezu sandučićaemail:write
GET/api/v1/email/connections/{id}/categoriesPopis email kategorijaemail:read
POST/api/v1/email/connections/{id}/categoriesKreiraj email kategorijuemail:write
GET/api/v1/email/connections/{id}/foldersPopis mapa pošteemail:read
POST/api/v1/email/connections/{id}/foldersKreiraj mapu pošteemail:write
GET/api/v1/email/connections/{id}/activityPopis zapisa aktivnosti emailaemail:read
GET/api/v1/email/categories/{id}Dohvati email kategorijuemail:read
PATCH/api/v1/email/categories/{id}Ažuriraj email kategorijuemail:write
DELETE/api/v1/email/categories/{id}Izbriši email kategorijuemail:write
GET/api/v1/email/contactsPopis email kontakataemail:read
GET/api/v1/email/contacts/{id}Dohvati email kontaktemail:read
PATCH/api/v1/email/contacts/{id}Ažuriraj email kontaktemail:write
DELETE/api/v1/email/contacts/{id}Izbriši email kontaktemail:write

Račun & notifikacije

MethodPathOpisScope
GET/api/v1/meDohvati kontekst ključa (whoami)any key
GET/api/v1/account/usageDohvati plan i korištenjeany key
GET/api/v1/notificationsPopis notifikacijaany key
DELETE/api/v1/notificationsIzbriši stare pročitane notifikacijeany key
GET/api/v1/notifications/unread-countDohvati broj nepročitanih notifikacijaany key
POST/api/v1/notifications/mark-all-readOznači sve notifikacije kao pročitaneany key
GET/api/v1/notifications/{id}Dohvati notifikacijuany key
PATCH/api/v1/notifications/{id}Označi notifikaciju kao pročitanuany key

Blog (platforma)

MethodPathOpisScope
GET/api/v1/blogPopis blog postovaany key
POST/api/v1/blogKreiraj blog postany key
POST/api/v1/blog/assetsUčitaj blog assetany key
GET/api/v1/blog/{id}Dohvati blog postany key
PATCH/api/v1/blog/{id}Ažuriraj blog postany key
DELETE/api/v1/blog/{id}Izbriši blog postany key
POST/api/v1/blog/{id}/translationsStavi u queue prijevode blogaany key

Trebate pomoć? Kontaktirajte našu podršku →