API referenceKnowledge BaseFolders

Create folder

Create a folder used for grouping documents together.

Headers

xi-api-keystringOptional

Request

This endpoint expects an object.
namestringRequired>=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.

minimum_frequency_daysintegerOptional1-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.

Response

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

Errors

422
Documents Create Folder Request Unprocessable Entity Error