Folders

Was this helpful?

Get folder

get

Get folders on a given workspace for a knowledge base.

Path parameters

workspaceIdstringRequired

contentPathstringRequired

Responses

200

application/json

404

Folder not found

application/json

422

Validation error

application/json

429

Too many requests

application/json

get

GET /workspaces/{workspaceId}/content/folders/{contentPath} HTTP/1.1
Host: 
Accept: */*

{
  "createdAt": "2025-06-18T12:29:20.891Z",
  "icon": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "parentFolderId": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "slug": "text",
  "status": "draft",
  "updatedAt": "2025-06-18T12:29:20.891Z"
}

Delete folder

delete

Delete a folder on a given workspace for a knowledge base.

Path parameters

workspaceIdstringRequired

contentPathstringRequired

Responses

204

Deleted

404

Folder not found

application/json

422

Validation error

application/json

delete

DELETE /workspaces/{workspaceId}/content/folders/{contentPath} HTTP/1.1
Host: 
Accept: */*

No content

List folder

get

List folders on a given workspace for a knowledge base.

Path parameters

workspaceIdstringRequired

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the project of results to return

Default: 10

pageTokenstring · max: 8000Optional

Pagination token that keeps of track of the current position in the list

reversebooleanOptional

Order in which to retrieve the results

Default: false

parentFolderPathsstring[] | nullableOptional

Paths of the parent folders. This can be used to narrow search to a specific folder

folderPathsstring[] | nullableOptional

Paths of the folders. This can be used to narrow search to a specific set of folder paths

withSubFoldersboolean | nullableOptional

Include subfolders for the currently requested folders

orderBystringOptional

Special ordering setting for the result folders

Example: createdAt:asc

statusstring · enum | nullableOptional

Filter folders based on status

Possible values:

Responses

200

application/json

Responseall of

and

404

Folder not found

application/json

422

Validation error

application/json

429

Too many requests

application/json

get

GET /workspaces/{workspaceId}/content/folders HTTP/1.1
Host: 
Accept: */*

{
  "results": [
    {
      "createdAt": "2025-06-18T12:29:20.891Z",
      "icon": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "parentFolderId": "123e4567-e89b-12d3-a456-426614174000",
      "path": "text",
      "slug": "text",
      "status": "draft",
      "updatedAt": "2025-06-18T12:29:20.891Z"
    }
  ],
  "nextPageToken": "text"
}

Create folder

post

Create a folder on a given workspace for a knowledge base.

Path parameters

workspaceIdstringRequired

Body

iconstring | nullableOptional

namestring · min: 1 · max: 256Required

Folder name

parentFolderIdstring · uuid | nullableOptional

ID of the folder to store the new folder

parentFolderPathstring | nullableOptional

Path of the folder to store the new folder

statusstring · enumRequired

Status of the folder. If you want your documents to be visible and used by other systems, make it 'active'

Possible values:

Responses

201

Created

application/json

404

Parent Folder Not found

application/json

409

Conflict

application/json

422

Validation error

application/json

429

Too many requests

application/json

post

POST /workspaces/{workspaceId}/content/folders HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "icon": "text",
  "name": "text",
  "parentFolderId": "123e4567-e89b-12d3-a456-426614174000",
  "parentFolderPath": "text",
  "status": "draft"
}

{
  "createdAt": "2025-06-18T12:29:20.891Z",
  "icon": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "parentFolderId": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "slug": "text",
  "status": "draft",
  "updatedAt": "2025-06-18T12:29:20.891Z"
}

Update folder

patch

Update a folder on a given workspace for a knowledge base.

Path parameters

workspaceIdstringRequired

contentPathstringRequired

Body

iconstring | nullableOptional

namestringOptional

Folder name

statusstring · enumOptional

Status of the folder. If you want your documents to be visible and used by other systems, make it 'active'

Possible values:

Responses

200

Updated

application/json

404

Folder not found

application/json

409

Conflict

application/json

422

Validation error

application/json

429

Too many requests

application/json

patch

PATCH /workspaces/{workspaceId}/content/folders/{contentPath} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "icon": "text",
  "name": "text",
  "status": "draft"
}

{
  "createdAt": "2025-06-18T12:29:20.891Z",
  "icon": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "parentFolderId": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "slug": "text",
  "status": "draft",
  "updatedAt": "2025-06-18T12:29:20.891Z"
}