Get Widget by Unity - Toolzz Docs

GET

api

widget

unity

{id}

curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/widget/unity/{id} \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "<string>",
      "institutionId": "<string>",
      "title": "<string>",
      "subTitle": "<string>",
      "headerIconFileId": "<string>",
      "primaryColor": "<string>",
      "secondaryColor": "<string>",
      "widgetIconFileId": "<string>",
      "primaryAIColor": "<string>",
      "secondaryAIColor": "<string>",
      "avatarIconFileId": "<string>",
      "aiFirstMessage": "<string>",
      "primaryUserColor": "<string>",
      "secondaryUserColor": "<string>",
      "Bot": {
        "id": "<string>",
        "creatorId": "<string>",
        "institutionId": "<string>",
        "unityId": "<string>",
        "name": "<string>",
        "description": "<string>",
        "iconFileId": "<string>",
        "creativePrecision": 123,
        "prompt": "<string>",
        "metaprompt": "<string>",
        "safeMode": true,
        "isActivated": true,
        "progressStatus": "<string>",
        "hasMonetization": true,
        "hasAnalytics": true,
        "hasTools": true,
        "isAdvancedBot": true,
        "botGenAI": [
          {
            "id": "<string>",
            "botId": "<string>",
            "model": "<string>",
            "messagesLimit": 123,
            "charactersLimit": 123,
            "temperature": 123
          }
        ]
      },
      "audioVoice": "<string>",
      "voiceActive": true,
      "isPublic": true,
      "isActive": true,
      "isActivated": true,
      "isFavorited": true
    }
  ],
  "totalItems": 123,
  "widgetCount": 123,
  "activeCount": 123,
  "widgetLimit": 123
}

The result must contain an array listing all widgets

string

The id of the unity

Response Description

Below you will see the description of the unity response

items

array

required

List of widgets and their details.

string

required

Unique identifier for the widget.

institutionId

string

required

ID of the associated institution.

title

string

required

Title of the widget.

subTitle

string

required

Subtitle of the widget.

headerIconFileId

string

Optional header icon file ID.

primaryColor

string

required

Primary color configuration.

secondaryColor

string

required

Secondary color configuration.

Optional widget icon file ID.

primaryAIColor

string

required

Primary AI color configuration.

secondaryAIColor

string

required

Secondary AI color configuration.

avatarIconFileId

string

Optional avatar icon file ID.

aiFirstMessage

string

required

First message displayed by the AI.

primaryUserColor

string

required

Primary user color configuration.

secondaryUserColor

string

required

Secondary user color configuration.

Bot

object

required

audioVoice

string

Optional audio voice setting.

voiceActive

boolean

Indicates if voice functionality is active.

isPublic

boolean

required

Indicates if the widget is public.

isActive

boolean

required

Indicates if the widget is active.

isActivated

boolean

required

Activation status of the widget.

isFavorited

boolean

Indicates if the widget is marked as a favorite.

totalItems

number

required

Total number of items.

Total count of widgets.

activeCount

number

required

Number of active widgets.

Maximum limit for widgets.

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.

Create Widget Update Widget

curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/widget/unity/{id} \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "<string>",
      "institutionId": "<string>",
      "title": "<string>",
      "subTitle": "<string>",
      "headerIconFileId": "<string>",
      "primaryColor": "<string>",
      "secondaryColor": "<string>",
      "widgetIconFileId": "<string>",
      "primaryAIColor": "<string>",
      "secondaryAIColor": "<string>",
      "avatarIconFileId": "<string>",
      "aiFirstMessage": "<string>",
      "primaryUserColor": "<string>",
      "secondaryUserColor": "<string>",
      "Bot": {
        "id": "<string>",
        "creatorId": "<string>",
        "institutionId": "<string>",
        "unityId": "<string>",
        "name": "<string>",
        "description": "<string>",
        "iconFileId": "<string>",
        "creativePrecision": 123,
        "prompt": "<string>",
        "metaprompt": "<string>",
        "safeMode": true,
        "isActivated": true,
        "progressStatus": "<string>",
        "hasMonetization": true,
        "hasAnalytics": true,
        "hasTools": true,
        "isAdvancedBot": true,
        "botGenAI": [
          {
            "id": "<string>",
            "botId": "<string>",
            "model": "<string>",
            "messagesLimit": 123,
            "charactersLimit": 123,
            "temperature": 123
          }
        ]
      },
      "audioVoice": "<string>",
      "voiceActive": true,
      "isPublic": true,
      "isActive": true,
      "isActivated": true,
      "isFavorited": true
    }
  ],
  "totalItems": 123,
  "widgetCount": 123,
  "activeCount": 123,
  "widgetLimit": 123
}

Toolzz AI

​Response Description

​Segurança

Response Description

Segurança