Build
Folders
Using folders to organize entities hierarchically within collections.
Overview
Folders provide hierarchical organization within a collection. They use contains/parent relationship pairs to form a tree structure.
Creating a Folder
POST /entities
{
"type": "folder",
"properties": {
"name": "Research Papers"
},
"collection_id": "01JCOL...",
"relationships": [
{ "predicate": "parent", "peer": "01JPARENT_FOLDER..." }
]
}Folder Contents
List the contents of a folder:
GET /folders/:id/contents
Authorization: Bearer <token>Returns all entities that have a parent relationship pointing to this folder.
Nesting
Folders can be nested to any depth. The hierarchy is maintained through relationship pairs:
- The child has a
parentrelationship pointing up - The parent has a
containsrelationship pointing down