クロールジョブを作成

指定した深さとページ数の上限で、指定URLをクロールするクロールジョブを作成します。

ヘッダー

xi-api-keystringオプション

リクエスト

This endpoint expects an object.
urlstring必須

ユーザーとのやり取りのためにエージェントがアクセスできるドキュメントページのURL。

max_pagesintegerオプション1-10000デフォルト値 1000

クロールするページの最大数(1~10,000)。デフォルトは1000です。

patternstring or nullオプション<=2048 characters

設定した場合、このパターンに一致するURLのみが含まれます。

sitemap_urlslist of strings or nullオプション

サイトマップからクロールするURLのリスト(任意。自動URL検出を上書きします)。

parent_folder_idstring or nullオプション

設定すると、作成されたドキュメントまたはフォルダは指定したフォルダ内に配置されます。

enable_auto_syncbooleanオプションデフォルト値 false

このURLドキュメントで自動同期を有効にするかどうか。

auto_removebooleanオプションデフォルト値 false

URLが利用できなくなった場合にドキュメントを自動削除するかどうか。自動同期が有効な場合にのみ適用されます。

auto_discoverbooleanオプションデフォルト値 false

自動同期中に、すでにクロール済みのページからリンクされている新しいページを自動的に検出して追加します。enable_auto_sync=trueが必要です。

minimum_frequency_daysinteger or nullオプション1-180

対象となる基盤ドキュメントを更新する最小頻度(日数)。実際の間隔はこれより短くなる場合がありますが、長くなることはありません。デフォルトは7で、親フォルダの頻度がより厳しい場合はそれに合わせて短縮されます。自動同期が有効な場合にのみ適用されます。

max_depthintegerオプションデフォルト値 3Deprecated

非推奨。このフィールドは何も行わず、将来のバージョンで削除されます。

レスポンス

成功レスポンス。

idstring
typeenumデフォルト値 discovery
許可された値:
root_folder_idstring
statusstring
created_atinteger
folder_pathlist of objectsオプション

ルートから親フォルダまでの、ルートフォルダにつながるフォルダパスセグメント。

エラー

422
Unprocessable Entity Error