API atual/Referência completa/Venddor Intelligence: automações e canais

Configurações da VI

Lê e substitui o documento de configuração da Venddor Intelligence na loja: interruptores de recursos e parâmetros.

As configurações são um único documento JSON por loja. A maior parte são interruptores booleanos que ligam ou desligam um recurso. Uma loja que nunca gravou nada tem o documento praticamente vazio, e cada interruptor enable_* ausente vale ligado.

Interruptores

Chave	Sem valor gravado	Controla
`enable_chat_widget`	ligada	A conversa da VI no painel.
`enable_storefront_vi`	ligada	A assistente para o cliente na loja.
`enable_chat_voice_mode`	ligada	Voz no chat (Voz).
`enable_page_context_awareness`	ligada	A VI enxerga a tela aberta.
`enable_conversational_analytics`	ligada	Perguntas de análise sobre os números da loja.
`enable_conversational_order_creation`	ligada	Montar pedidos pela conversa (Pedido na conversa).
`enable_vector_customer_search`	ligada	Busca de clientes por sentido (Busca).
`enable_ai_banner_generation`	ligada	Gerar banners (Banners).
`enable_ai_promotion_creation`	ligada	Gerar promoções a partir de um pedido (Promoções).
`enable_ai_bulk_product_import`	ligada	Importar produtos de planilha (Importação).
`enable_docx_export`	ligada	Exportar conversa em DOCX (Anexos).
`enable_proactive_insights`	ligada	Insights proativos (Insights).
`enable_proactive_news_rag`	ligada	Insights podem citar notícias.
`enable_venddor_pulse`	ligada	Briefing diário (Briefing).
`enable_venddor_pulse_news_rag`	ligada	Briefing com notícias do segmento.
`enable_venddor_pulse_price_rag`	ligada	Briefing com comparação de preços da concorrência.
`proactive_nudges_enabled`	desligada	Alertas por tela (Alertas).

Além dos interruptores, o documento guarda parâmetros numéricos e de texto: proactive_max_topics_per_day (insights por dia, padrão 5), venddor_pulse_cron_hour_local (hora do briefing em São Paulo, 0 a 23, padrão 4), venddor_pulse_display_title (rótulo do cartão, até 80 caracteres), realtime_max_session_seconds (teto de uma conversa por voz em tempo real) e assistant_brand_name (nome que a assistente usa para se apresentar). As chaves sac_* e agent_commerce_enabled são mantidas pelas rotas de SAC e de loja pronta para agentes. O documento pode ainda conter credenciais e parâmetros de custo dos provedores de IA, definidos pela equipe da Venddor ou no painel: não os documentamos aqui.

Ler configurações

Devolve o documento gravado da loja, mais o campo calculado realtime_voice_enabled. Chaves que nunca foram gravadas não aparecem (e valem o padrão da tabela).

GET/api/v1/admin/intelligence/settingsAdmin

Ler configurações

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um administrador (veja Tokens).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/intelligence/settings" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Configurações

json

{
  "enable_chat_voice_mode": true,
  "enable_docx_export": false,
  "proactive_max_topics_per_day": 5,
  "realtime_voice_enabled": true
}

200Loja sem nada gravado

json

{ "realtime_voice_enabled": true }

Campos da resposta

realtime_voice_enabledboolean

Calculado: se a conversa por voz em tempo real está liberada para a loja pela Venddor. Somente leitura.

(demais chaves)any

As chaves gravadas, com o tipo em que foram gravadas.

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` ou `{"error":"invalid or expired token"}`
403	O administrador não tem nenhum dos privilégios exigidos.	`{"error":"insufficient privileges","privilege_required_any":["intelligence_use_chat","manage_settings"]}`

Substituir configurações

Substitui o documento inteiro pelo objeto enviado. Chaves que você não incluir são apagadas, voltando ao padrão, e isso inclui as chaves sac_*, agent_commerce_enabled e credenciais. O campo realtime_voice_enabled é ignorado. Não há validação de nomes: uma chave com erro de digitação é gravada e não faz nada.

PUT/api/v1/admin/intelligence/settingsAdmin

Substituir configurações

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um administrador (veja Tokens).

Content-Typestringobrigatório

application/json.

Corpo da requisição

(qualquer chave)any

Pares chave/valor do documento completo. Booleanos aceitam também as strings true, 1, yes, on e false, 0, no, off.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/admin/intelligence/settings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enable_chat_voice_mode": true,
    "enable_docx_export": false,
    "proactive_max_topics_per_day": 5
  }'

Resposta

200Gravado

json

{ "status": "ok" }

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` ou `{"error":"invalid or expired token"}`
403	O administrador não tem nenhum dos privilégios exigidos.	`{"error":"insufficient privileges","privilege_required_any":["intelligence_use_chat","manage_settings"]}`
400	Corpo que não é um objeto JSON.	`{"error":"invalid request body"}`

Veja também

API atual/Referência completa/Venddor Intelligence: automações e canais

Configurações da VI

Lê e substitui o documento de configuração da Venddor Intelligence na loja: interruptores de recursos e parâmetros.

Interruptores

Chave	Sem valor gravado	Controla
`enable_chat_widget`	ligada	A conversa da VI no painel.
`enable_storefront_vi`	ligada	A assistente para o cliente na loja.
`enable_chat_voice_mode`	ligada	Voz no chat (Voz).
`enable_page_context_awareness`	ligada	A VI enxerga a tela aberta.
`enable_conversational_analytics`	ligada	Perguntas de análise sobre os números da loja.
`enable_conversational_order_creation`	ligada	Montar pedidos pela conversa (Pedido na conversa).
`enable_vector_customer_search`	ligada	Busca de clientes por sentido (Busca).
`enable_ai_banner_generation`	ligada	Gerar banners (Banners).
`enable_ai_promotion_creation`	ligada	Gerar promoções a partir de um pedido (Promoções).
`enable_ai_bulk_product_import`	ligada	Importar produtos de planilha (Importação).
`enable_docx_export`	ligada	Exportar conversa em DOCX (Anexos).
`enable_proactive_insights`	ligada	Insights proativos (Insights).
`enable_proactive_news_rag`	ligada	Insights podem citar notícias.
`enable_venddor_pulse`	ligada	Briefing diário (Briefing).
`enable_venddor_pulse_news_rag`	ligada	Briefing com notícias do segmento.
`enable_venddor_pulse_price_rag`	ligada	Briefing com comparação de preços da concorrência.
`proactive_nudges_enabled`	desligada	Alertas por tela (Alertas).

Ler configurações

Devolve o documento gravado da loja, mais o campo calculado realtime_voice_enabled. Chaves que nunca foram gravadas não aparecem (e valem o padrão da tabela).

GET/api/v1/admin/intelligence/settingsAdmin

Ler configurações

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um administrador (veja Tokens).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/intelligence/settings" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Configurações

json

{
  "enable_chat_voice_mode": true,
  "enable_docx_export": false,
  "proactive_max_topics_per_day": 5,
  "realtime_voice_enabled": true
}

200Loja sem nada gravado

json

{ "realtime_voice_enabled": true }

Campos da resposta

realtime_voice_enabledboolean

Calculado: se a conversa por voz em tempo real está liberada para a loja pela Venddor. Somente leitura.

(demais chaves)any

As chaves gravadas, com o tipo em que foram gravadas.

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` ou `{"error":"invalid or expired token"}`
403	O administrador não tem nenhum dos privilégios exigidos.	`{"error":"insufficient privileges","privilege_required_any":["intelligence_use_chat","manage_settings"]}`

Substituir configurações

PUT/api/v1/admin/intelligence/settingsAdmin

Substituir configurações

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um administrador (veja Tokens).

Content-Typestringobrigatório

application/json.

Corpo da requisição

(qualquer chave)any

Pares chave/valor do documento completo. Booleanos aceitam também as strings true, 1, yes, on e false, 0, no, off.

Exemplo de requisição

bash

curl -X PUT "$BASE_URL/api/v1/admin/intelligence/settings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "enable_chat_voice_mode": true,
    "enable_docx_export": false,
    "proactive_max_topics_per_day": 5
  }'

Resposta

200Gravado

json

{ "status": "ok" }

Erros

Status	Quando	Corpo
401	Sem token ou token inválido/expirado.	`{"error":"missing authorization header"}` ou `{"error":"invalid or expired token"}`
403	O administrador não tem nenhum dos privilégios exigidos.	`{"error":"insufficient privileges","privilege_required_any":["intelligence_use_chat","manage_settings"]}`
400	Corpo que não é um objeto JSON.	`{"error":"invalid request body"}`