Getting Started

The Media API allows you to manage all your media files programmatically, without having to connect to your Super Markdown space via the web interface.

Media refers to all the visual and audiovisual resources that you can integrate into your Markdown documents: images, videos, audio files, GIF animations, etc.

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

Operation	Description
Uploader	Upload a media file from your system to the platform
Get the media	Retrieve the metadata and URL of an existing media file
Delete	Permanently remove a media item from your library
Listing	Get the list of all available Media from your library

The main objective of this API is to offer developers the ability to automate the integration of media resources into their documents, without having to manually manipulate the platform interface.

Examples of use cases

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

CI/CD pipeline integration: Automatic upload of screenshots generated during user interface testing.
Synchronization with external storage: Periodic migration or synchronization of media from an S3 bucket, Google Drive, or Dropbox.
Automatic gallery generation: Upload image sets and automatically create galleries in your Markdown documents.
Enhanced reports: Programmatic addition of charts, diagrams, or screenshots to automatically generated reports.
There are countless use cases for you to leverage our APIs in your workflow.

Supported formats

Type	Formats Supported	Maximum size
Images	JPEG, PNG, GIF, WebP, SVG, BMP, TIFF	10 MB
Documents	DOCX, PDF, PPTX, XLSX	10 MB
Videos	Support comming soon	-
Audios	Support comming soon	-

Create New Media

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/upload-media/" \
  -H "app_auth: YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "name_file": "test.jpg",
    "file_base64": "URL_IMAGE_BASE64",
    
  }'

Expected response:

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


{
  "status": "success",
  "code": 200,
  "message": "Success!",
  "data": {
    "uid": "UID_OF_MEDIA_CREATED",
    "url": "URL_OF_MEDIA_CREATED",
    "message": "ok"
  }
}

Get The list of your available Medias in your library

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

Delete permanently existing Media

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

Media API