VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/WhatsApp: assistente de IA

Persona do assistente

Lê e grava o tom, os traços, as instruções e o contexto da loja usados pelo assistente.

Ler a persona

Devolve a persona atual. Uma loja que nunca gravou recebe os padrões: estilo P, sem traços e textos vazios.

GET/api/v1/admin/whatsapp-confluence/ai/personaAdmin

Lê a persona do assistente

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/whatsapp-confluence/ai/persona" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Persona
json
{
  "style": "A",
  "traits": {
    "emoji": "less",
    "tamanho": "less",
    "formato": "conversa"
  },
  "custom_instructions": "Nunca prometa entrega no mesmo dia.",
  "store_context": "Loja de roupas femininas em São Paulo. Atendemos de segunda a sexta, das 9h às 18h.",
  "updated_at": "2026-10-01T14:20:00Z"
}

Campos da resposta

stylestring
DPARVE
Estilo base.
traitsobject
Mapa de traço para more, default ou less; o traço formato usa enxuto, conversa ou resumo.
custom_instructionsstring
Regras da loja em texto livre.
store_contextstring
O que o assistente deve saber da loja.
updated_atstring
Última gravação (RFC 3339). Em uma loja que nunca gravou vem 0001-01-01T00:00:00Z.

Erros

StatusQuandoCorpo de exemplo
500Falha ao ler.{"error":"..."}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O usuário não tem papel de administrador.{"error":"insufficient permissions"}

Gravar a persona

Substitui a persona. O efeito vale já na próxima mensagem do cliente. Exige manage_settings.

PUT/api/v1/admin/whatsapp-confluence/ai/personaAdmin

Grava a persona do assistente

Corpo da requisição

stylestringpadrão: P
DPARVE
Estilo base. Vazio vale P. A API não confere o código: um valor desconhecido é gravado e o assistente usa o tom padrão.
traitsobject
Mapa de traço para more, default ou less.
custom_instructionsstring
Regras da loja. Vazio apaga.
store_contextstring
Contexto da loja. Vazio apaga.

Exemplo de requisição

bash
curl -X PUT "$BASE_URL/api/v1/admin/whatsapp-confluence/ai/persona" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"style": "A", "traits": {"emoji": "less", "tamanho": "less", "formato": "conversa"}, "custom_instructions": "Nunca prometa entrega no mesmo dia.", "store_context": "Loja de roupas femininas em São Paulo. Atendemos de segunda a sexta, das 9h às 18h."}'

Resposta

200Persona gravada
json
{
  "status": "ok"
}

Campos da resposta

statusstring
Sempre ok.

Erros

StatusQuandoCorpo de exemplo
400JSON inválido.{"error":"invalid body"}
500Falha ao gravar.{"error":"..."}
401Sem token, token inválido ou expirado.{"error":"missing authorization header"}
403O usuário não tem papel de administrador.{"error":"insufficient permissions"}
403O administrador não tem o privilégio manage_settings.{"error":"insufficient privileges","required":"manage_settings"}
Substitui por inteiro

Leia a persona, altere só o que precisa e devolva o objeto completo. Um PUT com apenas style apaga as instruções e o contexto.

Teste antes de soltar

Use o playground para ver o efeito da nova persona sem falar com um cliente.

Veja também

  • Base de conhecimento
  • Playground
Anterior
WhatsApp: assistente de IA
Próxima
Base de conhecimento
Nesta página
  • Ler a persona
  • Exemplo de requisição
  • Resposta
  • Erros
  • Gravar a persona
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também