Getting Started

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

A template is a reusable document model that standardizes content creation by defining a structure, formatting, and potentially dynamic variables.

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

Operation	Description
Create	Define a new template from structured Markdown content
Edit & Update	Update the structure or content of a template
Instantiate	Generate a document from a template with variables
Archive	Move the template to the Recycle Bin with the option to restore it if needed
Delete	Remove a template (with or without its contents, depending on settings)
Listing	Get the list of all available templates

The main objective of this API is to offer developers the ability to standardize and automate the creation of documents on a large scale, while ensuring visual and structural consistency.

Examples of use cases

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

Product documentation generation: a single template for all product sheets, with variables for name, description, and technical specifications.
Customized customer reports: automatic generation of weekly reports for hundreds of customers using the same template and variable data.
Guides and tutorials: reusable structure for all tutorials within the same category (introduction, prerequisites, steps, conclusion).
Form integration: a document is automatically generated from a predefined template each time a form is submitted.
There are countless use cases for you to leverage our APIs in your workflow.

Create New Template

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

curl -X POST "https://api.super-markdown.com/api/space/app/save-template/" \
  -H "app_auth: YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "title of template",
    "content_markdown": ":: title{id="" box_type="container-view" version="mode-classic" theme="orange-theme" font="sans-serif-font-heading" align="left-align" title="{{title}}"} :: title\n\n: content{id="" theme="orange-theme" mode="mode-simple" font="sans-serif-font-heading" align="align-left" box_type="container-view"}\n{{content}}\n\n:: content",
    "preview" : "URL_IMAGE_PREVIEW"
    
  }'

On this template we have declared 2 variables "title" & "content" which will be replaced by data when instantiating this template, which will guarantee consistency in the final results.

Expected response:

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


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

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

Edit & Update existing Template

curl -X POST "https://api.super-markdown.com/api/space/app/edit-folder/{UID_TEMPLATE}/" \
  -H "app_auth: YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "title of template updated",
    "content_markdown": ":: title{id="" box_type="container-view" version="mode-classic" theme="orange-theme" font="sans-serif-font-heading" align="left-align" title="{{title}}"} :: title\n\n: content{id="" theme="orange-theme" mode="mode-simple" font="sans-serif-font-heading" align="align-left" box_type="container-view"}\n{{content}}\n\n:: content",
    "preview" : "URL_IMAGE_PREVIEW"
    
  }'

Get Your Templates

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

Get Details of a specific Template

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

Create new Document from Template

curl -X POST "https://api.super-markdown.com/api/space/app/instantiate-template/{UID_TEMPLATE}//" \
  -H "app_auth: YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "title": "title of document",
      "content": "# Title of section\n\nLorem ipsum dolor sit amet."
    }
    
  }

Archive existing Template

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

Restores archived Template

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

Delete permanently existing Template

curl -X GET "https://api.super-markdown.com/api/space/app/delete-element/template/{UID_TEMPLATE}/" \
  -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

Template API