ClipMind

Workspace

Contact UsIf you have any questions, feel free to reach out at neo@clipmind.tech.

API Documentation

Generate mindmap, flowchart, architecture, and sequence diagrams directly from text or pre-authored source using our REST API. All four diagram types share the same auth model and request shape so you can plug them into the same pipeline.

Authentication

All public API endpoints require authentication using a JWT (JSON Web Token). You must include this token in the Authorization header of your requests.

API Base URL

https://api.clipmind.tech

MindMap Preview

Create high-quality mind map images directly from your text content. This endpoint leverages AI to structure your input and then renders it into a professional image format. It supports various themes, layouts, and customization options for perfect integration into your application.

POST/public/mindmaps/image

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

Request Body

Field	Type	Required	Description
`text`	string	Yes	The raw text or markdown to be converted.
`options.theme`	string	No	Color 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.layout`	string	No	Layout type: mindmap, logic, org, tree, timeline.
`options.mode`	string	No	Generation 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.language`	string	No	Output language (e.g., english, chinese).
`options.length`	string	No	Content detail level: short, medium, detailed.
`scale`	number	No	Resolution scale factor (default: 2).
`transparent`	boolean	No	Whether the background should be transparent.

Response

Returns the binary data of the generated PNG image. The response header will include Content-Type: image/png.

Example Usage

cURLbash

BASH
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",
      "language": "english",
      "length": "medium"
    }
  }' > mindmap.png

MindMap Markdown

Generate a structured markdown representation of a mind map from raw text. This is useful if you want to render the mind map using your own tools or simply get a structured summary.

POST/public/mindmaps/markdown

Processes raw text to generate a structured markdown compatible with most mind map tools (indented list format).

Request Body

Field	Type	Required	Description
`text`	string	Yes	The raw text to be converted.
`options.mode`	string	No	Generation 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.language`	string	No	Output language (e.g., english, chinese).
`options.length`	string	No	Content detail level: short, medium, detailed.

Response

Returns a JSON object containing the generated markdown string.

Response Typejson

JSON
{
  "success": true,
  "data": "# Root Node\n## Child Node 1\n..."
}

Example Usage

cURLbash

BASH
curl -X POST https://api.clipmind.tech/public/mindmaps/markdown \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
    "text": "My MindMap\n- Idea 1\n- Idea 2",
    "options": {
      "mode": "summarize",
      "language": "english",
      "length": "medium"
    }
  }'