Zur Navigation springen
ReceptionKnowledge Sources

Add Url Source

Add a URL as a knowledge source

Header

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

Anfrage

This endpoint expects an object.
urlstringErforderlichFormat: "uri"1-2048 characters
crawl_entire_sitebooleanOptionalStandardwert ist false

Antwort

Erfolgreiche Antwort
_idstring
source_typeenumOptionalStandardwert ist file
Type of knowledge source.
Erlaubte Werte:
source_urlstring or nullOptional
last_scraped_at_unixinteger or nullOptional
original_filenamestringOptionalStandardwert ist
content_typestringOptionalStandardwert ist
file_size_bytesintegerOptionalStandardwert ist 0
statusenumOptionalStandardwert ist 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.

Erlaubte Werte:
error_messagestring or nullOptional
failure_reasonenum or nullOptional
Why processing a knowledge source failed.
crawl_entire_sitebooleanOptionalStandardwert ist false
scraped_pages_countintegerOptionalStandardwert ist 0
content_previewstring or nullOptional
processing_started_at_unixinteger or nullOptional
created_at_unixintegerOptional

Unix timestamp (seconds since epoch)

updated_at_unixintegerOptional

Unix timestamp (seconds since epoch)

Fehler

422
Unprocessable Entity Error