Get inspired at ContentCon. Learn more and register today
Get inspired at ContentCon. Learn more and register today
Contentstack.comAcademyLogin
CS-log-dark.svgCS-log-dark.svg
  • Changelog
  • APIs
  • SDKs

Platform

  • Solution Center
  • Marketplace
  • Changelog
  • Developers & IT
  • Business users
  • Digital leaders
  • Developer Fast Track
  • Plans & Pricing

Solutions

  • Retail
  • Travel and tourism
  • Financial services
  • Technology
  • Manufacturing
  • E-commerce
  • Localization
  • Personalization
  • Portals and knowledge bases

Resources

  • Academy
  • Docs
  • Product updates
  • Contentstack on Contentstack
  • Blog
  • Insights and analyst reports
  • Webinars
  • Podcasts
  • Glossary
  • Content generative library
  • Community
  • Headless CMS
  • Composable AXP
  • Personalization
  • CDP

Customers

  • Case Studies
  • Customer Care
  • Contentstack Experience Awards
  • Customer support

Partners

  • Overview
  • Find a partner
  • Login

Company

  • About us
  • News
  • Customer support portal
  • Contact

Social

  • Facebook
  • LinkedIn
  • Instagram
  • GitHub
  • YouTube
  • Discord
  • X
LegalTermsPrivacyTrust Center

Cookie settings

Copyright © 2026 Contentstack Inc. All rights reserved.
/
  1. Home
  2. APIs
  3. Knowledge Vault API
  4. Folder Management

Folder Management

markdownView as Markdown

Folder Management provides APIs to organize and maintain your folder structure within Knowledge Vault. You can create folders, retrieve all folders, view items inside a folder, update folder details, move folders or items, and delete folders.

Create Folder

POSThttps://ai.contentstack.com/brand-kits/v1/knowledge-vault/folders

The Create Folder request lets you create a new folder within a specified parent directory in your knowledge vault.

To configure the permissions for your app via OAuth, include the brand-kits:manage scope.

Example:

{
  "name": "AI for Advanced Users",
  "path": "/dir0000000000000"
}

The name and path are required strings where name specifies the new folder’s name and path provides the parent folder UID where the new folder will be created.

NoteRoot folder UID is dir0000000000000.

Sample Request
1234
{
  "name": "AI for Advanced Users",
  "path": "/dir0000000000000"
}
Sample Response
Status|201 Created
1234
{
   "message": "Folder created successfully",
   "folder_uid": "dir************"
}

Get All Folders

GEThttps://ai.contentstack.com/brand-kits/v1/knowledge-vault/folders?limit={limit}&sort={sort_field}&skip={skip}&order={asc|desc}

The Get All Folders request retrieves a paginated list of all folders within the Knowledge Vault for a specified brand kit. You can apply filters such as sorting, pagination, and the inclusion of user metadata in the response.

To configure the permissions for your app via OAuth, include the brand-kits:read scope.

Sample Response
Status|200 OK
12345678910111213141516171819202122232425262728293031323334353637383940414243
{
   "documents": [
       {
           "folder_uid": "dir0000000000000",
           "organization_uid": "blt*************",
           "brand_kit_uid": "cs************",
           "created_at": "2025-11-30 09:31:29.864609",
           "created_by": "blt*************",
           "updated_at": "2025-11-30 09:31:29.864619",
           "updated_by": "blt*************",
           "deleted_at": false,
           "type": "folder",
           "name": "Root",
           "path": "/"
       },
       {
           "folder_uid": "dir************",
           "organization_uid": "blt57de41ea4319272c",
           "brand_kit_uid": "cs************",
           "created_at": "2025-11-30 09:32:18.992813",
           "created_by": "blt*************",
           "updated_at": "2025-11-30 09:33:26.411742",
           "updated_by": "blt*************",
           "deleted_at": false,
           "type": "folder",
           "name": "AI for Beginners",
           "path": "/dir0000000000000"
       },
       {
           "folder_uid": "dir************",
           "organization_uid": "blt*************",
           "brand_kit_uid": "cs************",
           "created_at": "2025-11-30 09:41:05.895270",
           "created_by": "blt*************",
           "updated_at": "2025-11-30 09:41:05.895281",
           "updated_by": "blt*************",
           "deleted_at": false,
           "type": "folder",
           "name": "AI for Advanced Users",
           "path": "/dir0000000000000"
       }
   ]
}

Get Items in Folder

GEThttps://ai.contentstack.com/brand-kits/v1/knowledge-vault/folders/{folder_uid}?folder_depth={number}&limit={limit}&skip={index}&sort={string}&order={string}&date_range={dateRange}&filter_users={string}&filter_field={string}&include_users={boolean}&typeahead={string}

The Get Items in Folder request retrieves all items contained within a specific folder in the Knowledge Vault of a brand kit.

To configure the permissions for your app via OAuth, include the brand-kits:read scope.

Sample Response
Status|200 OK
12345678910111213141516171819202122232425262728293031323334353637383940
{
   "documents": [
       {
           "content_uid": "cs************",
           "content": "AI Tools for Beginners\nArtificial intelligence has become part of everyday life, and a growing number of easy to use tools make it accessible to everyone, even complete beginners. These tools help with writing, image creation, data organization, and productivity without requiring any technical background.\n1. Writing Assistants: AI writing assistants such as ChatGPT and Grammarly help users brainstorm ideas, correct grammar, and improve writing style. They are great for students, professionals, and anyone who wants to produce content faster.\n2. Image Generation Tools: Beginner friendly image generators like Canva AI or Adobe Firefly allow users to create attractive visuals from simple prompts. These tools help with social media graphics, blog illustrations, and creative projects.\n3. AI Productivity Tools: Tools such as Notion AI, Otter.ai, or Google Gemini assist with summarizing notes, generating task lists, and automating repetitive work. They save time and help users stay organized.\n4. AI Video and Audio Tools: Platforms like Descript and CapCut use AI to simplify audio/video editing, enabling beginners to create professional looking content with minimal effort. \n\nAI tools are becoming more intuitive and accessible, empowering anyone to work smarter and explore creativity in new ways. As AI continues to evolve, these beginner friendly tools will make learning and productivity even easier.",
           "deleted_at": false,
           "organization_uid": "blt*************",
           "brand_kit_uid": "cs************",
           "created_at": "2025-11-30 09:33:00.345900",
           "created_by": "blt*************",
           "updated_at": "2025-11-30 09:33:00.345910",
           "updated_by": "blt*************",
           "_metadata": {
               "tags": [],
               "title": "AI Tools for Beginners: Writing, Image, and Productivity",
               "file": {
                   "name": "AI_Tools_for_Beginners.pdf",
                   "size": 2669,
                   "type": "app/pdf"
               },
               "source": "UI"
           },
           "type": "entry",
           "path": "/dir0000000000000/dir************"
       }
   ],
   "current_folder": {
       "folder_uid": "dir************",
       "organization_uid": "blt*************",
       "brand_kit_uid": "cs************",
       "created_at": "2025-11-30 09:32:18.992813",
       "created_by": "blt*************",
       "updated_at": "2025-11-30 09:33:26.411742",
       "updated_by": "blt*************",
       "deleted_at": false,
       "type": "folder",
       "name": "AI for Beginners",
       "path": "/dir0000000000000"
   }
}

Update Folder

PUThttps://ai.contentstack.com/brand-kits/v1/knowledge-vault/folders/{folder_uid}

The Update Folder request lets you rename an existing folder in the Knowledge Vault of a brand kit.

To configure the permissions for your application via OAuth, include the brand-kits:manage scope.

Example:

{
  "name": "AI for Business Leaders"
}
Sample Request
123
{
  "name": "AI for Business Leaders"
}
Sample Response
Status|200 OK
123
{
   "message": "Folder name updated successfully"
}

Move Items to Folder

PUThttps://ai.contentstack.com/brand-kits/v1/knowledge-vault/folders/{folder_uid}/move-items

The Move Items to Folder request lets you move multiple items into a specified folder within the Knowledge Vault of a brand kit.

To configure the permissions for your app via OAuth, include the brand-kits:manage scope.

Example:

{
   "content_uids": [
       "cs**************",
       "cs**************"
   ]
}

The content_uids holds the list of content item UIDs to move into another folder.

Sample Request
123456
{
   "content_uids": [
       "cs**************",
       "cs**************"
   ]
}
Sample Response
Status|200 OK
12345
{
   "message": "Items moved successfully",
   "updated_count": 2,
   "elapsed_time": 0.033
}

Delete Folder

DELETEhttps://ai.contentstack.com/brand-kits/v1/knowledge-vault/folders/{folder_uid}

The Delete Folder request permanently deletes a specified folder from the Knowledge Vault in a brand kit.

To configure the permissions for your app via OAuth, include the brand-kits:manage scope.

Sample Response
Status|200 OK
123
{
  "message": "Folder deleted successfully.",
}
Hide Parameters

Headers

authtokenrequiredstring

Enter the authtoken.

Example:

your_authtoken
authorizationrequiredstring

Enter your OAuth token. Learn more about Authentication.

Example:

[Bearer <OAuth token>]
organization_uidrequiredstring

Enter the Organization UID.

Example:

your_organization_uid
brand_kit_uidrequiredstring

Enter the Brand Kit UID.

Example:

your_brand_kit_uid
Hide Parameters

Query Parameters

limitoptionalstring

Enter the maximum number of folders to return.

Example:

10
sortoptionalstring

Enter the value on the basis of which you want to sort your folders.

Example:

created_at
skipoptionalstring

Enter the number of folders to be skipped from the response body.

Example:

0
orderoptionalstring

Enter the ascending or descending order to organize the folders.

Example:

asc

Headers

authtokenrequiredstring

Enter the authtoken.

Example:

your_authtoken
authorizationrequiredstring

Enter your OAuth token. Learn more about Authentication.

Example:

[Bearer <OAuth token>]
organization_uidrequiredstring

Enter the Organization UID.

Example:

your_organization_uid
brand_kit_uidrequiredstring

Enter the Brand Kit UID.

Example:

your_brand_kit_uid
Hide Parameters

URL Parameters

folder_uidrequiredstring

Enter the parent folder UID.

Example:

dir0000000000000

Query Parameters

limitoptionalstring

Enter the maximum number of content items to return.

Example:

10
skipoptionalstring

Enter the number of content items to be skipped from the response body.

Example:

0
sortoptionalstring

Enter the value on the basis of which you want to sort your content items.

Example:

created_at
orderoptionalstring

Enter the ascending or descending order to organize your content items.

Example:

asc
include_usersoptionalstring

This parameter lets you include user information in the response. Set to true if you want to include the user information, else set to false.

Example:

false
folder_depthoptionalstring

Number of folder levels to traverse (1 = only direct children).

Example:

1
date_rangeoptionalstring

You can filter the response by date range. The format must be YYYY-MM-DD.

Example:

2025-12-01
filter_users optionalstring

You can filter the response based on the comma-separated user UIDs.

filter_fieldoptionalstring

You can filter the response based on the user fields like created or updated.

typeaheadoptionalstring

Text-based search across content item title or name.

Example:

AI Tools

Headers

authtokenrequiredstring

Enter the authtoken.

Example:

your_authtoken
authorizationrequiredstring

Enter your OAuth token. Learn more about Authentication.

Example:

[Bearer <OAuth token>]
organization_uidrequiredstring

Enter the Organization UID.

Example:

your_organization_uid
brand_kit_uidrequiredstring

Enter the Brand Kit UID.

Example:

your_brand_kit_uid
Hide Parameters

URL Parameters

older_uidrequiredstring

Enter the UID of the folder to be updated.

Example:

your_folder_uid

Headers

authtokenrequiredstring

Enter the authtoken.

Example:

your_authtoken
authorizationrequiredstring

Enter your OAuth token. Learn more about Authentication.

Example:

[Bearer <OAuth token>]
organization_uidrequiredstring

Enter the Organization UID.

Example:

your_organization_uid
brand_kit_uidrequiredstring

Enter the Brand Kit UID.

Example:

your_brand_kit_uid
Hide Parameters

URL Parameters

folder_uid requiredstring

Enter the UID of the folder where the items will be moved.

Example:

your_folder_uid

Headers

authtokenrequiredstring

Enter the authtoken.

Example:

your_authtoken
authorizationrequiredstring

Enter your OAuth token. Learn more about Authentication.

Example:

[Bearer <OAuth token>]
organization_uidrequiredstring

Enter the Organization UID.

Example:

your_organization_uid
brand_kit_uidrequiredstring

Enter the Brand Kit UID.

Example:

your_brand_kit_uid
Hide Parameters

URL Parameters

folder_uidrequiredstring

Enter the UID of the folder to be deleted.

Example:

your_folder_uid

Headers

authtokenrequiredstring

Enter the authtoken.

Example:

your_authtoken
authorizationrequiredstring

Enter your OAuth token. Learn more about Authentication.

Example:

[Bearer <OAuth token>]
organization_uidrequiredstring

Enter the Organization UID.

Example:

your_organization_uid
brand_kit_uidrequiredstring

Enter the Brand Kit UID.

Example:

your_brand_kit_uid