Conversational AI

Create Folder

Changed on

Create a folder used for grouping documents together.

post/v1/convai/knowledge-base/folder

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/convai/knowledge-base/folder
  • Auth
    none declared

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.

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

Changes