Getting Started

The Folder API allows you to manage all your folders programmatically, without having to log in to your Super Markdown workspace via the web interface.

This API exposes a set of essential operations for manipulating your folders remotely:

Operation	Description
Create	Add a new folder to the location of your choice
Edit & Update	Update the properties of an existing folder
Rename	Change the name of a folder without affecting its contents
Archive	Move the folder to the Recycle Bin with the option to restore it if needed
Delete	Remove a folder (with or without its contents, depending on settings)
Listing	Retrieve the complete tree of your folders existing in your workspace

The main objective of this API is to offer developers complete autonomy in managing their folder structure, by integrating this management directly into their automation pipelines.

Examples of use cases

Here are some concrete examples of automation made possible by these APIs:

Synchronization with an external system: Your CRM or project management tool automatically creates a folder for each project.
Automated cleanup: Scheduled deletion of obsolete folders after a certain period or a specific event.
Dynamic organization: Creation of folders by period (year/month/week) at regular intervals via a scheduled script (cron job).
CI/CD pipeline: Creation of a standardized folder hierarchy for each new application project.
There are countless use cases for you to leverage our APIs in your workflow.

Create New Folder

Here is a concrete example of an API call to create a new folder:

curl -X POST "https://api.super-markdown.com/api/space/app/save-folder/" \
  -H "app_auth: YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Projet Alpha",
    "description": "Description of projet alpha",
    "goal" : "collaboration",
    "color": "#ff4000",
    "parent": "-"
    
  }'

Expected response:

If successful, the API returns a JSON response structured as follows:


{
  "status": "success",
  "code": 200,
  "message": "Success!",
  "data": {
    "uid": "UID_OF_FOLDER_CREATED",
    "message": "ok"
  }
}

Each transaction is recorded as an activity that you can retrieve for auditing if needed.

Edit & Update existing Folder

curl -X POST "https://api.super-markdown.com/api/space/app/edit-folder/{UID_FOLDER}/" \
  -H "app_auth: YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Projet Beta",
    "description": "Description of projet beta",
    "goal" : "knowledge",
    "color": "#ff4000",
    "parent": "-"
    
  }'

Rename existing Folder

curl -X POST "https://api.super-markdown.com/api/space/app/rename-folder/{UID_FOLDER}/" \
  -H "app_auth: YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Projet Beta"
  }'

Get Your Folders

curl -X GET "https://api.super-markdown.com/api/space/app/get-my-folders/" \
  -H "app_auth: YOUR_KEY_HERE" \
  -H "Content-Type: application/json"

Get Details of a specific Folder

curl -X GET "https://api.super-markdown.com/api/space/app/get-folder/{UID_FOLDER}//" \
  -H "app_auth: YOUR_KEY_HERE" \
  -H "Content-Type: application/json"

The data in the obtained file contains the subfolders and documents that the file possesses; take this information into consideration when processing them.

Archive existing Folder

curl -X GET "https://api.super-markdown.com/api/space/app/archive-element/folder/{UID_FOLDER}/" \
  -H "app_auth: YOUR_KEY_HERE" \
  -H "Content-Type: application/json"

Restores archived Folder

curl -X GET "https://api.super-markdown.com/api/space/app/restaure-element/folder/{UID_FOLDER}/" \
  -H "app_auth: YOUR_KEY_HERE" \
  -H "Content-Type: application/json"

Delete permanently existing Folder

curl -X GET "https://api.super-markdown.com/api/space/app/delete-element/folder/{UID_FOLDER}/" \
  -H "app_auth: YOUR_KEY_HERE" \
  -H "Content-Type: application/json"

Please take into consideration the handling of errors that occur at the validation level, non-compliant data sent, data not found or other.

What's Next ?

LLM Integration : Getting Started with LLM Integration
AI Agent Support : Getting Started with AI Agent Support
Fréquents Questions : A collection of frequently asked questions related to the platform
Integration with GitHub : Super Markdown offering GitHub users an additional presentation layer.

Need help ? Our team is here to support you. Contact us or check our FAQ.

Getting Started

Layout Components Reference

Components Reference

Super Markdown API

Examples

LLM Integration

Agents IA Support

Github Integration

Color Themes

Icons

Custom Templates

Best Practices

Fréquents Questions

Folder API