Chatbot Settings
Seção intitulada “Chatbot Settings”Recupere e atualize a configuração completa do seu Agente de IA, incluindo personalidade, estilo de conversa e system prompt.
As configurações de comportamento ficam em Identidade > Persona de IA no painel. Os textos voltados aos visitantes ficam em Canais > Seu site > Conteúdo de texto. A tabela abaixo indica a localização exata de cada configuração.
Get Chatbot Settings
Seção intitulada “Get Chatbot Settings”GET https://app.quickchat.ai/v1/api/chatbot_settings
curl https://app.quickchat.ai/v1/api/chatbot_settings \ -H 'Authorization: Bearer <API_TOKEN>'import requests
response = requests.get( url="https://app.quickchat.ai/v1/api/chatbot_settings", headers={"Authorization": "Bearer <API_TOKEN>"},)data = response.json()Response 200 OK
{ "personality": 0, "profession": "helpful_assistant", "creativity_level": 1, "greeting": "<p>Hello! How can I help you today?</p>", "greeting2": "", "header": "Support Assistant", "header2": "", "language_chosen": "en", "reply_length": 1, "one_word_description": "Support Agent", "short_description": "A helpful customer support assistant.", "ai_commands": ["Be polite", "Stay on topic"]}| Field | Description |
|---|---|
one_word_description string | Nome do Agente de IA. Painel: Identidade > Persona de IA > Nome. A API aceita até 200 caracteres; o campo no app limita a 40. |
short_description string | O Prompt principal (system prompt). Painel: Identidade > Persona de IA > Prompt principal. A API aceita até 25.000 caracteres em todos os planos; o editor in-app limita ao teto do seu plano, que começa em 15.000. |
ai_commands array of strings | Diretrizes de comportamento para a IA, uma diretriz por item do array. Painel: Identidade > Persona de IA > Diretrizes. Até 250 itens, 5.000 caracteres por item e 10.000 caracteres no total entre todos os itens. |
personality integer (0–13) | Preset de personalidade da IA. Painel: Identidade > Persona de IA > Personalidade. Veja a tabela abaixo |
profession string | Profissão/papel da IA. Painel: Identidade > Persona de IA > Profissão (máx. 200 caracteres). Veja a tabela abaixo |
creativity_level integer (0–2) | Painel: Identidade > Persona de IA > Criatividade. 0 = Baixo, 1 = Normal, 2 = Alto |
reply_length integer (0–2) | Painel: Identidade > Persona de IA > Comprimento da Resposta. 0 = Curto, 1 = Normal, 2 = Mais longo |
greeting string | Mensagem de saudação principal (HTML). Painel: Canais > Seu site > Conteúdo de texto > Mensagem de boas-vindas (máx. 1000 caracteres). É o mesmo campo que welcome_message em Widget Configuration. |
greeting2 string | Mensagem de saudação secundária (HTML). Disponível pela API; não há campo de edição para ela no painel. |
header string | Texto do cabeçalho do chat. Painel: Canais > Seu site > Conteúdo de texto > Texto do cabeçalho (máx. 200 caracteres) |
header2 string | Texto secundário do cabeçalho (máx. 200 caracteres). Disponível pela API como header2, ou subtitle em Widget Configuration; não há campo de edição para ele no painel. |
language_chosen string | Códigos de idioma separados por vírgula (ex.: "en,es,de"). Painel: Identidade > Persona de IA > Idiomas (máx. 200 caracteres no total; códigos além do limite de 30 idiomas são descartados) |
Valores de personality:
| Value | Label | Description |
|---|---|---|
| 0 | Classic | Equilibrado, com bom balanço entre profissionalismo e acessibilidade (padrão) |
| 1 | Humorous | Tom espirituoso com trocadilhos e piadas para interações divertidas |
| 2 | Formal | Formal e sério, informações factuais e concisas para contextos de negócios |
| 3 | Friendly | Conversas descontraídas com um toque pessoal e acessível |
| 4 | Sassy | Confiante e brincalhão, com humor |
| 5 | Intelligent | Informações detalhadas e precisas para uma compreensão abrangente |
| 6 | Empathetic | Interações atenciosas e compassivas, demonstrando preocupação com os sentimentos |
| 7 | Bold | Opiniões e recomendações firmes, transmitidas com confiança |
| 9 | Excited | Engajamento animado e cheio de energia |
| 10 | Mysterious | Respostas enigmáticas e intrigantes para uma experiência única |
| 11 | Inspiring | Promove pensamento positivo e o alcance de metas, como um coach |
| 12 | Adventurous | Incentiva sair da zona de conforto e explorar novas oportunidades |
| 13 | Elegant | Experiência sofisticada para marcas únicas e refinadas |
Valores de profession:
| Value | Dashboard Label | Description |
|---|---|---|
helpful_assistant | Helpful Assistant | Versátil, multipropósito. Recomendado para a maioria dos casos de uso |
customer_support_representative | Support Agent | Empático, oferece soluções passo a passo e resolução de problemas |
shopping_assistant | Shopping Assistant | Oferece proativamente recomendações de produtos com links |
field_expert | Field Expert | Consultor profissional, faz perguntas para esclarecer e fornece orientação especializada |
interviewer | Interviewer | Faz perguntas em vez de fornecer respostas. Para pesquisas, entrevistas, feedback |
Os campos one_word_description, short_description e ai_commands também estão disponíveis através do endpoint de Knowledge Base Settings. Esses campos são compartilhados — atualizar por qualquer um dos endpoints modifica os mesmos dados subjacentes.
Update Chatbot Settings
Seção intitulada “Update Chatbot Settings”PATCH https://app.quickchat.ai/v1/api/chatbot_settings
Request Body — Todos os campos são opcionais. Inclua apenas os campos que você quer atualizar.
| Parameter | Description |
|---|---|
personality integer (0–13) | Preset de personalidade da IA |
profession string | Profissão/papel da IA (máx. 200 caracteres) |
creativity_level integer (0–2) | 0 = Baixo, 1 = Normal, 2 = Alto |
greeting string | Mensagem de boas-vindas principal (HTML, máx. 1000 caracteres) |
greeting2 string | Mensagem de boas-vindas secundária |
header string | Texto do cabeçalho do chat (máx. 200 caracteres) |
header2 string | Texto secundário do cabeçalho (máx. 200 caracteres) |
language_chosen string | Códigos de idioma separados por vírgula (máx. 200 caracteres no total; códigos além do limite de 30 idiomas são descartados) |
reply_length integer (0–2) | 0 = Curto, 1 = Normal, 2 = Mais longo |
one_word_description string | Nome do Agente de IA. Máximo de 200 caracteres pela API; o campo no app limita a 40. |
short_description string | System prompt / Prompt principal do Agente de IA. A API aceita até 25.000 caracteres em todos os planos; o editor in-app limita ao teto do seu plano, que começa em 15.000. Um valor longo demais retorna 422. |
ai_commands array of strings | AI Guidelines, uma diretriz por item do array. Até 250 itens, 5.000 caracteres por item e 10.000 caracteres no total entre todos os itens. Um valor longo demais retorna 422. |
Cada item do array é uma diretriz e é salva exatamente como você a envia. A pontuação é preservada, incluindo os pontos e vírgulas. Antes, este endpoint removia os ; do seu texto antes de salvar. Se você os retirava ou substituía por causa disso, não é mais necessário.
Omita ai_commands, ou envie null, para deixar as diretrizes inalteradas. Envie [] para apagá-las.
curl -X PATCH https://app.quickchat.ai/v1/api/chatbot_settings \ -H 'Authorization: Bearer <API_TOKEN>' \ -H 'Content-Type: application/json' \ -d '{ "greeting": "<p>Welcome! Ask me anything.</p>", "creativity_level": 2}'import requests
response = requests.patch( url="https://app.quickchat.ai/v1/api/chatbot_settings", headers={"Authorization": "Bearer <API_TOKEN>"}, json={ "greeting": "<p>Welcome! Ask me anything.</p>", "creativity_level": 2, },)data = response.json()Response 200 OK — Retorna as configurações do chatbot atualizadas (mesmo schema da resposta de Get Chatbot Settings).