Voiceflow bearer token
Document Folders
Organize documents into folders.
See Authentication for credentials and permissions.
Returns every folder that organizes the knowledge base's documents in one response; parentID nests a folder inside another and is null at the top level. Use a folder's id as folderID to file a document under it.
Authentication
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Response
Returns every knowledge base folder in the environment, each with its ID, name, parent folder ID, and timestamps.
Adds a folder to the knowledge base, at the top level or nested under another folder. Folders only organize documents; retrieval searches every document regardless of its folder.
Authentication
Voiceflow bearer token
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
The name of the folder.
The ID of the folder to nest this folder in. Omit or pass null for a top-level folder.
Response
Returns the new folder with its generated ID, name, parent folder ID, and timestamps.
Renames a knowledge base folder, moves it under another folder, or moves it to the top level. A moved folder takes its documents and subfolders with it, and a folder cannot be moved into itself or one of its own subfolders. The response carries only a confirmation message, so refetch the folders to read the new values.
Authentication
Voiceflow bearer token
Path parameters
The ID of the knowledge base folder to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
The name of the folder.
The ID of the folder to move this folder into, or null to move it to the top level. Omit it to keep the folder where it is.
Response
Confirms the folder was updated. The body is a message rather than the revised folder, so refetch the folder list to see its new name or parent.
A human-readable message confirming the update.
Deletes a knowledge base folder together with its subfolders and every document inside them. The response carries only a confirmation message, so refetch the folders and documents to see what is left.
Authentication
Voiceflow bearer token
Path parameters
The ID of the knowledge base folder to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Response
Confirms the folder was deleted. The body is a message only, so refetch the folder list to see it gone.
A human-readable message confirming the deletion.