快速开始Knowledge BaseDocuments

Create knowledge base document from URL

Create a knowledge base document generated by scraping the given webpage.

请求头

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.
namestring可选>=1 character

A custom, human-readable name for the document.

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.

minimum_frequency_daysinteger可选1-180

Minimum frequency (in days) at which the document is 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.

响应

Successful Response
idstring
namestring
folder_pathlist of objects可选
The folder path segments leading to this entity, from root to parent folder.

错误

422
Documents Create from URL Request Unprocessable Entity Error