GET
/
api
/
v1
/
bot
/
{id}
Obter Agente
curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/bot/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "prompt": "<string>",
  "metaprompt": "<string>",
  "description": "<string>",
  "folders": [
    "<any>"
  ],
  "plugins": [
    "<any>"
  ],
  "botGenAI": [
    "<any>"
  ],
  "assistantId": "<string>",
  "IconFile": "<any>",
  "tags": [
    "<string>"
  ],
  "unityId": "<string>",
  "institutionId": "<string>",
  "progressStatus": "<string>",
  "safeMode": true,
  "isActivated": true,
  "botMonetization": "<any>",
  "hasMonetization": true,
  "hasAnalytics": true,
  "isAdvancedBot": true,
  "hasTools": true,
  "hasPlugins": true,
  "favorites": [
    "<any>"
  ],
  "botFallBack": [
    "<any>"
  ]
}
​
id
string
ID do agente

​
Descrição da Resposta

Abaixo você verá a descrição da resposta do agente
​
id
string
required
ID único do agente.
​
name
string
required
Nome do agente.
​
prompt
string
required
Texto ou comando usado como entrada para o agente.
​
metaprompt
string
Configurações adicionais relacionadas a linguagem, formatação e preferências de resposta.
​
description
string
required
Descrição curta ou finalidade do agente.
​
folders
any[]
required
Lista de pastas e seus relacionamentos.
​
plugins
any[]
required
Plugins associados ao agente, incluindo configurações e código.
​
botGenAI
any[]
required
Configurações e definições para as capacidades generativas de IA do agente.
​
assistantId
string
ID opcional do assistente vinculado.
​
IconFile
any
Arquivo de ícone vinculado ao agente.
​
tags
string[]
Tags ou rótulos associados ao agente.
​
unityId
string
required
ID da unidade organizacional associada ao agente.
​
institutionId
string
required
ID da instituição responsável pelo agente.
​
progressStatus
string
Status atual de progresso do agente (ex: FINALIZADO).
​
safeMode
boolean
Indica se o modo seguro está ativado para o agente.
​
isActivated
boolean
required
Status de ativação do agente.
​
botMonetization
any
Configurações de monetização do agente, incluindo preço e recorrência.
​
hasMonetization
boolean
Indica se a monetização está ativada para o agente.
​
hasAnalytics
boolean
Indica se recursos de analytics estão ativados.
​
isAdvancedBot
boolean
Especifica se o agente é categorizado como avançado.
​
hasTools
boolean
Indica se o agente possui ferramentas ativadas.
​
hasPlugins
boolean
Indica se plugins estão ativados para o agente.
​
favorites
any[]
Lista de usuários que marcaram o agente como favorito.
​
botFallBack
any[]
Configurações de fallback para o agente.