Skip to main content
POST
/
api
/
v1
/
bot
Criar Agente
curl --request POST \
  --url https://chat.api.toolzz.com.br/api/v1/bot \
  --header 'Content-Type: application/json' \
  --data '
{
  "unityId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "tags": "<string>",
  "prompt": "<string>",
  "iconFileId": "<string>",
  "model": "<string>",
  "credentialId": "<string>",
  "safeMode": true,
  "messagesLimit": 123,
  "charactersLimit": 123,
  "isAdvancedBot": true,
  "temperature": 123,
  "topP": 123,
  "presencePenalty": 123,
  "frequencyPenalty": 123,
  "topK": 123,
  "messagesQuery": 123,
  "hasPlugins": true,
  "hasTools": true,
  "hasWhatsapp": true,
  "hasMulti": true,
  "hasInstagram": true,
  "hasMessenger": true,
  "hasAnalytics": true,
  "hasMonetization": true,
  "hasVoice": true,
  "genAIOrganization": "<string>",
  "analyticsCredentialId": "<string>",
  "folder": [
    "<string>"
  ]
}
'
{
  "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": [
    {}
  ]
}

Parâmetros

Authorization
string
Token de acesso
unityId
string
required
Identificador da unidade associada ao agente.
name
string
required
Nome do agente.
description
string
required
Descrição do agente.
tags
string
Tags associadas ao agente.
prompt
string
required
Prompt base utilizado pelo agente.
iconFileId
string
Identificador do arquivo de ícone associado ao agente.
model
string
required
Modelo de IA utilizado pelo agente.
credentialId
string
required
Identificador da credencial utilizada pelo agente.
safeMode
boolean
Indica se o modo seguro está habilitado.
messagesLimit
number
Limite máximo de mensagens permitido.
charactersLimit
number
Limite máximo de caracteres permitido.
isAdvancedBot
boolean
Indica se o agente utiliza configurações avançadas.
temperature
number
Controla o nível de criatividade das respostas.
topP
number
Define o recorte probabilístico das respostas geradas.
presencePenalty
number
Penalidade aplicada para incentivar novos tópicos nas respostas.
frequencyPenalty
number
Penalidade aplicada para reduzir repetições nas respostas.
topK
number
Limita a quantidade de tokens candidatos considerados na geração.
messagesQuery
number
Quantidade de mensagens consideradas no contexto da consulta.
hasPlugins
boolean
Indica se o agente possui plugins habilitados.
hasTools
boolean
Indica se o agente possui ferramentas habilitadas.
hasWhatsapp
boolean
Indica se o agente possui integração com WhatsApp.
hasMulti
boolean
Indica se o agente possui suporte multicanal.
hasInstagram
boolean
Indica se o agente possui integração com Instagram.
hasMessenger
boolean
Indica se o agente possui integração com Messenger.
hasAnalytics
boolean
Indica se o agente possui analytics habilitado.
hasMonetization
boolean
Indica se o agente possui monetização habilitada.
hasVoice
boolean
Indica se o agente possui recurso de voz habilitado.
genAIOrganization
string
Organização de IA generativa associada ao agente.
analyticsCredentialId
string
Identificador da credencial de analytics.
folder
string[]
Lista de ID das pastas associadas ao 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.

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.