ナビゲーションにスキップ

Add Url Source

Add a URL as a knowledge source

ヘッダー

xi-api-keystringオプション
xi-workspace-idstring or nullオプション
The customer workspace a reseller's API key acts on.

リクエスト

This endpoint expects an object.
urlstring必須形式: "uri"1-2048 characters
crawl_entire_sitebooleanオプションデフォルト値 false

レスポンス

成功レスポンス。

_idstring
source_typeenumオプションデフォルト値 file
Type of knowledge source.
許可された値:
source_urlstring or nullオプション
last_scraped_at_unixinteger or nullオプション
original_filenamestringオプションデフォルト値
content_typestringオプションデフォルト値
file_size_bytesintegerオプションデフォルト値 0
statusenumオプションデフォルト値 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.

許可された値:
error_messagestring or nullオプション
failure_reasonenum or nullオプション
Why processing a knowledge source failed.
crawl_entire_sitebooleanオプションデフォルト値 false
scraped_pages_countintegerオプションデフォルト値 0
content_previewstring or nullオプション
processing_started_at_unixinteger or nullオプション
created_at_unixintegerオプション

Unix timestamp (seconds since epoch)

updated_at_unixintegerオプション

Unix timestamp (seconds since epoch)

エラー

422
Unprocessable Entity Error