Create knowledge base document from URL

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

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.
urlstringRequired
URL to a page of documentation that the agent will have access to in order to interact with users.
namestringOptional>=1 character

A custom, human-readable name for the document.

parent_folder_idstringOptional
If set, the created document or folder will be placed inside the given folder.
enable_auto_syncbooleanOptionalDefaults to false

Whether to enable auto-sync for this URL document.

auto_removebooleanOptionalDefaults to false

Whether to automatically remove the document if the URL becomes unavailable. Only applicable when auto-sync is enabled.

Response

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

Errors