v15

OpenAPI 3.0.32026-08-0323066.0 KB

Agents

Obter assistente

Recupera os detalhes de um assistente.

get/agents/{id}

Path parameters

idstring required

Identificador do assistente

Response

Successful response

idstring required

Identificador do assistente

namestring required

Nome do assistente

descriptionstring nullable

Instruções ao modelo de IA para direcionar a geração de respostas desejadas

colorstring

Cor associada ao assistente

welcomestring nullable

Mensagem de boas-vindas do assistente

instructionsstring nullable

Instruções para o assistente

offstring nullable

Mensagem quando o assistente não souber a resposta

referencesboolean

Indica se o assistente usa referências

purpose'general' | 'leads' | 'cs'

Finalidade do assistente

freedom'free' | 'restricted'

Uso da base de conhecimento

behavior_type'basic' | 'custom'

Configuração de comportamento do assistente

status'online' | 'offline' | 'draft'

Status do assistente

leftboolean

Posição do widget do assistente à esquerda da tela

modelstring nullable

Modelo de IA do assistente

workspaceIdstring required

Identificador do workspace associado

createdAtstring date-time

Data de criação

updatedAtstring date-time

Data da última atualização

createdBystring nullable required

ID do usuário que criou o registro

updatedBystring nullable required

ID do usuário que atualizou o registro

kbsstring[]

Bases de conhecimento associadas ao assistente