For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Create a crawl job to crawl the given URL with specified depth and page limits.
ヘッダー
xi-api-keystringオプション
リクエスト
This endpoint expects an object.
urlstring必須
URL to a page of documentation that the agent will have access to in order to interact with users.
max_pagesintegerオプション1-10000デフォルト値 1000
Maximum number of pages to crawl (1-10,000), defaults to 1000.
patternstringオプション<=2048 characters
If set, only URLs that match this pattern are included.
sitemap_urlslist of stringsオプション
List of URLs to crawl from sitemap (optional, overrides automatic URL discovery).
parent_folder_idstringオプション
If set, the created document or folder will be placed inside the given folder.
enable_auto_syncbooleanオプションデフォルト値 false
Whether to enable auto-sync for this URL document.
auto_removebooleanオプションデフォルト値 false
Whether to automatically remove the document if the URL becomes unavailable. Only applicable when auto-sync is enabled.
auto_discoverbooleanオプションデフォルト値 false
Automatically discover and add new pages linked from already-crawled pages during auto-sync. Requires enable_auto_sync=true.
minimum_frequency_daysintegerオプション1-180
Minimum frequency (in days) at which the underlying eligible documents are refreshed. The actual interval may be shorter, never longer. Defaults to 7, tightened to the parent folder’s frequency if that is stricter. Only applicable when auto-sync is enabled.
max_depthintegerオプションデフォルト値 3Deprecated
Deprecated - this field is a no-op and will be removed in a future version.
レスポンス
Successful Response
idstring
typeenumデフォルト値 discovery
許可された値:
root_folder_idstring
statusstring
created_atinteger
folder_pathlist of objectsオプション
The folder path segments leading to the root folder, from root to parent folder.
エラー
422
Crawl Jobs Create Request Unprocessable Entity Error
