Getting Started

The Utils API brings together a set of useful functions and complementary tools that work alongside the other API categories (Folder, Document, Template, Media). It offers valuable services for validating, transforming, and analyzing Markdown content.

This API allows you to interact with the Super Markdown system programmatically to perform technical operations without having to directly manipulate your documents or folders.

Examples of use cases

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

Pre-validation: Before creating or modifying a document, verify that the Markdown syntax is correct.
Format conversion: Transform content from one format to another (HTML to Markdown, Markdown to HTML, etc.).
Activity & logs: Obtain logs and activity applied to the various elements in the system.
Export: Export your documents to other formats.
There are countless use cases for you to leverage our APIs in your workflow.

Check the Syntax of a Markdown Document

Here is a concrete example of an API call to check the syntax of a Markdown document:

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

Expected response:

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


{
  "status": "error",
  "code": 200,
  "message": "Error!",
  "data": {
    "message": "Markdown not valid"
  }
}

Transform Standard Markdown to Super Markdown Syntax

curl -X POST "https://api.super-markdown.com/api/space/app/transform-markdown/" \
  -H "app_auth: YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "content_markdown": "# title of document\n\nlorem ipsum dolor sit amet.\n\n## title of section\n\n",
    "save" : true,
    "title" : "Title of document",
    "mode" : "dark-mode",
    "parent" : "{PARENT_UID}"
    
  }'

Transform Docx to Super Markdown Syntax

curl -X POST "https://api.super-markdown.com/api/space/app/transform-docx-markdown/" \
  -H "app_auth: YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "file_base64": "{FILE_BASE64"} :: title\n\n",
    "save" : true,
    "title" : "Title of document",
    "mode" : "dark-mode",
    "parent" : "{PARENT_UID}"
    
  }'

This feature is only available to PRO pack subscribers

Export The document to PDF File

curl -X GET "https://api.super-markdown.com/api/space/app/export-document-pdf/{UID_DOCUMENT}/" \
  -H "app_auth: YOUR_KEY_HERE" \
  -H "Content-Type: application/json"

Chart generation support for this API is not yet available, but it will be available soon.

This feature is only available to PRO pack subscribers

Get the HTML of a specific document

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

Get the The activitys of a specific document / folder

curl -X GET "https://api.super-markdown.com/api/space/app/get-activitys/{folder|document}/{UID_DOCUMENT}/" \
  -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

Utils API