Skip to main content
POST
Create folder

Authorizations

Authorization
string
header
default:<auth-token>
required

Your API token, sent raw (no Bearer prefix).

Body

application/json
name
string
required

Must be unique among the folders next to it.

Required string length: 1 - 80
Example:

"Pricing"

parentId
string | null

The folder to create it in. Leave it out for a top-level folder. Folders nest up to 5 levels deep.

Example:

"f4p9z"

Response

The new folder.

folderId
string
Example:

"f4p9z"

name
string
Example:

"Product docs"

parentId
string | null
depth
integer

1 for a top-level folder.

docCount
integer

Knowledge bases directly in this folder.

totalDocCount
integer

Knowledge bases in this folder and its subfolders.

createdAt
string<date-time>
updatedAt
string<date-time>