Skip to main content

​
Overview

The Mind Maps API creates visual mind maps from study content using AI. Mind maps help organize information hierarchically with a central concept and branching topics.

​
Endpoints

​
Generate Mind Map

curl -X POST https://api.inspir.uk/api/mindmap/generate \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "title": "Photosynthesis",
    "content": "Photosynthesis is the process by which plants...",
    "topic": "Biology"
  }'
Generate a mind map from content. Authentication: Optional (guests get mind map without saving)

​
Request Body

​
title
string
required
Title of the mind map
​
content
string
required
Text content to generate mind map from
​
topic
string
Subject or topic (e.g., “Biology”, “History”)

​
Response

​
success
boolean
Whether the request was successful
​
mindMap
object
Generated mind map structure
​
saved
boolean
Whether the mind map was saved (true for authenticated users)

​
Get Mind Maps

curl -X GET https://api.inspir.uk/api/mindmap/ \
  -H "Authorization: Bearer YOUR_TOKEN"
Get user’s saved mind maps. Authentication: Required

​
Response

​
success
boolean
Whether the request was successful
​
mindMaps
array
Array of mind maps (same structure as generate response)

​
Get Mind Map by ID

curl -X GET https://api.inspir.uk/api/mindmap/abc123 \
  -H "Authorization: Bearer YOUR_TOKEN"
Get a specific mind map. Authentication: Optional

​
Path Parameters

​
id
string
required
Mind map ID

​
Update Mind Map

curl -X PUT https://api.inspir.uk/api/mindmap/abc123 \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "title": "Updated Title",
    "branches": [...]
  }'
Update a mind map. Authentication: Required

​
Delete Mind Map

curl -X DELETE https://api.inspir.uk/api/mindmap/abc123 \
  -H "Authorization: Bearer YOUR_TOKEN"
Delete a mind map. Authentication: Required

​
Error Responses

  • 400 - Missing required fields
  • 401 - Authentication required
  • 404 - Mind map not found
  • 500 - AI generation failed
Mind maps are ideal for brainstorming, memorization, and understanding hierarchical relationships between concepts.

Build docs developers (and LLMs) love

Get started for freeTalk to us