Delete Agent

Endpoint used to delete an agent by its ID.

Request Example

curl --request DELETE \
  --url https://chat.api.toolzz.com.br/api/v1/bot/{id} \
  --header 'Authorization: Bearer TOKEN_HERE'

Response Example

{
  "message": "<string>"
}

---

Request description

Access Token

Parameter	Type	Description	Required
Authorization	String	Access token (“Bearer” must be before the token)	Yes

Body Parameters

Parameter	Type	Description	Required
id	UUID	Bot unique identifier.	Yes

---

Response description

Key	Type	Description	Required
id	UUID	Unique identifier of the created Bot.	Yes
name	String	Bot name returned by the system.	Yes
prompt	String	Behavior and personality instructions (System Prompt).	Yes
metaprompt	String	System control instructions and AI limitations.	Yes
description	String	Brief description of the Bot’s functions.	Yes
isActivated	Boolean	Bot activation status (true/false).	Yes
unityId	UUID	Linked organizational unit identifier.	Yes
institutionId	UUID	Owning institution identifier.	Yes
fallbackPhrase	String	Safety phrase sent when the AI does not find an answer.	No
folders	Array	List of linked folders and knowledge bases (RAG).	Yes
plugins	Array	Active integration plugins (e.g., Google Calendar).	Yes
botGenAI	Array	Generative model settings (temperature, tokens, etc.).	Yes
IconFile	Object	Metadata and URL of the Bot’s icon image.	Yes
tags	Array	List of search tags associated with the Bot.	No
botMonetization	Object	Pricing rules, currency, and recurrence.	No
botVoiceConfig	Array	Voice settings, audio widget colors, and provider.	No
botMultiAgents	Array	Flow and transition rules between different agents.	No
botFallBack	Array	List of agents configured for automatic overflow.	No
favorites	Array	List of identifiers of users who favorited the Bot.	No

---

Security

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.

To access your access token, follow these steps:

1. Log in to the ToolzzAI platform
2. Click on “Settings”
3. Click on “Access Token”
4. Copy the access token