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": [
    {}
  ]
}

GET

api

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)

uuid

ID do agente

Descrição da Resposta

Abaixo você verá a descrição da resposta do agente

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.

Show BotGenAI properties

isDefault

boolean

required

Indica se esta é a configuração padrão do agente.

messagesLimit

number

Limite máximo de mensagens.

charactersLimit

number

Limite máximo de caracteres.

temperature

number

Controla o nível de criatividade das respostas.

topP

number

Define o recorte probabilístico das respostas geradas.

frequencyPenalty

number

Penalidade aplicada para reduzir repetições nas respostas.

presencePenalty

number

Penalidade aplicada para incentivar novos tópicos nas respostas.

topK

number

Limita a quantidade de tokens candidatos considerados na geração.

messagesQuery

number

Quantidade de mensagens utilizadas como contexto.

string

required

Identificador da configuração de IA generativa.

botId

string

required

Identificador do agente associado.

genAIId

string

Identificador do provedor de IA generativa.

genAIKey

string

Chave do provedor de IA generativa.

genAIOrganization

string

Organização associada ao provedor de IA generativa.

genAIModelId

string

Identificador do modelo de IA generativa.

assistantId

string

Identificador do assistente externo vinculado.

credentialId

string

Identificador da credencial principal.

analyticsCredentialId

string

Identificador da credencial de analytics.

model

string

Modelo utilizado pelo agente.

tools

array

Ferramentas associadas à configuração.

whatsappCredentialId

string

Identificador da credencial do WhatsApp.

instagramCredentialId

string

Identificador da credencial do Instagram.

messengerCredentialId

string

Identificador da credencial do Messenger.

messengerCredential

object

Informações da credencial do Messenger.

Show Messenger credential properties

integration

object

Integração associada à credencial do Messenger.

genAIModel

object

Dados do modelo de IA generativa.

genAI

object

Dados do provedor de IA generativa.

instagramCredential

object

Informações da credencial do Instagram.

Show Instagram credential properties

integration

object

Integração associada à credencial do Instagram.

analyticsCredential

object

Informações da credencial de analytics.

Show Analytics credential properties

integration

object

Integração associada à credencial de analytics.

whatsappCredential

object

Informações da credencial do WhatsApp.

Show Whatsapp credential properties

integration

object

Integração associada à credencial do WhatsApp.

credential

object

Credencial principal utilizada pelo agente.

Show Credential properties

status

boolean

required

Indica se a credencial está ativa.

string

required

Identificador da credencial.

name

string

required

Nome da credencial.

userId

string

required

Identificador do usuário associado à credencial.

unityId

string

required

Identificador da unidade associada à credencial.

integrationId

string

required

Identificador da integração da credencial.

secretId

string

required

Identificador secreto da credencial.

createdAt

string

required

Data de criação da credencial.

updatedAt

string

Data da última atualização da credencial.

virtualKey

string

Chave virtual associada à credencial.

integration

object

Integração associada à credencial.

Show Integration properties

status

boolean

required

Indica se a integração está ativa.

string

required

Identificador da integração.

name

string

required

Nome da integração.

type

string

required

Tipo da integração.

form

array

Campos de formulário necessários para a integração.

Show Form properties

name

string

required

Nome do campo.

type

string

required

Tipo do campo.

label

string

required

Rótulo do campo.

maxLenght

string

Tamanho máximo permitido para o campo.

required

boolean

required

Indica se o campo é obrigatório.

createdAt

string

required

Data de criação da integração.

updatedAt

string

Data da última atualização da integração.

iconId

string

Identificador do ícone da integração.

validationEndpoint

string

Endpoint de validação da integração.

slug

string

Slug da integração.

icon

object

Ícone associado à integração.

Show Icon properties

string

required

Identificador do ícone.

institutionId

string

required

Identificador da instituição associada ao ícone.

type

string

required

Tipo do ícone.

fileName

string

required

Nome do arquivo do ícone.

internalStorageUrl

string

required

URL interna do armazenamento do ícone.

url

string

required

URL pública do ícone.

maskName

string

required

Nome mascarado do arquivo.

createdAt

string

required

Data de criação do ícone.

updatedAt

string

Data da última atualização do ícone.

extension

string

Extensão do arquivo.

size

number

Tamanho do arquivo em bytes.

numberWords

number

Quantidade de palavras associadas ao recurso, quando aplicável.

assistantId

string

Identificador do assistente externo associado ao agente.

IconFile

object

Arquivo de ícone associado ao agente.

Toolzz AI

​Descrição da Resposta

Descrição da Resposta