Skip to main content
GET
/
api
/
v1
/
bot
/
{id}
Obter Agente
curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/bot/{id}
{
  "id": "<string>",
  "name": "<string>",
  "prompt": "<string>",
  "metaprompt": "<string>",
  "description": "<string>",
  "folders": [
    {}
  ],
  "plugins": [
    {}
  ],
  "botGenAI": [
    {
      "isDefault": true,
      "messagesLimit": 123,
      "charactersLimit": 123,
      "temperature": 123,
      "topP": 123,
      "frequencyPenalty": 123,
      "presencePenalty": 123,
      "topK": 123,
      "messagesQuery": 123,
      "id": "<string>",
      "botId": "<string>",
      "genAIId": "<string>",
      "genAIKey": "<string>",
      "genAIOrganization": "<string>",
      "genAIModelId": "<string>",
      "assistantId": "<string>",
      "credentialId": "<string>",
      "analyticsCredentialId": "<string>",
      "model": "<string>",
      "tools": [
        {}
      ],
      "whatsappCredentialId": "<string>",
      "instagramCredentialId": "<string>",
      "messengerCredentialId": "<string>",
      "messengerCredential": {
        "integration": {}
      },
      "genAIModel": {},
      "genAI": {},
      "instagramCredential": {
        "integration": {}
      },
      "analyticsCredential": {
        "integration": {}
      },
      "whatsappCredential": {
        "integration": {}
      },
      "credential": {
        "status": true,
        "id": "<string>",
        "name": "<string>",
        "userId": "<string>",
        "unityId": "<string>",
        "integrationId": "<string>",
        "secretId": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "virtualKey": "<string>",
        "integration": {
          "status": true,
          "id": "<string>",
          "name": "<string>",
          "type": "<string>",
          "form": [
            {
              "name": "<string>",
              "type": "<string>",
              "label": "<string>",
              "maxLenght": "<string>",
              "required": true
            }
          ],
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "iconId": "<string>",
          "validationEndpoint": "<string>",
          "slug": "<string>",
          "icon": {
            "id": "<string>",
            "institutionId": "<string>",
            "type": "<string>",
            "fileName": "<string>",
            "internalStorageUrl": "<string>",
            "url": "<string>",
            "maskName": "<string>",
            "createdAt": "<string>",
            "updatedAt": "<string>",
            "extension": "<string>",
            "size": 123,
            "numberWords": 123
          }
        }
      }
    }
  ],
  "assistantId": "<string>",
  "IconFile": {},
  "tags": [
    {}
  ],
  "unityId": "<string>",
  "progressStatus": "<string>",
  "safeMode": true,
  "institutionId": "<string>",
  "isActivated": true,
  "botMonetization": {},
  "hasMonetization": true,
  "hasAnalytics": true,
  "hasMulti": true,
  "isAdvancedBot": true,
  "hasTools": true,
  "hasVoice": true,
  "botVoiceConfig": [
    {}
  ],
  "hasPlugins": true,
  "hasWhatsapp": true,
  "hasInstagram": true,
  "hasMessenger": true,
  "botMultiAgents": [
    {}
  ],
  "favorites": [
    {}
  ],
  "botFallBack": [
    {}
  ]
}
Authorization
string
Token de acesso (“Bearer” deve estar antes do token)
id
uuid
ID do agente

Descrição da Resposta

Abaixo você verá a descrição da resposta do agente
id
string
required
Identificador único do agente.
name
string
required
Nome do agente.
prompt
string
Prompt principal utilizado pelo agente.
metaprompt
string
Metaprompt com instruções avançadas de comportamento, linguagem e formatação.
description
string
Descrição do agente.
folders
array
Lista de pastas associadas ao agente.
plugins
array
Lista de plugins associados ao agente.
botGenAI
array
Configurações de IA generativa associadas ao agente.
assistantId
string
Identificador do assistente externo associado ao agente.
IconFile
object
Arquivo de ícone associado ao agente.
tags
array
Lista de tags associadas ao agente.
unityId
string
required
Identificador da unidade associada ao agente.
progressStatus
string
Status de progresso do agente.
safeMode
boolean
Indica se o modo seguro está habilitado.
institutionId
string
Identificador da instituição associada.
isActivated
boolean
Indica se o agente está ativado.
botMonetization
object
Configurações de monetização do agente.
hasMonetization
boolean
Indica se o agente possui monetização habilitada.
hasAnalytics
boolean
Indica se o agente possui analytics habilitado.
hasMulti
boolean
Indica se o agente possui suporte multicanal.
isAdvancedBot
boolean
Indica se o agente utiliza configurações avançadas.
hasTools
boolean
Indica se o agente possui ferramentas habilitadas.
hasVoice
boolean
Indica se o agente possui recurso de voz habilitado.
botVoiceConfig
array
Lista de configurações de voz do agente.
hasPlugins
boolean
Indica se o agente possui plugins habilitados.
hasWhatsapp
boolean
Indica se o agente possui integração com WhatsApp.
hasInstagram
boolean
Indica se o agente possui integração com Instagram.
hasMessenger
boolean
Indica se o agente possui integração com Messenger.
botMultiAgents
array
Lista de com ID de agente associados ao multiagente se habilitado.
favorites
array
Lista de favoritos associados ao agente.
botFallBack
array
Lista de configurações de fallback do agente.