PUT
/
api
/
v1
/
bot
/
{id}
Atualizar Agente
curl --request PUT \
  --url https://chat.api.toolzz.com.br/api/v1/bot/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "model": "<string>",
  "description": "<string>",
  "prompt": "<string>",
  "credentialId": "<string>"
}'
{
  "prompt": "<string>",
  "description": "<string>",
  "folders": [
    "<any>"
  ],
  "plugins": [
    "<any>"
  ],
  "botGenAI": "<any>",
  "assistantId": "<string>",
  "IconFile": "<any>",
  "widgetId": "<string>",
  "tags": [
    "<string>"
  ],
  "unityId": "<string>",
  "progressStatus": "<string>",
  "safeMode": true,
  "institutionId": "<string>",
  "indexService": "<string>",
  "isActivated": true
}

Descrição dos Parâmetros

id
string
ID do agente
name
string
Nome do agente
model
string
Modelo do agente
description
string
Descrição do agente
prompt
string
Prompt do agente
credentialId
string
ID da credencial do agente

Descrição da Resposta

Abaixo você verá a descrição da resposta do agente
prompt
string
required
Texto ou comando usado como entrada para o agente.
description
string
required
Descrição detalhada da finalidade ou funcionalidade do agente.
folders
any[]
required
Lista de pastas associadas ao agente.
plugins
any[]
required
Plugins ou integrações ativas do agente.
botGenAI
any
required
Configurações relacionadas à inteligência artificial do agente.
assistantId
string
required
ID único do assistente vinculado.
IconFile
any
required
Arquivo de ícone associado ao agente.
widgetId
string
ID opcional do widget vinculado.
tags
string[]
Lista de tags associadas ao agente.
unityId
string
ID da unidade organizacional.
progressStatus
string
Status de progresso do agente.
safeMode
boolean
Indica se o modo seguro está ativado.
institutionId
string
required
ID da instituição responsável pelo agente.
indexService
string
Serviço de indexação vinculado ao agente.
isActivated
boolean
required
Status de ativação do agente.

Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para proteger os dados dos usuários.