Create folder

Create a folder to file top-level pages in, inside a project. Folders nest three levels deep.

POST/v1/w/{workspace}/folders

Send an Idempotency-Key. This may answer 202 while it waits for approval.

Path parameters

workspacestringrequired

Your workspace’s address name.

Headers

Idempotency-Keystring

8–100 characters. Repeat the same key and body to get the first outcome back instead of writing twice.

Body

idstring

namestringrequired

The folder’s name, 1 to 80 characters.

colorinteger

A colour from 1 to 8.

parentIdstring | null

Put it inside this folder.

projectstring

The project it belongs to: general, a product key, or a custom project’s id.

Response

folderobjectrequired

Details

Create a Pages folder in a product, General or a custom project. Folders nest up to three levels. Only top-level pages go in folders.

Since 2026-12. Errors are listed in Errors.

cURL

curl -X POST "https://api.olamma.sh/v1/w/your-workspace/folders" \
  -H "Authorization: Bearer $OLAMMA_KEY" \
  -H "Idempotency-Key: <unique key>" \
  -H "content-type: application/json" \
  -d '{
    "name": "Policies",
    "project": "general"
  }'

Response 201

{
  "folder": {
    "id": "<string>",
    "name": "<string>",
    "projectId": "<string>",
    "parentId": "<string>"
  }
}