НачалоДокументация

REST API

ChatReact REST API v1 ви дава програматичен достъп до поддържаните операции в таблото: чатботове, знаниева база и обхождане, структурирани цени, ЧЗВ, преглед на чатове и Improvement Agent, лийдове, контактни формуляри, live chat, компания и екип, Email Assistant, аналитика и известия. Действия, които се изпълняват в браузъра (плащания, овластяване на пощенска кутия, passkeys, изтриване на акаунт и управление на API ключове) остават в таблото.

Предпочитате да говорите с AI асистент? Същите възможности са налични като MCP инструменти — вижте MCP Server Integration. Интерактивният API Explorer с схеми на заявки и отговори е на /api-reference, където също можете да изтеглите OpenAPI 3.0 спецификацията.

Удостоверяване

  1. Отидете в Табло → Компания → API таб и кликнете Създай API ключ
  2. Изберете име и разрешителните обхвати, от които ключът се нуждае (вижте по-долу)
  3. Копирайте ключа — той започва с cr_ и се показва само веднъж

Изпращайте ключа с всяка заявка:

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

Задължително се приема и X-API-Key: cr_your_api_key хедър. API ключовете принадлежат на една компания и изпълняват с разрешенията на собственика на компанията; лимитите на плана и ограниченията за функции важат същите както в таблото.

Достъпът до API е наличен в платените планове — вижте Pricing page. Ключовете могат да бъдат оттеглени по всяко време от таблото.

Обхвати

Всеки ключ носи един или повече обхвати. Крайна точка връща 403 когато ключът няма необходимия обхват.

ScopeGrants
chatbots:read / chatbots:writeКонфигурация на чатбот: персона, езици, widget, поведение, ограничения, основни инструкции, embed код, learning phase, шаблони за чатбот, настройки на FAQ widget
knowledge:read / knowledge:writeЗнаниева база: документи, обхождане на уебсайтове, обхождани страници
faqs:read / faqs:writeЧЗВ, категории ЧЗВ, предложения, преводи
chats:read / chats:writeИстория на чатове, оценки на чатове, категории доверие, live chat (действията на агент изискват chats:write)
leads:read / leads:writeЛийдове, категории лийдове, настройки за улавяне на лийд, експорт
forms:read / forms:writeКонтактни формуляри и подадени форми
analytics:readСтатистики, времеви серии на активност, фунии, статус на доверие
company:read / company:writeПрофил на компанията и настройки, членове на екипа, покани
email:read / email:writeEmail Assistant връзки, категории, контакти, активност
prices:readЧетене на структурирани ценови записи, ревизии, допустимост и предложения
prices:writeСъздаване и редакция на чернови цени, импорт на CSV и прилагане на предложение като чернова; изисква собственик на компанията
prices:approveОдобрение на точни версии или архивиране на записи; изисква собственик на компанията
blog:read / blog:writeСъдържание на платформения блог (ChatReact вътрешно)
any valid key/v1/me, използване на акаунта, вашите известия

Конвенции

  • Base URL: https://www.chatreact.ai/api/v1, JSON вход и изход (Content-Type: application/json).
  • Отговори: { "success": true, "data": … }; списъците добавят "pagination": { "total", "page", "pageSize", "totalPages" }. Използвайте page и pageSize (макс. 100) при списъчни крайни точки; някои крайни точки предлагат курсорна пагинация (cursor / nextCursor).
  • Грешки: { "success": false, "error": "message", "code": "BAD_REQUEST" } с опционален details за валидационни грешки. Статус кодове: 400 невалиден вход, 401 липсващ или невалиден ключ, 403 липсващ обхват, функция от плана не е включена или ролята е недостатъчна, 404 ресурсът не е намерен (също и за ресурси на други компании), 409 конфликт, 429 превишен rate limit.
  • Частични ъпдейти: PATCH крайни точки променят само полетата, които изпращате; неизвестни полета се отхвърлят.
  • Rate limit: 30 заявки на минута на IP адрес.
  • Дългосрочни операции (обхождания, AI генериране, преводи) връщат бързо с job или резултат, които можете да поллвате; те консумират токен и бюджет за обхождане от вашия план.

Крайни точки

Prices & services

Записване, редакция, импорт и прилагане на предложение създават чернови без одобрение. Операциите за одобрение и архивиране преглеждат точни версии; остаряла версия връща конфликт. Съществуващите ключове не придобиват автоматично разрешения за цени. Само собственикът на компанията може да дава права за запис или одобрение. За workflow на клиента вижте Prices & services.

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/pricesСписък на ценови записи и допустимостprices:read
POST/api/v1/chatbots/{id}/pricesСъздаване на черноваprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}Прочитане на детайли и странирана историяprices:read
PATCH/api/v1/chatbots/{id}/prices/{itemId}Създаване на редактирана чернова от очаквана версияprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}/stateПрочитане на пълното състояние на елементаprices:read
POST/api/v1/chatbots/{id}/prices/{itemId}/approveОдобряване на точна версияprices:approve
POST/api/v1/chatbots/{id}/prices/{itemId}/archiveАрхивиране на точна версияprices:approve
POST/api/v1/chatbots/{id}/prices/approve-manyОдобряване на явен избор на версия атомарноprices:approve
POST/api/v1/chatbots/{id}/prices/importИмпорт на CSV чернови със стабилен import IDprices:write
GET/api/v1/chatbots/{id}/prices/suggestionsСписък с ценови предложенияprices:read
POST/api/v1/chatbots/{id}/prices/suggestions/{suggestionId}/applyПрилагане на избрано предложение като черноваprices:write

Chatbots

MethodPathDescriptionScope
GET/api/v1/chatbotsСписък с чатботовеchatbots:read
POST/api/v1/chatbotsСъздаване на чатботchatbots:write
GET/api/v1/chatbots/{id}Получаване на чатботchatbots:read
PATCH/api/v1/chatbots/{id}Актуализиране на чатботchatbots:write
DELETE/api/v1/chatbots/{id}Изтриване на чатботchatbots:write
GET/api/v1/chatbots/{id}/personalityПолучаване на личност на чатботchatbots:read
PATCH/api/v1/chatbots/{id}/personalityАктуализиране на личност на чатботchatbots:write
GET/api/v1/chatbots/{id}/widgetПолучаване на настройки на widgetchatbots:read
PATCH/api/v1/chatbots/{id}/widgetАктуализиране на настройки на widgetchatbots:write
GET/api/v1/chatbots/{id}/widget/translationsПолучаване на преводи за widgetchatbots:read
PUT/api/v1/chatbots/{id}/widget/translationsЗамяна на преводите за widgetchatbots:write
GET/api/v1/chatbots/{id}/embedПолучаване на embed кодchatbots:read
POST/api/v1/chatbots/{id}/embed/confirmПотвърждаване на embedchatbots:write
GET/api/v1/chatbots/{id}/learning-phaseПолучаване на настройки за learning-phasechatbots:read
PATCH/api/v1/chatbots/{id}/learning-phaseАктуализиране на настройки за learning-phasechatbots:write
POST/api/v1/chatbots/{id}/learning-phase/endЗавършване на learning phasechatbots:write
GET/api/v1/chatbots/{id}/instructionsСписък с основни инструкцииchatbots:read
POST/api/v1/chatbots/{id}/instructionsДобавяне на основна инструкцияchatbots:write
PUT/api/v1/chatbots/{id}/instructions/reorderПренареждане на основни инструкцииchatbots:write
POST/api/v1/chatbots/{id}/instructions/improveПодобряване на инструкции с AIchatbots:write
GET/api/v1/instructions/{id}Получаване на основна инструкцияchatbots:read
PATCH/api/v1/instructions/{id}Актуализиране на основна инструкцияchatbots:write
DELETE/api/v1/instructions/{id}Изтриване на основна инструкцияchatbots:write
GET/api/v1/chatbot-templatesСписък с шаблони за чатботchatbots:read

Knowledge base

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/knowledgeПреглед на знаниевата базаknowledge:read
GET/api/v1/chatbots/{id}/documentsСписък с документи за чатботknowledge:read
POST/api/v1/chatbots/{id}/documentsКачване на документknowledge:write
POST/api/v1/chatbots/{id}/documents/presignПредварително подписване за качване на документknowledge:write
GET/api/v1/documents/{id}Получаване на документknowledge:read
DELETE/api/v1/documents/{id}Изтриване на документknowledge:write
POST/api/v1/documents/{id}/confirmПотвърждаване на предварително подписано качванеknowledge:write
GET/api/v1/chatbots/{id}/crawl/limitsОграничения за обхожданеknowledge:read
POST/api/v1/chatbots/{id}/crawl/previewПреглед за сканиране на уебсайтknowledge:write
GET/api/v1/chatbots/{id}/crawlСписък с обхождащи задачиknowledge:read
POST/api/v1/chatbots/{id}/crawlСтартиране на обхожданеknowledge:write
GET/api/v1/crawl-jobs/{jobId}Получаване на обхождаща задачаknowledge:read
POST/api/v1/crawl-jobs/{jobId}/cancelОтмяна на обхождаща задачаknowledge:write
GET/api/v1/chatbots/{id}/pagesСписък с обхождани странициknowledge:read
POST/api/v1/chatbots/{id}/pagesДобавяне на единичен URLknowledge:write
POST/api/v1/chatbots/{id}/pages/bulk-deleteМасово изтриване на обхождани странициknowledge:write
GET/api/v1/pages/{id}Получаване на обхождана страницаknowledge:read
DELETE/api/v1/pages/{id}Изтриване на обхождана страницаknowledge:write
POST/api/v1/pages/{id}/recrawlПовторно обхождане на страницаknowledge:write
GET/api/v1/chatbots/{id}/websitesСписък с обхождани уебсайтовеknowledge:read
DELETE/api/v1/chatbots/{id}/websites/{domain}Изтриване на уебсайтknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawlПовторно обхождане на уебсайтknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawl/cancelОтмяна на повторно обхождане на уебсайтknowledge:write

FAQs

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/faqsСписък с ЧЗВ за чатботfaqs:read
POST/api/v1/chatbots/{id}/faqsСъздаване на ЧЗВfaqs:write
POST/api/v1/chatbots/{id}/faqs/bulkМасов импорт на ЧЗВfaqs:write
POST/api/v1/chatbots/{id}/faqs/reorderПренареждане на ЧЗВfaqs:write
GET/api/v1/chatbots/{id}/faqs/embedПолучаване на embed код за FAQ widgetchatbots:read
POST/api/v1/chatbots/{id}/faqs/purge-cacheИзчистване на отдалечени кешове на ЧЗВfaqs:write
GET/api/v1/faqs/{id}Получаване на ЧЗВfaqs:read
PATCH/api/v1/faqs/{id}Актуализиране на ЧЗВfaqs:write
DELETE/api/v1/faqs/{id}Изтриване на ЧЗВfaqs:write
PUT/api/v1/faqs/{id}/translationsАктуализиране на преводи за ЧЗВfaqs:write
POST/api/v1/faqs/{id}/translateAI-превод на ЧЗВfaqs:write
GET/api/v1/chatbots/{id}/faq-suggestionsСписък с предложения за ЧЗВfaqs:read
POST/api/v1/chatbots/{id}/faq-suggestions/generateГенериране на предложения за ЧЗВ от знаниевата базаfaqs:write
GET/api/v1/faq-suggestions/{id}Получаване на предложение за ЧЗВfaqs:read
POST/api/v1/faq-suggestions/{id}/approveОдобряване на предложение за ЧЗВfaqs:write
POST/api/v1/faq-suggestions/{id}/rejectОтхвърляне на предложение за ЧЗВfaqs:write
GET/api/v1/chatbots/{id}/faq-categoriesСписък с категории ЧЗВfaqs:read
POST/api/v1/chatbots/{id}/faq-categoriesСъздаване на категория ЧЗВfaqs:write
POST/api/v1/chatbots/{id}/faq-categories/reorderПренареждане на категории ЧЗВfaqs:write
GET/api/v1/faq-categories/{id}Получаване на категория ЧЗВfaqs:read
PATCH/api/v1/faq-categories/{id}Актуализиране на категория ЧЗВfaqs:write
DELETE/api/v1/faq-categories/{id}Изтриване на категория ЧЗВfaqs:write
PUT/api/v1/faq-categories/{id}/translationsАктуализиране на преводи за категория ЧЗВfaqs:write
GET/api/v1/chatbots/{id}/faq-widget-settingsПолучаване на настройки за FAQ widgetchatbots:read
PATCH/api/v1/chatbots/{id}/faq-widget-settingsАктуализиране на настройки за FAQ widgetchatbots:write

Chats, feedback & Improvement Agent

MethodPathDescriptionScope
GET/api/v1/chatsСписък с чат сесииchats:read
GET/api/v1/chats/{sessionId}Получаване на чат сесияchats:read
PATCH/api/v1/chats/{sessionId}Задаване на категория доверие за чатchats:write
POST/api/v1/chats/{sessionId}/feedbackОценка на чат (Good / Needs Work)chats:write
POST/api/v1/chats/{sessionId}/feedback/dismissОтхвърляне на преглед на чатchats:write
POST/api/v1/chats/{sessionId}/improveСтартиране на Improvement Agent за чатchatbots:write
GET/api/v1/chatbots/{id}/feedbackСписък с ревюта на чатове за чатботchats:read
GET/api/v1/chatbots/{id}/feedback/statsСтатистически карти за преглед на чатовеchats:read
GET/api/v1/feedback/{id}Получаване на преглед на чатchats:read
PATCH/api/v1/feedback/{id}Задраскване на сериозност на прегледchats:write
POST/api/v1/feedback/{id}/improvement-sessionСтартиране на Improvement Agent за прегледchatbots:write
GET/api/v1/chatbots/{id}/confidenceПолучаване на статус на довериеanalytics:read
GET/api/v1/chatbots/{id}/confidence-categoriesСписък с категории довериеchats:read
POST/api/v1/chatbots/{id}/confidence-categoriesСъздаване на категория довериеchatbots:write
PATCH/api/v1/confidence-categories/{id}Актуализиране на категория довериеchatbots:write
DELETE/api/v1/confidence-categories/{id}Изтриване на категория довериеchatbots:write
POST/api/v1/confidence-categories/{id}/mergeСливане на категории довериеchatbots:write
GET/api/v1/chatbots/{id}/improvement-sessionsСписък с improvement сесииchatbots:read
GET/api/v1/improvement-sessions/{id}Получаване на improvement сесияchatbots:read
POST/api/v1/improvement-sessions/{id}/messagesИзпращане на съобщение до Improvement Agentchatbots:write
POST/api/v1/improvement-sessions/{id}/completeПриключване на improvement сесияchatbots:write
POST/api/v1/improvement-sessions/{id}/resetНулиране на improvement сесияchatbots:write
POST/api/v1/improvement-proposals/{id}/applyПрилагане на предложение за подобрениеchatbots:write
POST/api/v1/improvement-proposals/{id}/rejectОтхвърляне на предложение за подобрениеchatbots:write
POST/api/v1/improvement-proposals/{id}/simulationsСимулиране на предложение за подобрениеchatbots:write
POST/api/v1/improvement-simulations/{id}/assessmentОценка на резултат от симулацияchatbots:write

Leads

MethodPathDescriptionScope
GET/api/v1/leadsСписък с лийдовеleads:read
POST/api/v1/leadsСъздаване на лийдleads:write
GET/api/v1/leads/{id}Получаване на лийдleads:read
PATCH/api/v1/leads/{id}Актуализиране на лийдleads:write
DELETE/api/v1/leads/{id}Изтриване на лийдleads:write
POST/api/v1/leads/{id}/assignПрисвояване на лийдleads:write
POST/api/v1/leads/bulk-statusМасов ъпдейт на статус на лийдовеleads:write
GET/api/v1/leads/statsСтатистики за лийдовеleads:read
GET/api/v1/leads/exportЕкспорт на лийдовеleads:read
GET/api/v1/chatbots/{id}/lead-configПолучаване на конфигурация за улавяне на лийдleads:read
PUT/api/v1/chatbots/{id}/lead-configАктуализиране на конфигурация за улавяне на лийдleads:write
GET/api/v1/chatbots/{id}/lead-categoriesСписък с категории лийдleads:read
POST/api/v1/chatbots/{id}/lead-categoriesСъздаване на категория лийдleads:write
GET/api/v1/lead-categories/{id}Получаване на категория лийдleads:read
PATCH/api/v1/lead-categories/{id}Актуализиране на категория лийдleads:write
DELETE/api/v1/lead-categories/{id}Изтриване на категория лийдleads:write
PUT/api/v1/lead-categories/{id}/users/{userId}Присвояване на член към категория лийдleads:write
DELETE/api/v1/lead-categories/{id}/users/{userId}Премахване на член от категория лийдleads:write

Contact forms

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/formsСписък с контактни формуляриforms:read
POST/api/v1/chatbots/{id}/formsСъздаване на контактна формаforms:write
GET/api/v1/forms/{id}Получаване на контактна формаforms:read
PATCH/api/v1/forms/{id}Актуализиране на контактна формаforms:write
DELETE/api/v1/forms/{id}Изтриване на контактна формаforms:write
GET/api/v1/forms/{id}/submissionsСписък с подадени формуляриforms:read
GET/api/v1/forms/{id}/statsСтатистики за подадени формуляриforms:read
GET/api/v1/submissions/{id}Получаване на подадена формаforms:read
PATCH/api/v1/submissions/{id}Преглед на подадена формаforms:write
DELETE/api/v1/submissions/{id}Изтриване на подадена формаforms:write

Live chat

MethodPathDescriptionScope
GET/api/v1/live-chat/availabilityПолучаване на собствената наличност за live chatchats:read
PUT/api/v1/live-chat/availabilityЗадаване на собствената наличност за live chatchats:write
POST/api/v1/live-chat/heartbeatИзпращане на heartbeat за присъствиеchats:write
GET/api/v1/live-chat/agentsСписък с налични live chat агентиchats:read
GET/api/v1/live-chat/sessionsСписък с live chat сесииchats:read
GET/api/v1/live-chat/sessions/{sessionId}Получаване на live chat сесияchats:read
POST/api/v1/live-chat/sessions/{sessionId}/assignПоемане на live chat (присвояване на собственика на ключа)chats:write
POST/api/v1/live-chat/sessions/{sessionId}/messagesИзпращане на съобщение като агентchats:write
POST/api/v1/live-chat/sessions/{sessionId}/closeЗавършване на live chatchats:write

Analytics

MethodPathDescriptionScope
GET/api/v1/analyticsПолучаване на преглед на аналитикатаanalytics:read
GET/api/v1/analytics/activityПолучаване на серия от активност на чатовеanalytics:read
GET/api/v1/analytics/chatbotsСписък с пер-чатбот статистики за представянеanalytics:read
GET/api/v1/analytics/chatbots/{id}Получаване на аналитика за чатботanalytics:read
GET/api/v1/analytics/leadsПолучаване на фуния за лийдовеanalytics:read
GET/api/v1/analytics/formsПолучаване на статистики за подадени формуляриanalytics:read
GET/api/v1/activityПолучаване на summary на внимание (attention)analytics:read

Company & team

MethodPathDescriptionScope
GET/api/v1/companyПолучаване на компанияany key
PATCH/api/v1/companyАктуализиране на компанияcompany:write
GET/api/v1/company/settingsПолучаване на настройки на компаниятаcompany:read
PATCH/api/v1/company/settingsАктуализиране на настройки на компаниятаcompany:write
DELETE/api/v1/company/logoПремахване на лого на компаниятаcompany:write
GET/api/v1/company/membersСписък с членове на екипаcompany:read
PATCH/api/v1/company/members/{userId}Смяна на ролята на членcompany:write
DELETE/api/v1/company/members/{userId}Премахване на член от екипаcompany:write
GET/api/v1/company/invitesСписък с поканиcompany:read
POST/api/v1/company/invitesПоканване на член на екипаcompany:write
DELETE/api/v1/company/invites/{id}Отмяна на поканаcompany:write
POST/api/v1/company/invites/{id}/resendПрепращане на поканаcompany:write

Email Assistant

MethodPathDescriptionScope
GET/api/v1/email/connectionsСписък с връзки към пощенски кутииemail:read
GET/api/v1/email/connections/{id}Получаване на връзка към пощенска кутияemail:read
PATCH/api/v1/email/connections/{id}Актуализиране на връзка към пощенска кутияemail:write
DELETE/api/v1/email/connections/{id}Прекъсване на връзка към пощенска кутияemail:write
GET/api/v1/email/connections/{id}/categoriesСписък с email категорииemail:read
POST/api/v1/email/connections/{id}/categoriesСъздаване на email категорияemail:write
GET/api/v1/email/connections/{id}/foldersСписък с папки на пощатаemail:read
POST/api/v1/email/connections/{id}/foldersСъздаване на папка на пощатаemail:write
GET/api/v1/email/connections/{id}/activityСписък с лог на email активностemail:read
GET/api/v1/email/categories/{id}Получаване на email категорияemail:read
PATCH/api/v1/email/categories/{id}Актуализиране на email категорияemail:write
DELETE/api/v1/email/categories/{id}Изтриване на email категорияemail:write
GET/api/v1/email/contactsСписък с email контактиemail:read
GET/api/v1/email/contacts/{id}Получаване на email контактemail:read
PATCH/api/v1/email/contacts/{id}Актуализиране на email контактemail:write
DELETE/api/v1/email/contacts/{id}Изтриване на email контактemail:write

Account & notifications

MethodPathDescriptionScope
GET/api/v1/meПолучаване на контекста на ключа (whoami)any key
GET/api/v1/account/usageПолучаване на план и използванеany key
GET/api/v1/notificationsСписък с известияany key
DELETE/api/v1/notificationsИзтриване на стари прочетени известияany key
GET/api/v1/notifications/unread-countПолучаване на брой непрочетени известияany key
POST/api/v1/notifications/mark-all-readМаркиране на всички известия като прочетениany key
GET/api/v1/notifications/{id}Получаване на известиеany key
PATCH/api/v1/notifications/{id}Маркиране на известие като прочетеноany key

Blog (platform)

MethodPathDescriptionScope
GET/api/v1/blogСписък с блог постовеany key
POST/api/v1/blogСъздаване на блог постany key
POST/api/v1/blog/assetsКачване на блог активany key
GET/api/v1/blog/{id}Получаване на блог постany key
PATCH/api/v1/blog/{id}Актуализиране на блог постany key
DELETE/api/v1/blog/{id}Изтриване на блог постany key
POST/api/v1/blog/{id}/translationsСлагане в опашка на преводи за блогany key

Имана нужда от помощ? Свържете се с нашия екип за поддръжка →