快速开始Knowledge BaseCrawl jobs

Create crawl job

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