REST API

Generate mindmap, flowchart, architecture, and sequence diagrams directly from text or pre-authored source using our REST API. One auth model, four diagram types, all behind the same simple request shape.

Overview

The ClipMind REST API allows you to programmatically generate professional mind map images from any text content. Whether you want to create summaries, visualize ideas, or integrate mind mapping into your application, our API provides a simple and powerful interface to do so.

API Base URL
https://api.clipmind.tech

Secure Authentication

JWT-based authentication ensures secure access to the API with time-limited tokens.

Image Generation

Generate high-resolution PNG images with customizable themes and layouts.

AI-Powered

Leverage AI for intelligent summarization and brainstorming from raw text.

Endpoints

Pick a diagram type below. Every type accepts the same {text, options} body shape, supports raw mode (pre-authored source) and summarize mode (AI-generated from prose), and returns either the rendered image or the underlying source.

POST/public/mindmaps/image

Processes raw text or markdown to generate a structured mind map image (PNG). The process involves AI summarization followed by professional rendering.

FieldTypeRequiredDescription
textstringYesThe raw text or markdown to be converted.
options.themestringNoColor theme. One of: iris, neon, amethyst, sunset, ocean, forest, cherry-blossom, volcano, hermes-orange, tiffany-blue, rainbow, premium-black, rose-gold, deep-sea, lavender, champagne, midnight-blue, emerald, china-red, french-flag, german-flag, american-flag, japanese-flag, rose, slate, gold, cyan, indigo, dark-iris, dark-neon, dark-amethyst, dark-sunset, dark-ocean, dark-forest, dark-cherry-blossom, dark-volcano, dark-hermes-orange, dark-tiffany-blue, dark-rainbow, dark-premium-black, dark-rose-gold, dark-deep-sea, dark-lavender, dark-champagne, dark-midnight-blue, dark-emerald, dark-china-red, dark-french-flag, dark-german-flag, dark-american-flag, dark-japanese-flag, dark-rose, dark-slate, dark-gold, dark-cyan, dark-indigo.
options.layoutstringNoLayout type: mindmap, logic, org, tree, timeline.
options.modestringNoGeneration mode: summarize, brainstorm, or raw. In raw mode the input is treated as already-structured markdown (headings and list items) and rendered directly without AI; non-structure lines are dropped.
scalenumberNoResolution scale factor (default: 2).
Example RequestcURL
curl -X POST https://api.clipmind.tech/public/mindmaps/image \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
    "text": "My MindMap\n- Idea 1\n- Idea 2",
    "options": {
      "theme": "dark",
      "layout": "mindmap",
      "mode": "summarize"
    }
  }' > mindmap.png
POST/public/mindmaps/markdown

Processes raw text to generate a structured markdown representation of a mind map. Useful for rendering with your own tools.

FieldTypeRequiredDescription
textstringYesThe raw text to be converted.
options.modestringNoGeneration mode: summarize, brainstorm, or raw. In raw mode the input is treated as already-structured markdown (headings and list items) and rendered directly without AI; non-structure lines are dropped.
options.languagestringNoOutput language (e.g., english, chinese).
Response FormatJSON
{
  "success": true,
  "data": "# Root Node\n## Child Node 1\n## Child Node 2\n..."
}

Getting Started

To start using the ClipMind API, you need to generate an API token from your workspace. The token is valid for a limited time and must be included in the Authorization header of all API requests.

Generate Your API Token