Ir para a navegação
ReceptionKnowledge Sources

Add Url Source

Add a URL as a knowledge source

Cabeçalhos

xi-api-keystringOpcional
xi-workspace-idstring or nullOpcional
The customer workspace a reseller's API key acts on.

Solicitação

This endpoint expects an object.
urlstringObrigatórioformat: "uri"1-2048 characters
crawl_entire_sitebooleanOpcionalPadrão é false

Resposta

Resposta bem-sucedida

_idstring
source_typeenumOpcionalPadrão é file
Type of knowledge source.
Valores permitidos:
source_urlstring or nullOpcional
last_scraped_at_unixinteger or nullOpcional
original_filenamestringOpcionalPadrão é
content_typestringOpcionalPadrão é
file_size_bytesintegerOpcionalPadrão é 0
statusenumOpcionalPadrão é processing

Processing status for knowledge sources.

  • processing: the file or site is being read.
  • ready: done; the results are available.
  • error: it failed and can be retried.

See progress for detail.

Valores permitidos:
error_messagestring or nullOpcional
failure_reasonenum or nullOpcional
Why processing a knowledge source failed.
crawl_entire_sitebooleanOpcionalPadrão é false
scraped_pages_countintegerOpcionalPadrão é 0
content_previewstring or nullOpcional
processing_started_at_unixinteger or nullOpcional
created_at_unixintegerOpcional

Unix timestamp (seconds since epoch)

updated_at_unixintegerOpcional

Unix timestamp (seconds since epoch)

Erros

422
Unprocessable Entity Error