Endpoint
GET
/v1/stable/document-folder

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Response

200 - application/json

Returns every knowledge base folder in the environment, each with its ID, name, parent folder ID, and timestamps.

folders
object[]
required
StableDocumentFolder — see its attributes above
Endpoint
POST
/v1/stable/document-folder

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

name
string
required

The name of the folder.

Minimum length: 1 · Maximum length: 255
parentID
string

The ID of the folder to nest this folder in. Omit or pass null for a top-level folder.

Minimum length: 1

Response

201 - application/json

Returns the new folder with its generated ID, name, parent folder ID, and timestamps.

folder
object
required
StableDocumentFolder — see its attributes above
Endpoint
PATCH
/v1/stable/document-folder/{folderID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

folderID
string
required

The ID of the knowledge base folder to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

name
string

The name of the folder.

Minimum length: 1 · Maximum length: 255
parentID
string

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.

Minimum length: 1

Response

200 - application/json

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.

message
string
required

A human-readable message confirming the update.

Endpoint
DELETE
/v1/stable/document-folder/{folderID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

folderID
string
required

The ID of the knowledge base folder to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Response

200 - application/json

Confirms the folder was deleted. The body is a message only, so refetch the folder list to see it gone.

message
string
required

A human-readable message confirming the deletion.

Schemas

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.