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

# Importar com Youtube

> Treine seu agente com vídeo do Youtube

## Token de Acesso

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

## Descrição da requisição

<Warning> Para melhor funcionamento é recomendado subir vídeo com no máximo **10 minutos** de duração.</Warning>

<ParamField body="unityId" type="uuid" required>
  Identificador único da unidade associada ao dataset.
</ParamField>

<ParamField body="datasetId" type="uuid" required>
  Identificador único do dataset onde as URLs serão adicionadas.
</ParamField>

<ParamField body="urls" type="string[]" required>
  Lista de URLs que serão processadas e adicionadas ao dataset.

  <Expandable title="URL item properties">
    <ParamField body="urls" type="string" required>
      URL do vídeo.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="folderId" type="string">
  Identificador da pasta onde os conteúdos ingeridos serão armazenados.
</ParamField>

## Descrição da Resposta

Abaixo você verá a descrição da resposta da requisição após a importação do vídeo do dataset

<ResponseField name="message" type="string" required>
  Mensagem indicando o resultado do upload do conteúdo do YouTube.
</ResponseField>

<ResponseField name="content" type="string">
  Conteúdo textual retornado pela operação, quando disponível.
</ResponseField>

<ResponseField name="folder" type="object">
  Informações da pasta onde os conteúdos foram armazenados.

  <Expandable title="Folder properties">
    <ResponseField name="isRoot" type="boolean" required>
      Indica se a pasta é a raiz da base de conhecimento.
    </ResponseField>

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

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

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

    <ResponseField name="knowLedgeBaseId" type="string" required>
      Identificador da base de conhecimento associada.
    </ResponseField>

    <ResponseField name="knowLedgeBaseFile" type="array">
      Lista de arquivos gerados a partir do conteúdo importado.

      <Expandable title="Knowledge base file properties">
        <ResponseField name="status" type="string" required>
          Status do processamento do arquivo.
        </ResponseField>

        <ResponseField name="id" type="string" required>
          Identificador do arquivo.
        </ResponseField>

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

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

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

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

        <ResponseField name="maskName" type="string">
          Nome mascarado do arquivo.
        </ResponseField>

        <ResponseField name="knowLedgeBaseId" type="string" required>
          Identificador da base de conhecimento associada.
        </ResponseField>

        <ResponseField name="kbFolderId" type="string">
          Identificador da pasta onde o arquivo foi armazenado.
        </ResponseField>

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

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

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

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

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

        <ResponseField name="integrationId" type="string">
          Identificador da integração associada.
        </ResponseField>

        <ResponseField name="statusDescription" type="string">
          Descrição detalhada do status do processamento.
        </ResponseField>

        <ResponseField name="category" type="string">
          Categoria do arquivo.
        </ResponseField>

        <ResponseField name="content" type="string">
          Conteúdo textual associado ao arquivo.
        </ResponseField>

        <ResponseField name="folder" type="object">
          Informações adicionais da pasta.
        </ResponseField>

        <ResponseField name="metadata" type="object">
          Metadados adicionais do arquivo.
        </ResponseField>

        <ResponseField name="sourcefile" type="string">
          Nome do arquivo de origem.
        </ResponseField>

        <ResponseField name="sourcepage" type="string">
          Página de origem do conteúdo.
        </ResponseField>

        <ResponseField name="summary" type="string">
          Resumo do conteúdo processado.
        </ResponseField>

        <ResponseField name="tags" type="array">
          Lista de tags associadas ao arquivo.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="urls" type="array">
  Lista de URLs processadas na requisição.
</ResponseField>

<ResponseField name="files" type="array">
  Lista de arquivos criados durante o processamento das URLs.

  <Expandable title="File properties">
    <ResponseField name="status" type="string" required>
      Status atual do processamento do arquivo.
    </ResponseField>

    <ResponseField name="id" type="string" required>
      Identificador do arquivo.
    </ResponseField>

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

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

    <ResponseField name="internalStorageUrl" type="string">
      URL interna do armazenamento do arquivo.
    </ResponseField>

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

    <ResponseField name="maskName" type="string">
      Nome mascarado do arquivo.
    </ResponseField>

    <ResponseField name="knowLedgeBaseId" type="string">
      Identificador da base de conhecimento.
    </ResponseField>

    <ResponseField name="kbFolderId" type="string">
      Identificador da pasta da base de conhecimento.
    </ResponseField>

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

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

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

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

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

    <ResponseField name="statusDescription" type="string">
      Descrição do status atual do processamento.
    </ResponseField>

    <ResponseField name="tags" type="array">
      Lista de tags associadas ao arquivo.
    </ResponseField>

    <ResponseField name="kbFolder" type="object">
      Informações da pasta associada ao arquivo.

      <Expandable title="KB Folder properties">
        <ResponseField name="isRoot" type="boolean" required>
          Indica se a pasta é raiz.
        </ResponseField>

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

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

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

        <ResponseField name="knowLedgeBaseId" type="string" required>
          Identificador da base de conhecimento associada.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</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.
