Importar conteúdo web

Treine seu agente com sites da internet

POST /api/v2/extractor/upload-web-scraper

Importar conteúdo web

cURL

curl --request POST \
  --url https://chat.api.toolzz.com.br/api/v2/extractor/upload-web-scraper \
  --header 'Content-Type: application/json' \
  --data '
{
  "unityId": "<string>",
  "datasetId": "<string>",
  "folderId": "<string>",
  "url": "<string>",
  "limit": 123
}
'

200

{
  "message": "<string>",
  "folder": {
    "id": "<string>",
    "name": "<string>",
    "isRoot": true,
    "knowLedgeBaseId": "<string>"
  },
  "urls": [
    {}
  ],
  "files": [
    {
      "id": "<string>",
      "status": "<string>",
      "fileName": "<string>",
      "maskName": "<string>",
      "url": "<string>",
      "size": 123,
      "extension": "<string>",
      "createdAt": "<string>",
      "kbFolder": {
        "name": "<string>"
      }
    }
  ]
}

Token de Acesso

Authorization · string

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

Descrição da requisição

Alguns sites poderão ser bloqueados e a não poderão ser usados para treinamento.

unityId · uuid · required

Identificador único da unidade associada à base de conhecimento.

datasetId · uuid · required

Identificador do dataset onde o conteúdo será armazenado.

folderId · uuid · required

Identificador da pasta do dataset onde o conteúdo será armazenado.

url · string · required

URL da página que será processada e importada para o dataset.

limit · number

Limite máximo de páginas ou conteúdos que serão processados a partir da URL informada.

Descrição da Resposta

Abaixo você verá a descrição da resposta da requisição após a importação de conteúdo web

message · string · required

Mensagem de confirmação do status da operação.

folder · object

Informações sobre a pasta onde o conteúdo foi armazenado.

Show Propriedades de folder

id · string

Identificador único da pasta.

name · string

Nome da pasta de destino.

isRoot · boolean

Indica se a pasta é o diretório raiz.

knowLedgeBaseId · string

ID da base de conhecimento vinculada.

urls · array

Lista das URLs que foram processadas para extração de conteúdo.

files · array

Lista de objetos representando os arquivos gerados a partir do conteúdo web.

Show Propriedades de cada item em files

id · string

Identificador único do arquivo gerado.

status · string

Estado atual do processamento (ex: PENDING, SUCCESS).

fileName · string

Nome técnico do arquivo no armazenamento interno.

maskName · string

Nome amigável ou exibido para o usuário, geralmente contendo a URL de origem.

url · string

Link público para acessar o conteúdo extraído.

size · number

Tamanho do arquivo em bytes.

extension · string

Extensão do arquivo gerado (ex: txt).

createdAt · string

Data e hora da criação do registro.

kbFolder · object

Detalhes da pasta associada ao arquivo específico.

Show Detalhes de kbFolder

name · string

Nome da pasta associada.

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.