GET
/
api
/
v1
/
bot
/
{id}
Get Bot
curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/bot/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "prompt": "<string>",
  "metaprompt": "<string>",
  "description": "<string>",
  "folders": [
    "<any>"
  ],
  "plugins": [
    "<any>"
  ],
  "botGenAI": [
    "<any>"
  ],
  "assistantId": "<string>",
  "IconFile": "<any>",
  "tags": [
    "<string>"
  ],
  "unityId": "<string>",
  "institutionId": "<string>",
  "progressStatus": "<string>",
  "safeMode": true,
  "isActivated": true,
  "botMonetization": "<any>",
  "hasMonetization": true,
  "hasAnalytics": true,
  "isAdvancedBot": true,
  "hasTools": true,
  "hasPlugins": true,
  "favorites": [
    "<any>"
  ],
  "botFallBack": [
    "<any>"
  ]
}
​
id
string
Id of the bot

​
Response Description

Below you will see the description of the bot response
​
id
string
required
Unique ID of the Bot.
​
name
string
required
Name of the Bot.
​
prompt
string
required
Text or command used as input for the bot.
​
metaprompt
string
Additional configurations related to language, formatting, and response preferences.
​
description
string
required
Short description or purpose of the bot.
​
folders
any[]
required
List of folders and their relationships.
​
plugins
any[]
required
Plugins associated with the bot, including configurations and code.
​
botGenAI
any[]
required
Settings and configurations for the bot’s generative AI capabilities.
​
assistantId
string
Optional ID of the linked assistant.
​
IconFile
any
Icon file linked to the bot.
​
tags
string[]
Tags or labels associated with the bot.
​
unityId
string
required
ID of the organizational unit associated with the bot.
​
institutionId
string
required
ID of the institution responsible for the bot.
​
progressStatus
string
Current status of the bot’s progress (e.g., FINISHED).
​
safeMode
boolean
Indicates if safe mode is enabled for the bot.
​
isActivated
boolean
required
Activation status of the bot.
​
botMonetization
any
Monetization settings for the bot, including price and recurrence.
​
hasMonetization
boolean
Indicates if monetization is enabled for the bot.
​
hasAnalytics
boolean
Indicates if analytics features are enabled.
​
isAdvancedBot
boolean
Specifies if the bot is categorized as an advanced bot.
​
hasTools
boolean
Indicates if the bot has tools enabled.
​
hasPlugins
boolean
Indicates if plugins are enabled for the bot.
​
favorites
any[]
List of users who have marked the bot as a favorite.
​
botFallBack
any[]
Fallback configurations for the bot.