> ## Documentation Index
> Fetch the complete documentation index at: https://docs.toolzz.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter Widget por Unidade

> Obter todos os widgets da unidade

<Note>O resultado deve conter um array listando todos os widgets</Note>

## Token de Acesso

<ParamField header="Authorization" type="string">
  Token de acesso ("Bearer" deve estar antes do token)
</ParamField>

<ParamField path="id" type="string">
  ID da unidade
</ParamField>

## Descrição da Resposta

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

<ResponseField name="items" type="array" required>
  Lista de widgets e seus detalhes.

  <Expandable title="items">
    <ResponseField name="id" type="string" required>
      Identificador único do widget.
    </ResponseField>

    <ResponseField name="institutionId" type="string" required>
      ID da instituição associada.
    </ResponseField>

    <ResponseField name="title" type="string" required>
      Título do widget.
    </ResponseField>

    <ResponseField name="subTitle" type="string" required>
      Subtítulo do widget.
    </ResponseField>

    <ResponseField name="headerIconFileId" type="string">
      ID opcional do arquivo de ícone do cabeçalho.
    </ResponseField>

    <ResponseField name="primaryColor" type="string" required>
      Configuração de cor primária.
    </ResponseField>

    <ResponseField name="secondaryColor" type="string" required>
      Configuração de cor secundária.
    </ResponseField>

    <ResponseField name="widgetIconFileId" type="string">
      ID opcional do arquivo de ícone do widget.
    </ResponseField>

    <ResponseField name="primaryAIColor" type="string" required>
      Configuração de cor primária da IA.
    </ResponseField>

    <ResponseField name="secondaryAIColor" type="string" required>
      Configuração de cor secundária da IA.
    </ResponseField>

    <ResponseField name="avatarIconFileId" type="string">
      ID opcional do arquivo de ícone do avatar.
    </ResponseField>

    <ResponseField name="aiFirstMessage" type="string" required>
      Primeira mensagem exibida pela IA.
    </ResponseField>

    <ResponseField name="primaryUserColor" type="string" required>
      Configuração de cor primária do usuário.
    </ResponseField>

    <ResponseField name="secondaryUserColor" type="string" required>
      Configuração de cor secundária do usuário.
    </ResponseField>

    <ResponseField name="Bot" type="object" required>
      <Expandable title="properties">
        <ResponseField name="id" type="string" required>
          Identificador único do agente.
        </ResponseField>

        <ResponseField name="creatorId" type="string" required>
          ID do criador do agente.
        </ResponseField>

        <ResponseField name="institutionId" type="string" required>
          ID da instituição associada ao agente.
        </ResponseField>

        <ResponseField name="unityId" type="string" required>
          ID da unidade associada ao agente.
        </ResponseField>

        <ResponseField name="name" type="string" required>
          Nome do agente.
        </ResponseField>

        <ResponseField name="description" type="string" required>
          Descrição da funcionalidade do agente.
        </ResponseField>

        <ResponseField name="iconFileId" type="string">
          ID opcional do arquivo de ícone do agente.
        </ResponseField>

        <ResponseField name="creativePrecision" type="number" required>
          Nível de precisão para respostas criativas.
        </ResponseField>

        <ResponseField name="prompt" type="string" required>
          Prompt detalhado definindo o comportamento do agente.
        </ResponseField>

        <ResponseField name="metaprompt" type="string">
          Configurações personalizáveis para interações do agente.
        </ResponseField>

        <ResponseField name="safeMode" type="boolean">
          Indica se o modo seguro está ativado para o agente.
        </ResponseField>

        <ResponseField name="isActivated" type="boolean" required>
          Status de ativação do agente.
        </ResponseField>

        <ResponseField name="progressStatus" type="string">
          Status de progresso do agente.
        </ResponseField>

        <ResponseField name="hasMonetization" type="boolean">
          Indica se a monetização está ativada para o agente.
        </ResponseField>

        <ResponseField name="hasAnalytics" type="boolean">
          Indica se analytics está ativado para o agente.
        </ResponseField>

        <ResponseField name="hasTools" type="boolean">
          Indica se ferramentas estão ativadas para o agente.
        </ResponseField>

        <ResponseField name="isAdvancedBot" type="boolean">
          Especifica se o agente é avançado.
        </ResponseField>

        <ResponseField name="botGenAI" type="array">
          Lista de configurações de IA generativa para o agente.

          <Expandable title="items">
            <ResponseField name="id" type="string" required>
              Identificador único da configuração de IA generativa.
            </ResponseField>

            <ResponseField name="botId" type="string" required>
              ID do agente associado à configuração de IA.
            </ResponseField>

            <ResponseField name="model" type="string">
              Modelo de IA utilizado, como "gpt-4o".
            </ResponseField>

            <ResponseField name="messagesLimit" type="number">
              Número máximo de mensagens permitidas.
            </ResponseField>

            <ResponseField name="charactersLimit" type="number">
              Limite máximo de caracteres para respostas.
            </ResponseField>

            <ResponseField name="temperature" type="number">
              Configuração de temperatura para variabilidade das respostas.
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="audioVoice" type="string">
      Configuração opcional de voz de áudio.
    </ResponseField>

    <ResponseField name="voiceActive" type="boolean">
      Indica se a funcionalidade de voz está ativa.
    </ResponseField>

    <ResponseField name="isPublic" type="boolean" required>
      Indica se o widget é público.
    </ResponseField>

    <ResponseField name="isActive" type="boolean" required>
      Indica se o widget está ativo.
    </ResponseField>

    <ResponseField name="isActivated" type="boolean" required>
      Status de ativação do widget.
    </ResponseField>

    <ResponseField name="isFavorited" type="boolean">
      Indica se o widget está marcado como favorito.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="totalItems" type="number" required>
  Número total de itens.
</ResponseField>

<ResponseField name="widgetCount" type="number" required>
  Contagem total de widgets.
</ResponseField>

<ResponseField name="activeCount" type="number" required>
  Número de widgets ativos.
</ResponseField>

<ResponseField name="widgetLimit" type="number" required>
  Limite máximo de widgets.
</ResponseField>

## 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.