POST
/
api
/
v1
/
bot
curl --request POST \
  --url https://chat.api.toolzz.com.br/api/v1/bot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "model": "<string>",
  "description": "<string>",
  "prompt": "<string>",
  "credentialId": "<string>",
  "unityId": "<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
}

​
Parameters

​
name
string

The bot name

​
model
string

The bot model

​
description
string

The bot description

​
prompt
string

The bot prompt

​
credentialId
string

The bot credential

​
unityId
string

The bot unity

​
Response Description

Below you will see the description of the bot response

​
prompt
string
required

Text or command used as input for the bot.

​
description
string
required

Detailed description of the bot’s purpose or functionality.

​
folders
any[]
required

List of folders associated with the bot.

​
plugins
any[]
required

Active plugins or integrations for the bot.

​
botGenAI
any
required

Settings related to the bot’s artificial intelligence.

​
assistantId
string
required

Unique ID of the linked assistant.

​
IconFile
any
required

Icon file associated with the bot.

​
widgetId
string

Optional ID of the linked widget.

​
tags
string[]

List of tags associated with the bot.

​
unityId
string

ID of the organizational unit.

​
progressStatus
string

Progress status of the bot.

​
safeMode
boolean

Indicates whether safe mode is enabled.

​
institutionId
string
required

ID of the institution responsible for the bot.

​
indexService
string

Indexing service linked to the bot.

​
isActivated
boolean
required

Activation status of the bot.

​
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.