> ## 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 Base de Conhecimento por Unidade

> Endpoint para obter todas as Bases de Conhecimento de uma Unidade

## Token de Acesso

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

## Descrição do Body

<ParamField path="id" type="string" required="true" placeholder="Enter with UnityId">
  ID da unidade
</ParamField>

### Descrição da Resposta

A resposta do endpoint retorna um JSON com a confirmação da solicitação.

<ResponseField name="items" type="array" required>
  Lista de Bases de Conhecimento.

  <Expandable title="Item properties">
    <ResponseField name="id" type="string" required>
      Identificador único da Base de Conhecimento.
    </ResponseField>

    <ResponseField name="unityId" type="string" required>
      Identificador da unidade associada.
    </ResponseField>

    <ResponseField name="kbCreatorId" type="string" required>
      ID do criador da Base de Conhecimento.
    </ResponseField>

    <ResponseField name="kbInstitutionId" type="string" required>
      Identificador da instituição proprietária da Base de Conhecimento.
    </ResponseField>

    <ResponseField name="kbStatus" type="number" required>
      Status da Base de Conhecimento (ex: 1 para ativa).
    </ResponseField>

    <ResponseField name="kbName" type="string" required>
      Nome da Base de Conhecimento.
    </ResponseField>

    <ResponseField name="kbDescription" type="string">
      Descrição da Base de Conhecimento.
    </ResponseField>

    <ResponseField name="kbIconImg" type="string">
      URL do ícone da Base de Conhecimento.
    </ResponseField>

    <ResponseField name="kbFolder" type="array">
      Lista de pastas dentro da Base de Conhecimento.

      <Expandable title="Folder properties">
        <ResponseField name="id" type="string" required>
          Identificador único da pasta.
        </ResponseField>

        <ResponseField name="name" type="string" required>
          Nome da pasta.
        </ResponseField>

        <ResponseField name="knowLedgeBaseId" type="string" required>
          ID da Base de Conhecimento associada.
        </ResponseField>

        <ResponseField name="isRoot" type="boolean" required>
          Indica se a pasta é raiz.
        </ResponseField>

        <ResponseField name="institutionId" type="string" required>
          ID da instituição proprietária da pasta.
        </ResponseField>

        <ResponseField name="knowLedgeBaseFile" type="array">
          Lista de arquivos na pasta.

          <Expandable title="File properties">
            <ResponseField name="id" type="string" required>
              Identificador único do arquivo.
            </ResponseField>

            <ResponseField name="createdAt" type="string" required>
              Data/hora de criação do arquivo.
            </ResponseField>

            <ResponseField name="updatedAt" type="string">
              Data/hora da última atualização do arquivo.
            </ResponseField>

            <ResponseField name="institutionId" type="string" required>
              ID da instituição proprietária do arquivo.
            </ResponseField>

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

            <ResponseField name="internalStorageUrl" type="string" required>
              URL de armazenamento interno do arquivo.
            </ResponseField>

            <ResponseField name="url" type="string" required>
              URL pública do arquivo.
            </ResponseField>

            <ResponseField name="size" type="number" required>
              Tamanho do arquivo em bytes.
            </ResponseField>

            <ResponseField name="extension" type="string" required>
              Extensão do arquivo.
            </ResponseField>

            <ResponseField name="maskName" type="string">
              Nome da máscara do arquivo.
            </ResponseField>

            <ResponseField name="integrationId" type="string">
              ID da integração associada ao arquivo (se houver).
            </ResponseField>

            <ResponseField name="customData" type="array">
              Metadados personalizados associados ao arquivo.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="_count" type="object">
          Detalhes de contagem para a pasta.

          <Expandable title="Count properties">
            <ResponseField name="knowLedgeBaseFile" type="number" required>
              Número de arquivos na pasta.
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="documentsInfo" type="object">
      Resumo dos documentos na Base de Conhecimento.

      <Expandable title="Document info properties">
        <ResponseField name="size" type="number" required>
          Tamanho total dos documentos em bytes.
        </ResponseField>

        <ResponseField name="documentCount" type="number" required>
          Número total de documentos.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="isActivated" type="boolean" required>
      Indica se a Base de Conhecimento está ativada.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="knowledgeBaseCount" type="number" required>
  Número total de Bases de Conhecimento.
</ResponseField>

<ResponseField name="activeCount" type="number" required>
  Número de Bases de Conhecimento ativas.
</ResponseField>

<ResponseField name="knowledgeBaseLimit" type="number" required>
  Limite máximo de Bases de Conhecimento permitidas.
</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.

### Código de Resposta

Exemplos de erro de segurança

<Expandable title="error 🚦">
  <ResponseField name="200" type="string">
    Resposta de sucesso da requisição
  </ResponseField>

  <ResponseField name="500" type="string">
    Falha na requisição
  </ResponseField>
</Expandable>