Chatbot Settings

Recupere e atualize a configuração completa do seu Agente de IA via REST API.

Chatbot Settings

Recupere e atualize a configuração completa do seu Agente de IA, incluindo personalidade, estilo de conversa e system prompt.

Corresponde a Identity > Profile e Identity > Conversation Style no Dashboard.

Get Chatbot Settings

Scope: read_all

GET https://app.quickchat.ai/v1/api/chatbot_settings

Shell
Python

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. Dashboard: Identity > Profile > AI Agent Name (máx. 200 caracteres)
`short_description` string	System prompt / descrição do Agente de IA. Dashboard: Identity > Profile > AI Agent Description (máx. 2000 caracteres)
`ai_commands` array of strings	Diretrizes de comportamento para a IA. Dashboard: Identity > Conversation Style > AI Guidelines (máx. 500 caracteres por item, máx. 5000 caracteres no total entre todos os itens)
`personality` integer (0–13)	Preset de personalidade da IA. Dashboard: Identity > Conversation Style > Personality. Veja a tabela abaixo
`profession` string	Profissão/papel da IA. Dashboard: Identity > Conversation Style > Profession (máx. 200 caracteres). Veja a tabela abaixo
`creativity_level` integer (0–2)	Dashboard: Identity > Conversation Style > Creativity. `0` = Deterministic, `1` = Balanced, `2` = Creative
`reply_length` integer (0–2)	Dashboard: Identity > Conversation Style > Reply Length. `0` = Short, `1` = Medium, `2` = Long
`greeting` string	Mensagem de saudação principal (HTML). Dashboard: Identity > Profile > Greeting messages (máx. 1000 caracteres)
`greeting2` string	Mensagem de saudação secundária (HTML). Dashboard: Identity > Profile > Greeting messages
`header` string	Texto do cabeçalho do chat. Dashboard: Identity > Profile > Chat header text (máx. 200 caracteres)
`header2` string	Texto secundário do cabeçalho. Dashboard: Identity > Profile > Chat header text (máx. 200 caracteres)
`language_chosen` string	Códigos de idioma separados por vírgula (ex.: `"en,es,de"`). Dashboard: Identity > Profile > Languages (máx. 10 caracteres no total)

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

Update Chatbot Settings

Scope: write_all

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` = Deterministic, `1` = Balanced, `2` = Creative
`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. 10 caracteres no total)
`reply_length` integer (0–2)	`0` = Short, `1` = Medium, `2` = Long
`one_word_description` string	Nome do Agente de IA (máx. 200 caracteres)
`short_description` string	System prompt / descrição do Agente de IA (máx. 2000 caracteres)
`ai_commands` array of strings	AI Guidelines (máx. 500 caracteres por item)

Shell
Python

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).

Chatbot Settings