ChatReact
InícioDocumentação

REST API

A REST API v1 do ChatReact oferece acesso programático às operações suportadas no painel: chatbots, base de conhecimento e rastreamento, preços estruturados, FAQs, revisão de chats e o Improvement Agent, leads, formulários de contato, chat ao vivo, empresa e equipe, o Email Assistant, análises e notificações. Ações vinculadas ao navegador (pagamentos, autorização de caixa de correio, passkeys, exclusão de conta e gerenciamento de chaves de API) permanecem no painel.

Prefere conversar com um assistente de IA? As mesmas capacidades estão disponíveis como ferramentas MCP — veja MCP Server Integration. O API Explorer interativo com esquemas de requisição e resposta fica em /api-reference, onde você também pode baixar a especificação OpenAPI 3.0.

Autenticação

  1. Vá para Painel → Empresa → aba API e clique em Criar Chave de API
  2. Escolha um nome e os escopos de permissão que a chave precisa (veja abaixo)
  3. Copie a chave — ela começa com cr_ e é exibida apenas uma vez

Envie a chave com toda requisição:

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

Um cabeçalho X-API-Key: cr_your_api_key também é aceito. As chaves de API pertencem a uma empresa e executam com as permissões do proprietário da empresa; limites do plano e gates de recurso aplicam-se exatamente como no painel.

O acesso à API está disponível em planos pagos — veja a página de Pricing. As chaves podem ser revogadas a qualquer momento pelo painel.

Escopos

Cada chave carrega um ou mais escopos. Um endpoint retorna 403 quando a chave não tem o escopo requerido.

ScopeGrants
chatbots:read / chatbots:writeConfiguração do chatbot: persona, idiomas, widget, comportamento, restrições, instruções centrais, código de incorporação, fase de aprendizado, templates de chatbot, configurações do widget de FAQ
knowledge:read / knowledge:writeBase de conhecimento: documentos, rastreamento de sites, páginas rastreadas
faqs:read / faqs:writeFAQs, categorias de FAQ, sugestões, traduções
chats:read / chats:writeHistórico de chat, avaliações de chat, categorias de confiança, chat ao vivo (ações de agente precisam de chats:write)
leads:read / leads:writeLeads, categorias de lead, configurações de captura de lead, exportação
forms:read / forms:writeFormulários de contato e submissões
analytics:readEstatísticas, séries de atividade, funis, status de confiança
company:read / company:writePerfil e configurações da empresa, membros da equipe, convites
email:read / email:writeConexões do Email Assistant, categorias, contatos, atividade
prices:readLer entradas de preço estruturado, revisões, elegibilidade e sugestões
prices:writeCriar e editar rascunhos de preço, importar CSV e aplicar uma sugestão como rascunho; requer o proprietário da empresa
prices:approveAprovar versões exatas ou arquivar entradas; requer o proprietário da empresa
blog:read / blog:writeConteúdo do blog da plataforma (interno ao ChatReact)
any valid key/v1/me, uso da conta, suas notificações

Convenções

  • Base URL: https://www.chatreact.ai/api/v1, JSON na entrada e saída (Content-Type: application/json).
  • Respostas: { "success": true, "data": … }; listas acrescentam "pagination": { "total", "page", "pageSize", "totalPages" }. Use page e pageSize (máx. 100) em endpoints de listagem; alguns endpoints oferecem paginação por cursor (cursor / nextCursor).
  • Erros: { "success": false, "error": "message", "code": "BAD_REQUEST" } com details opcional para erros de validação. Códigos de status: 400 entrada inválida, 401 chave ausente ou inválida, 403 escopo ausente, recurso de plano não incluído ou função insuficiente, 404 recurso não encontrado (também para recursos de outras empresas), 409 conflito, 429 limite de taxa excedido.
  • Atualizações parciais: endpoints PATCH alteram apenas os campos que você enviar; campos desconhecidos são rejeitados.
  • Limite de taxa: 30 requisições por minuto por endereço IP.
  • Operações de longa duração (rastreamentos, geração de IA, traduções) retornam rapidamente com um job ou resultado que você pode consultar; elas consomem o token e o orçamento de rastreamento do seu plano.

Endpoints

Prices & services

Salvar, editar, importar e aplicar uma sugestão cria rascunhos sem aprovação. Operações de aprovação e arquivamento revisam versões exatas; uma versão desatualizada retorna conflito. Chaves existentes não recebem automaticamente permissões de preço. Somente o proprietário da empresa pode conceder permissões de escrita ou aprovação. Para o fluxo do cliente, veja Prices & services.

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/pricesListar entradas de preço e elegibilidadeprices:read
POST/api/v1/chatbots/{id}/pricesCriar um rascunhoprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}Ler detalhes e histórico paginadoprices:read
PATCH/api/v1/chatbots/{id}/prices/{itemId}Criar um rascunho editado a partir de uma versão esperadaprices:write
GET/api/v1/chatbots/{id}/prices/{itemId}/stateLer estado completo do itemprices:read
POST/api/v1/chatbots/{id}/prices/{itemId}/approveAprovar uma versão exataprices:approve
POST/api/v1/chatbots/{id}/prices/{itemId}/archiveArquivar uma versão exataprices:approve
POST/api/v1/chatbots/{id}/prices/approve-manyAprovar uma seleção explícita de versão de forma atômicaprices:approve
POST/api/v1/chatbots/{id}/prices/importImportar rascunhos CSV com um ID de importação estávelprices:write
GET/api/v1/chatbots/{id}/prices/suggestionsListar sugestões de preçoprices:read
POST/api/v1/chatbots/{id}/prices/suggestions/{suggestionId}/applyAplicar uma sugestão selecionada como rascunhoprices:write

Chatbots

MethodPathDescriptionScope
GET/api/v1/chatbotsListar chatbotschatbots:read
POST/api/v1/chatbotsCriar chatbotchatbots:write
GET/api/v1/chatbots/{id}Obter chatbotchatbots:read
PATCH/api/v1/chatbots/{id}Atualizar chatbotchatbots:write
DELETE/api/v1/chatbots/{id}Excluir chatbotchatbots:write
GET/api/v1/chatbots/{id}/personalityObter personalidade do chatbotchatbots:read
PATCH/api/v1/chatbots/{id}/personalityAtualizar personalidade do chatbotchatbots:write
GET/api/v1/chatbots/{id}/widgetObter configurações do widgetchatbots:read
PATCH/api/v1/chatbots/{id}/widgetAtualizar configurações do widgetchatbots:write
GET/api/v1/chatbots/{id}/widget/translationsObter traduções do widgetchatbots:read
PUT/api/v1/chatbots/{id}/widget/translationsSubstituir traduções do widgetchatbots:write
GET/api/v1/chatbots/{id}/embedObter código de incorporaçãochatbots:read
POST/api/v1/chatbots/{id}/embed/confirmConfirmar incorporaçãochatbots:write
GET/api/v1/chatbots/{id}/learning-phaseObter configurações da fase de aprendizadochatbots:read
PATCH/api/v1/chatbots/{id}/learning-phaseAtualizar configurações da fase de aprendizadochatbots:write
POST/api/v1/chatbots/{id}/learning-phase/endEncerrar fase de aprendizadochatbots:write
GET/api/v1/chatbots/{id}/instructionsListar instruções centraischatbots:read
POST/api/v1/chatbots/{id}/instructionsAdicionar instrução centralchatbots:write
PUT/api/v1/chatbots/{id}/instructions/reorderReordenar instruções centraischatbots:write
POST/api/v1/chatbots/{id}/instructions/improveMelhorar instruções com IAchatbots:write
GET/api/v1/instructions/{id}Obter instrução centralchatbots:read
PATCH/api/v1/instructions/{id}Atualizar instrução centralchatbots:write
DELETE/api/v1/instructions/{id}Excluir instrução centralchatbots:write
GET/api/v1/chatbot-templatesListar templates de chatbotchatbots:read

Knowledge base

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/knowledgeVisão geral da base de conhecimentoknowledge:read
GET/api/v1/chatbots/{id}/documentsListar documentos para chatbotknowledge:read
POST/api/v1/chatbots/{id}/documentsFazer upload de documentoknowledge:write
POST/api/v1/chatbots/{id}/documents/presignPresign de upload de documentoknowledge:write
GET/api/v1/documents/{id}Obter documentoknowledge:read
DELETE/api/v1/documents/{id}Excluir documentoknowledge:write
POST/api/v1/documents/{id}/confirmConfirmar upload presignadoknowledge:write
GET/api/v1/chatbots/{id}/crawl/limitsLimites de rastreamentoknowledge:read
POST/api/v1/chatbots/{id}/crawl/previewPré-visualizar site de scanknowledge:write
GET/api/v1/chatbots/{id}/crawlListar jobs de rastreamentoknowledge:read
POST/api/v1/chatbots/{id}/crawlIniciar rastreamentoknowledge:write
GET/api/v1/crawl-jobs/{jobId}Obter job de rastreamentoknowledge:read
POST/api/v1/crawl-jobs/{jobId}/cancelCancelar job de rastreamentoknowledge:write
GET/api/v1/chatbots/{id}/pagesListar páginas rastreadasknowledge:read
POST/api/v1/chatbots/{id}/pagesAdicionar URL únicoknowledge:write
POST/api/v1/chatbots/{id}/pages/bulk-deleteExclusão em massa de páginas rastreadasknowledge:write
GET/api/v1/pages/{id}Obter página rastreadaknowledge:read
DELETE/api/v1/pages/{id}Excluir página rastreadaknowledge:write
POST/api/v1/pages/{id}/recrawlRe-crawlar páginaknowledge:write
GET/api/v1/chatbots/{id}/websitesListar sites rastreadosknowledge:read
DELETE/api/v1/chatbots/{id}/websites/{domain}Excluir siteknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawlRe-crawlar siteknowledge:write
POST/api/v1/chatbots/{id}/websites/{domain}/recrawl/cancelCancelar re-crawl de siteknowledge:write

FAQs

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/faqsListar FAQs para chatbotfaqs:read
POST/api/v1/chatbots/{id}/faqsCriar FAQfaqs:write
POST/api/v1/chatbots/{id}/faqs/bulkImportação em massa de FAQsfaqs:write
POST/api/v1/chatbots/{id}/faqs/reorderReordenar FAQsfaqs:write
GET/api/v1/chatbots/{id}/faqs/embedObter código de incorporação do widget de FAQchatbots:read
POST/api/v1/chatbots/{id}/faqs/purge-cacheLimpar caches remotos de FAQfaqs:write
GET/api/v1/faqs/{id}Obter FAQfaqs:read
PATCH/api/v1/faqs/{id}Atualizar FAQfaqs:write
DELETE/api/v1/faqs/{id}Excluir FAQfaqs:write
PUT/api/v1/faqs/{id}/translationsAtualizar traduções de FAQfaqs:write
POST/api/v1/faqs/{id}/translateTraduzir FAQ com IAfaqs:write
GET/api/v1/chatbots/{id}/faq-suggestionsListar sugestões de FAQfaqs:read
POST/api/v1/chatbots/{id}/faq-suggestions/generateGerar sugestões de FAQ a partir da base de conhecimentofaqs:write
GET/api/v1/faq-suggestions/{id}Obter sugestão de FAQfaqs:read
POST/api/v1/faq-suggestions/{id}/approveAprovar sugestão de FAQfaqs:write
POST/api/v1/faq-suggestions/{id}/rejectRejeitar sugestão de FAQfaqs:write
GET/api/v1/chatbots/{id}/faq-categoriesListar categorias de FAQfaqs:read
POST/api/v1/chatbots/{id}/faq-categoriesCriar categoria de FAQfaqs:write
POST/api/v1/chatbots/{id}/faq-categories/reorderReordenar categorias de FAQfaqs:write
GET/api/v1/faq-categories/{id}Obter categoria de FAQfaqs:read
PATCH/api/v1/faq-categories/{id}Atualizar categoria de FAQfaqs:write
DELETE/api/v1/faq-categories/{id}Excluir categoria de FAQfaqs:write
PUT/api/v1/faq-categories/{id}/translationsAtualizar traduções da categoria de FAQfaqs:write
GET/api/v1/chatbots/{id}/faq-widget-settingsObter configurações do widget de FAQchatbots:read
PATCH/api/v1/chatbots/{id}/faq-widget-settingsAtualizar configurações do widget de FAQchatbots:write

Chats, feedback & Improvement Agent

MethodPathDescriptionScope
GET/api/v1/chatsListar sessões de chatchats:read
GET/api/v1/chats/{sessionId}Obter sessão de chatchats:read
PATCH/api/v1/chats/{sessionId}Definir categoria de confiança do chatchats:write
POST/api/v1/chats/{sessionId}/feedbackAvaliar chat (Good / Needs Work)chats:write
POST/api/v1/chats/{sessionId}/feedback/dismissDescartar revisão de chatchats:write
POST/api/v1/chats/{sessionId}/improveIniciar Improvement Agent para chatchatbots:write
GET/api/v1/chatbots/{id}/feedbackListar revisões de chat de um chatbotchats:read
GET/api/v1/chatbots/{id}/feedback/statsCartões de estatísticas de revisão de chatchats:read
GET/api/v1/feedback/{id}Obter revisão de chatchats:read
PATCH/api/v1/feedback/{id}Sobrescrever severidade da revisãochats:write
POST/api/v1/feedback/{id}/improvement-sessionIniciar Improvement Agent para revisãochatbots:write
GET/api/v1/chatbots/{id}/confidenceObter status de confiançaanalytics:read
GET/api/v1/chatbots/{id}/confidence-categoriesListar categorias de confiançachats:read
POST/api/v1/chatbots/{id}/confidence-categoriesCriar categoria de confiançachatbots:write
PATCH/api/v1/confidence-categories/{id}Atualizar categoria de confiançachatbots:write
DELETE/api/v1/confidence-categories/{id}Excluir categoria de confiançachatbots:write
POST/api/v1/confidence-categories/{id}/mergeMesclar categorias de confiançachatbots:write
GET/api/v1/chatbots/{id}/improvement-sessionsListar sessões de melhoriachatbots:read
GET/api/v1/improvement-sessions/{id}Obter sessão de melhoriachatbots:read
POST/api/v1/improvement-sessions/{id}/messagesEnviar mensagem ao Improvement Agentchatbots:write
POST/api/v1/improvement-sessions/{id}/completeCompletar sessão de melhoriachatbots:write
POST/api/v1/improvement-sessions/{id}/resetResetar sessão de melhoriachatbots:write
POST/api/v1/improvement-proposals/{id}/applyAplicar proposta de melhoriachatbots:write
POST/api/v1/improvement-proposals/{id}/rejectRejeitar proposta de melhoriachatbots:write
POST/api/v1/improvement-proposals/{id}/simulationsSimular proposta de melhoriachatbots:write
POST/api/v1/improvement-simulations/{id}/assessmentAvaliar resultado da simulaçãochatbots:write

Leads

MethodPathDescriptionScope
GET/api/v1/leadsListar leadsleads:read
POST/api/v1/leadsCriar leadleads:write
GET/api/v1/leads/{id}Obter leadleads:read
PATCH/api/v1/leads/{id}Atualizar leadleads:write
DELETE/api/v1/leads/{id}Excluir leadleads:write
POST/api/v1/leads/{id}/assignAtribuir leadleads:write
POST/api/v1/leads/bulk-statusAtualização em massa do status de leadsleads:write
GET/api/v1/leads/statsEstatísticas de leadsleads:read
GET/api/v1/leads/exportExportar leadsleads:read
GET/api/v1/chatbots/{id}/lead-configObter configuração de captura de leadleads:read
PUT/api/v1/chatbots/{id}/lead-configAtualizar configuração de captura de leadleads:write
GET/api/v1/chatbots/{id}/lead-categoriesListar categorias de leadleads:read
POST/api/v1/chatbots/{id}/lead-categoriesCriar categoria de leadleads:write
GET/api/v1/lead-categories/{id}Obter categoria de leadleads:read
PATCH/api/v1/lead-categories/{id}Atualizar categoria de leadleads:write
DELETE/api/v1/lead-categories/{id}Excluir categoria de leadleads:write
PUT/api/v1/lead-categories/{id}/users/{userId}Atribuir membro a categoria de leadleads:write
DELETE/api/v1/lead-categories/{id}/users/{userId}Remover membro de categoria de leadleads:write

Contact forms

MethodPathDescriptionScope
GET/api/v1/chatbots/{id}/formsListar formulários de contatoforms:read
POST/api/v1/chatbots/{id}/formsCriar formulário de contatoforms:write
GET/api/v1/forms/{id}Obter formulário de contatoforms:read
PATCH/api/v1/forms/{id}Atualizar formulário de contatoforms:write
DELETE/api/v1/forms/{id}Excluir formulário de contatoforms:write
GET/api/v1/forms/{id}/submissionsListar submissões de formulárioforms:read
GET/api/v1/forms/{id}/statsEstatísticas de submissão de formulárioforms:read
GET/api/v1/submissions/{id}Obter submissão de formulárioforms:read
PATCH/api/v1/submissions/{id}Revisar submissão de formulárioforms:write
DELETE/api/v1/submissions/{id}Excluir submissão de formulárioforms:write

Live chat

MethodPathDescriptionScope
GET/api/v1/live-chat/availabilityObter disponibilidade própria de live chatchats:read
PUT/api/v1/live-chat/availabilityDefinir disponibilidade própria de live chatchats:write
POST/api/v1/live-chat/heartbeatEnviar heartbeat de presençachats:write
GET/api/v1/live-chat/agentsListar agentes de live chat disponíveischats:read
GET/api/v1/live-chat/sessionsListar sessões de live chatchats:read
GET/api/v1/live-chat/sessions/{sessionId}Obter sessão de live chatchats:read
POST/api/v1/live-chat/sessions/{sessionId}/assignAssumir live chat (atribuir ao proprietário da chave)chats:write
POST/api/v1/live-chat/sessions/{sessionId}/messagesEnviar mensagem como agentechats:write
POST/api/v1/live-chat/sessions/{sessionId}/closeEncerrar live chatchats:write

Analytics

MethodPathDescriptionScope
GET/api/v1/analyticsObter visão geral de analyticsanalytics:read
GET/api/v1/analytics/activityObter série de atividade de chatanalytics:read
GET/api/v1/analytics/chatbotsListar estatísticas de desempenho por chatbotanalytics:read
GET/api/v1/analytics/chatbots/{id}Obter analytics do chatbotanalytics:read
GET/api/v1/analytics/leadsObter funil de leadsanalytics:read
GET/api/v1/analytics/formsObter estatísticas de submissão de formulárioanalytics:read
GET/api/v1/activityObter resumo de atençãoanalytics:read

Company & team

MethodPathDescriptionScope
GET/api/v1/companyObter empresaany key
PATCH/api/v1/companyAtualizar empresacompany:write
GET/api/v1/company/settingsObter configurações da empresacompany:read
PATCH/api/v1/company/settingsAtualizar configurações da empresacompany:write
DELETE/api/v1/company/logoRemover logo da empresacompany:write
GET/api/v1/company/membersListar membros da equipecompany:read
PATCH/api/v1/company/members/{userId}Alterar função de membrocompany:write
DELETE/api/v1/company/members/{userId}Remover membro da equipecompany:write
GET/api/v1/company/invitesListar convitescompany:read
POST/api/v1/company/invitesConvidar membro da equipecompany:write
DELETE/api/v1/company/invites/{id}Cancelar convitecompany:write
POST/api/v1/company/invites/{id}/resendReenviar convitecompany:write

Email Assistant

MethodPathDescriptionScope
GET/api/v1/email/connectionsListar conexões de mailboxemail:read
GET/api/v1/email/connections/{id}Obter conexão de mailboxemail:read
PATCH/api/v1/email/connections/{id}Atualizar conexão de mailboxemail:write
DELETE/api/v1/email/connections/{id}Desconectar mailboxemail:write
GET/api/v1/email/connections/{id}/categoriesListar categorias de emailemail:read
POST/api/v1/email/connections/{id}/categoriesCriar categoria de emailemail:write
GET/api/v1/email/connections/{id}/foldersListar pastas de correioemail:read
POST/api/v1/email/connections/{id}/foldersCriar pasta de correioemail:write
GET/api/v1/email/connections/{id}/activityListar log de atividade de emailemail:read
GET/api/v1/email/categories/{id}Obter categoria de emailemail:read
PATCH/api/v1/email/categories/{id}Atualizar categoria de emailemail:write
DELETE/api/v1/email/categories/{id}Excluir categoria de emailemail:write
GET/api/v1/email/contactsListar contatos de emailemail:read
GET/api/v1/email/contacts/{id}Obter contato de emailemail:read
PATCH/api/v1/email/contacts/{id}Atualizar contato de emailemail:write
DELETE/api/v1/email/contacts/{id}Excluir contato de emailemail:write

Account & notifications

MethodPathDescriptionScope
GET/api/v1/meObter contexto da chave (whoami)any key
GET/api/v1/account/usageObter plano e usoany key
GET/api/v1/notificationsListar notificaçõesany key
DELETE/api/v1/notificationsExcluir notificações lidas antigasany key
GET/api/v1/notifications/unread-countObter contagem de notificações não lidasany key
POST/api/v1/notifications/mark-all-readMarcar todas as notificações como lidasany key
GET/api/v1/notifications/{id}Obter notificaçãoany key
PATCH/api/v1/notifications/{id}Marcar notificação como lidaany key

Blog (platform)

MethodPathDescriptionScope
GET/api/v1/blogListar posts do blogany key
POST/api/v1/blogCriar post do blogany key
POST/api/v1/blog/assetsFazer upload de asset do blogany key
GET/api/v1/blog/{id}Obter post do blogany key
PATCH/api/v1/blog/{id}Atualizar post do blogany key
DELETE/api/v1/blog/{id}Excluir post do blogany key
POST/api/v1/blog/{id}/translationsEnfileirar traduções do blogany key

Precisa de ajuda? Contact our support team →

Anterior
Integração com Shopify
Seguinte
Integração do Servidor MCP