创建爬取任务

创建爬取任务,以指定深度和页面限制爬取给定 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

Automatically discover and add new pages linked from already-crawled pages during auto-sync. Requires 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