Folders

Was this helpful?

List folder

List folders on a given workspace for a knowledge base.

get

/workspaces/{workspaceId}/content/folders

Path parameters

workspaceIdstringrequired

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

Limits the project of results to return

pageTokenstring · max: 8000

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

reverseboolean

Order in which to retrieve the results

parentFolderPathsstring[] | nullable

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

folderPathsstring[] | nullable

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

withSubFoldersboolean | nullable

Include subfolders for the currently requested folders

orderBystring

Special ordering setting for the result folders

Example: createdAt:asc

statusstring · enum | nullable

Filter folders based on status

Options: draft, active, inactive

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/content/folders'

200

404

422

429

{
  "results": [
    {
      "createdAt": "2025-02-21T18:03:09.887Z",
      "icon": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "parentFolderId": "123e4567-e89b-12d3-a456-426614174000",
      "path": "text",
      "slug": "text",
      "updatedAt": "2025-02-21T18:03:09.887Z",
      "status": "draft"
    }
  ],
  "nextPageToken": "text"
}

Create folder

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

post

/workspaces/{workspaceId}/content/folders

Path parameters

workspaceIdstringrequired

Body

iconstring · max: 256 | nullable

namestring · min: 1 · max: 256required

Folder name

parentFolderIdstring · uuid | nullable

ID of the folder to store the new folder

parentFolderPathstring | nullable

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'

Options: draft, active, inactive

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/content/folders' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","status":"draft"}'

201

404

409

422

429

{
  "createdAt": "2025-02-21T18:03:09.887Z",
  "icon": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "parentFolderId": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "slug": "text",
  "updatedAt": "2025-02-21T18:03:09.887Z",
  "status": "draft"
}

Created

Get folder

Get folders on a given workspace for a knowledge base.

get

/workspaces/{workspaceId}/content/folders/{contentPath}

Path parameters

workspaceIdstringrequired

contentPathstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/content/folders/{contentPath}'

200

404

422

429

{
  "createdAt": "2025-02-21T18:03:09.887Z",
  "icon": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "parentFolderId": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "slug": "text",
  "updatedAt": "2025-02-21T18:03:09.887Z",
  "status": "draft"
}

Delete folder

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

delete

/workspaces/{workspaceId}/content/folders/{contentPath}

Path parameters

workspaceIdstringrequired

contentPathstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/workspaces/{workspaceId}/content/folders/{contentPath}'

204

404

422

No body

Deleted

Update folder

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

patch

/workspaces/{workspaceId}/content/folders/{contentPath}

Path parameters

workspaceIdstringrequired

contentPathstringrequired

Body

iconstring · max: 256 | nullable

namestring

Folder name

statusstring · enum

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

Options: draft, active, inactive

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/workspaces/{workspaceId}/content/folders/{contentPath}' \
  --header 'Content-Type: application/json' \
  --data '{"status":"draft"}'

200

404

409

422

429

{
  "createdAt": "2025-02-21T18:03:09.887Z",
  "icon": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "parentFolderId": "123e4567-e89b-12d3-a456-426614174000",
  "path": "text",
  "slug": "text",
  "updatedAt": "2025-02-21T18:03:09.887Z",
  "status": "draft"
}

Updated