Sign in
latestOpenAPI 3.1.02026-08-213871,4702.0 MB

1a31d01a1fb9

Conversational AI

Create Folder

Create a folder used for grouping documents together.

post/v1/convai/knowledge-base/folder

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

namestring required

A custom, human-readable name for the document.

parent_folder_idstring nullable

If set, the created document or folder will be placed inside the given folder.

enable_auto_syncboolean

Whether to enable auto-sync for this URL document.

auto_removeboolean

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

minimum_frequency_daysinteger nullable

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 required
namestring required