Get Agent by Unit

Endpoint used to fetch agents by unit ID.

Request Example

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

Response Example

{
  "items": [
    {
      "id": "uuid",
      "name": "<string>",
      "prompt": "<string>",
      "metaprompt": "<string>",
      "description": "<string>",
      "botGenAI": [
        {
          "isDefault": true,
          "messagesLimit": 123,
          "charactersLimit": 123,
          "temperature": 123,
          "topP": 123,
          "frequencyPenalty": 123,
          "presencePenalty": 123,
          "topK": 123,
          "messagesQuery": 123,
          "id": "uuid",
          "botId": "uuid",
          "credentialId": "uuid",
          "analyticsCredentialId": "uuid",
          "model": "<string>",
          "tools": [
            {
              "type": "<string>",
              "description": "<string>"
            }
          ],
          "credential": {
            "status": false,
            "id": "uuid",
            "name": "<string>",
            "userId": "uuid",
            "unityId": "uuid",
            "integrationId": "uuid",
            "secretId": "uuid",
            "createdAt": "<string>",
            "updatedAt": "<string>",
            "virtualKey": "<string>",
            "integration": {
              "status": true,
              "id": "uuid",
              "name": "<string>",
              "type": "<string>",
              "slug": "<string>",
              "file": {
                "id": "uuid",
                "url": "<string>",
                "extension": "<string>",
                "size": 123
              }
            }
          }
        }
      ],
      "IconFile": {
        "id": "uuid",
        "url": "<string>",
        "fileName": "<string>",
        "extension": "<string>",
        "size": 123
      },
      "tags": [
        "<string>"
      ],
      "unityId": "uuid",
      "institutionId": "uuid",
      "isActivated": true,
      "botMonetization": {
        "credentialId": "uuid",
        "price": 123,
        "timeTest": 123,
        "featuredProduct": true,
        "id": "uuid",
        "coin": "<string>",
        "recurring": "<string>"
      },
      "hasMonetization": true,
      "hasAnalytics": true,
      "hasMulti": true,
      "isAdvancedBot": true,
      "hasTools": true,
      "hasVoice": true,
      "botVoiceConfig": [
        {
          "visualType": "<string>",
          "language": "<string>",
          "primaryColor": "<string>",
          "buttonColor": "<string>",
          "theme": "<string>",
          "textTitle": "<string>",
          "textDescription": "<string>",
          "waitTime": 123,
          "callTime": 123,
          "id": "uuid",
          "botId": "uuid",
          "voiceId": "<string>",
          "voiceCredentialId": "uuid",
          "voiceModel": "<string>",
          "deepgramModel": "<string>"
        }
      ],
      "hasPlugins": true,
      "hasWhatsapp": true,
      "hasInstagram": true,
      "hasMessenger": true,
      "isFavorited": true,
      "botMultiAgents": [],
      "favorites": [
        {
          "id": "uuid",
          "botId": "uuid",
          "userId": "uuid"
        }
      ],
      "botFallBack": []
    }
  ],
  "totalItems": 123,
  "botCount": 123,
  "activeCount": 123,
  "botLimit": 123
}

---

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
unityId	UUID	Unique identifier of the unit.	Yes

---

Response description

Key	Type	Description
items	Array	List containing the configuration objects for each Bot.
items[].id	UUID	Bot unique identifier.
items[].name	String	Bot name.
items[].prompt	String	Behavior and personality instructions (System Prompt).
items[].metaprompt	String	Global AI control instructions and limitations.
items[].description	String	Brief description of the Bot’s functions.
items[].isActivated	Boolean	Activation status (enabled or disabled).
items[].unityId	UUID	Linked organizational unit ID.
items[].institutionId	UUID	Owning institution ID.
items[].botGenAI	Array	Generative model settings (temperature, tokens, AI tools).
items[].IconFile	Object	Metadata and URL of the Bot’s icon image.
items[].tags	Array	List of associated tags for search and filters.
items[].botMonetization	Object	Billing data, price, currency, and recurrence.
items[].botVoiceConfig	Array	Voice parameters, provider, colors, and audio widget behavior.
items[].hasVoice	Boolean	Indicates if the voice functionality is active.
items[].hasPlugins	Boolean	Indicates if the Bot has integration with plugins.
items[].hasMulti	Boolean	Indicates if the Bot is part of a multi-agent configuration.
items[].isAdvancedBot	Boolean	Defines if the Bot uses advanced AI settings.
items[].isFavorited	Boolean	Indicates if the Bot was marked as a favorite by the logged-in user.
items[].favorites	Array	List of favoritism records linked to the user and bot.
items[].botFallBack	Array	List of agents configured for automatic overflow.
totalItems	Number	Total quantity of items returned in the current list.
botCount	Number	Total bots registered for the institution/unit.
activeCount	Number	Total bots that are currently active.
botLimit	Number	Maximum limit of bots allowed by the contracted plan.

---

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