Obter Widget por Unidade

Obter todos os widgets da unidade

GET /api/v1/widget/unity/{id}

Obter Widget por Unidade

cURL

curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/widget/unity/{id}

200

{
  "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
}

O resultado deve conter um array listando todos os widgets

Token de Acesso

Authorization · string

Token de acesso (“Bearer” deve estar antes do token)

id · string

ID da unidade

Descrição da Resposta

Abaixo você verá a descrição da resposta da unidade

items · array · required

Lista de widgets e seus detalhes.

Show items

id · string · required

Identificador único do widget.

institutionId · string · required

ID da instituição associada.

title · string · required

Título do widget.

subTitle · string · required

Subtítulo do widget.

headerIconFileId · string

ID opcional do arquivo de ícone do cabeçalho.

primaryColor · string · required

Configuração de cor primária.

secondaryColor · string · required

Configuração de cor secundária.

widgetIconFileId · string

ID opcional do arquivo de ícone do widget.

primaryAIColor · string · required

Configuração de cor primária da IA.

secondaryAIColor · string · required

Configuração de cor secundária da IA.

avatarIconFileId · string

ID opcional do arquivo de ícone do avatar.

aiFirstMessage · string · required

Primeira mensagem exibida pela IA.

primaryUserColor · string · required

Configuração de cor primária do usuário.

secondaryUserColor · string · required

Configuração de cor secundária do usuário.

Bot · object · required

Show properties

id · string · required

Identificador único do agente.

creatorId · string · required

ID do criador do agente.

institutionId · string · required

ID da instituição associada ao agente.

unityId · string · required

ID da unidade associada ao agente.

name · string · required

Nome do agente.

description · string · required

Descrição da funcionalidade do agente.

iconFileId · string

ID opcional do arquivo de ícone do agente.

creativePrecision · number · required

Nível de precisão para respostas criativas.

prompt · string · required

Prompt detalhado definindo o comportamento do agente.

metaprompt · string

Configurações personalizáveis para interações do agente.

safeMode · boolean

Indica se o modo seguro está ativado para o agente.

isActivated · boolean · required

Status de ativação do agente.

progressStatus · string

Status de progresso do agente.

hasMonetization · boolean

Indica se a monetização está ativada para o agente.

hasAnalytics · boolean

Indica se analytics está ativado para o agente.

hasTools · boolean

Indica se ferramentas estão ativadas para o agente.

isAdvancedBot · boolean

Especifica se o agente é avançado.

botGenAI · array

Lista de configurações de IA generativa para o agente.

Show items

id · string · required

Identificador único da configuração de IA generativa.

botId · string · required

ID do agente associado à configuração de IA.

model · string

Modelo de IA utilizado, como “gpt-4o”.

messagesLimit · number

Número máximo de mensagens permitidas.

charactersLimit · number

Limite máximo de caracteres para respostas.

temperature · number

Configuração de temperatura para variabilidade das respostas.

audioVoice · string

Configuração opcional de voz de áudio.

voiceActive · boolean

Indica se a funcionalidade de voz está ativa.

isPublic · boolean · required

Indica se o widget é público.

isActive · boolean · required

Indica se o widget está ativo.

isActivated · boolean · required

Status de ativação do widget.

isFavorited · boolean

Indica se o widget está marcado como favorito.

totalItems · number · required

Número total de itens.

widgetCount · number · required

Contagem total de widgets.

activeCount · number · required

Número de widgets ativos.

widgetLimit · number · required

Limite máximo de 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.