Get Template by ID

Endpoint used to fetch a template by its ID.

Request Example

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

Response Example

{
  "message": "<string>",
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "iconId": "<string>",
  "templateIcon": {},
  "institutionId": "<string>",
  "institution": "<any>",
  "unityId": "<string>",
  "unity": "<any>",
  "category": "<string>",
  "prompt": "<string>",
  "hasInstagram": true,
  "hasMessenger": true,
  "hasMulti": true,
  "hasTools": true,
  "hasVoice": true,
  "hasWhatsapp": true,
  "hasPlugin": true,
  "active": true,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "voiceTemplate": [
    "<any>"
  ],
  "voicesTemplateCount": 123,
  "pluginTemplate": [
    "<any>"
  ],
  "pluginsTemplateCount": 123,
  "canCreatePlugins": true
}

Request description

Access Token

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

URL Parameters (Query Params)

Parameter	Type	Description
`unityId`	String	Unique unit identifier to filter the templates.

Response description

Key	Type	Description
`message`	String	Status message or confirmation of the operation.
`templates`	Array	List containing the configuration objects for the available Bot templates.
`templates[].id`	UUID	Template unique identifier.
`templates[].name`	String	Template name (e.g., “Gastronomic Assistant”).
`templates[].description`	String	Detailed description of the template’s capabilities.
`templates[].iconId`	UUID	Identifier of the icon associated with the template.
`templates[].templateIcon`	Object	Object containing metadata of the icon image (URL, size, extension).
`templates[].institutionId`	UUID	Identifier of the institution that owns the template.
`templates[].unityId`	UUID	Linked organizational unit identifier.
`templates[].category`	String	Category in which the template is classified.
`templates[].prompt`	String	Base System Prompt that defines the bot’s behavior for this template.
`templates[].hasInstagram`	Boolean	Indicates if the template supports integration with Instagram.
`templates[].hasMessenger`	Boolean	Indicates if the template supports integration with Messenger.
`templates[].hasVoice`	Boolean	Indicates if the template has support for voice interactions.
`templates[].hasPlugin`	Boolean	Indicates if the template has pre-configured plugins.
`templates[].active`	Boolean	Availability status of the template in the system.
`templates[].voiceTemplate`	Array	List of predefined voice settings for this template.
`templates[].voicesTemplateCount`	Number	Total quantity of linked voice models.
`templates[].pluginTemplate`	Array	List of objects with the plugins linked to the template (ID, name, and status).
`templates[].pluginsTemplateCount`	Number	Total quantity of plugins linked to the template.
`templates[].canCreatePlugins`	Boolean	Defines if the user has permission to create new plugins from this template.
`categories`	Array	List of available categories for template filtering.
`totalCount`	Number	Total quantity of templates found in the query.

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:

Log in to the ToolzzAI platform
Click on “Settings”
Click on “Access Token”
Copy the access token

Access token page