Pular para o conteúdo principal
PUT
Atualizar agente

Autorizações

Authorization
string
header
obrigatório

Token JWT de autenticação

Cabeçalhos

x-company-id
string

Identificador da empresa-alvo. Obrigatório apenas para API Keys globais (type=global). Ignorado para API Keys de empresa e usuários humanos.

Parâmetros de caminho

id
string
obrigatório

ID do agente

Corpo

application/json
name
string

Nome do agente na plataforma.

welcome_message
object | null

Mensagem de boas-vindas. null remove.

prompts
object

Prompts do agente. Só os campos enviados mudam; listas enviadas substituem as atuais.

agent_flow
string

ID do fluxo de execução do agente.

Minimum string length: 1
status
enum<string>

Status do agente.

Opções disponíveis:
ACTIVE,
DRAFT,
INACTIVE,
DELETED
general_config
object

Configurações gerais do agente

model_config
object
voice_config
object

Agente de voz do funil (ligações entrantes atendidas por IA)

specialist_config
object

Configurações do specialist (qualificação e ICP)

avatar_color
string

Cor do avatar do agente.

avatar_initials
string

Iniciais exibidas no avatar (até 2 caracteres).

Maximum string length: 2
personality_presets
enum<string>[]

Perfis de personalidade prontos (até 3).

Maximum array length: 3
Opções disponíveis:
FRIENDLY,
DIDACTIC,
CURIOUS,
FORMAL,
PLAYFUL,
PERSUASIVE
knowledge_base
string[]

IDs dos conhecimentos que o agente consulta.

Resposta

200 - application/json
_id
object
obrigatório
name
string
obrigatório
agent_flow
object
obrigatório
prompts
object
obrigatório
company
object
obrigatório
model_config
object
obrigatório
status
enum<string>
obrigatório
Opções disponíveis:
ACTIVE,
DRAFT,
INACTIVE,
DELETED
general_config
object
specialist_config
object
voice_config
object

Aba Voz: agente que atende as ligações entrantes. Ausente = desligado.

knowledge_base
object[]
avatar_color
string
avatar_initials
string
personality_presets
enum<string>[]
Opções disponíveis:
FRIENDLY,
DIDACTIC,
CURIOUS,
FORMAL,
PLAYFUL,
PERSUASIVE
steps
object[]