Obter Agente Por Unidade

Endpoint para obter um agente por unidade

GET /api/v1/bot/unity/{unityId}

Obter Agente Por Unidade

cURL

curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/bot/unity/{unityId}

200

{
  "id?": "<string>",
  "name": "<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
}

Authorization · string

Token de acesso (“Bearer” deve estar antes do token)

unityId · uuid

ID da unidade

Descrição da Resposta

id? · string · required

ID único do agente

name · string · required

Nome do agente

prompt · string · required

Texto ou comando utilizado como entrada para o agente.

description · string · required

Descrição detalhada sobre a finalidade ou funcionamento do agente.

folders · any[] · required

Lista de pastas associadas ao agente.

plugins · any[] · required

Plugins ou integrações ativas no agente.

botGenAI · any · required

Configurações relacionadas à inteligência artificial do agente.

assistantId · string · required

ID exclusivo 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

Modo seguro ativado ou não.

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.