Configure Harness
Mindmap API
Create mindmaps from prompts and optional LiveDoc context.
/v2/mindmapAuthentication
Bearer API key
Content type
application/json
Rate notes
Endpoint-specific limits may apply.
The Mindmap API provides mindmap generation capabilities. You can create a mindmap with a topic or question, and optionally specify a layout type.
Authentication
All requests require an API Key in the Authorization header:
Authorization: Bearer YOUR_API_KEYUse with AI Agents
Install the complete felo-ai package to let an Agent create mindmaps alongside every other available Felo Skill. The installer dynamically discovers every package directory containing SKILL.md, so it includes future additions. Install all discovered Skills in Codex ~/.codex/skills, Claude Code ~/.claude/skills, OpenClaw ~/.agents/skills, or Hermes Agent ~/.hermes/skills. Follow the manual AI Agent setup guide for the safe setup procedure for each platform.
Create Mindmap
Create a mindmap based on a query (topic or question).
Endpoint
POST https://openapi.felo.ai/v2/mindmapRequest Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Your API Key in the format Bearer YOUR_API_KEY |
Content-Type | Yes | Must be application/json |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | Yes | The topic or question for mindmap generation. Max 2000 characters |
layout | string | No | Layout type. Default: MIND_MAP |
livedoc_short_id | string | No | LiveDoc ID. If not provided, a new LiveDoc will be created automatically |
Layout Types
| Layout | Description |
|---|---|
MIND_MAP | Classic mind map (default) |
LOGICAL_STRUCTURE | Logical structure diagram |
ORGANIZATION_STRUCTURE | Organization chart |
CATALOG_ORGANIZATION | Catalog organization chart |
TIMELINE | Timeline diagram |
FISHBONE | Fishbone diagram |
Example: Create with Auto LiveDoc
curl -X POST 'https://openapi.felo.ai/v2/mindmap' \
-H 'accept: application/json' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"query": "Artificial Intelligence trends in 2024"
}'Example: Create with Specific LiveDoc
curl -X POST 'https://openapi.felo.ai/v2/mindmap' \
-H 'accept: application/json' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"query": "Project timeline overview",
"layout": "TIMELINE",
"livedoc_short_id": "abc123xyz"
}'Success Response (200)
{
"status": "ok",
"message": null,
"data": {
"resource_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "COMPLETED",
"livedoc_short_id": "PvyKouzJirXjFdst4uKRK3",
"mindmap_url": "https://felo.ai/mindmap/550e8400-e29b-41d4-a716-446655440000",
"svg": "<svg>...</svg>",
"message": "Mindmap created successfully"
}
}Response Fields
| Field | Type | Description |
|---|---|---|
resource_id | string | Resource ID of the created mindmap |
status | string | Status of the mindmap (e.g., COMPLETED) |
livedoc_short_id | string | LiveDoc short ID where the mindmap is stored |
mindmap_url | string | URL to view the mindmap (format: {host}/mindmap/{resource_id}) |
svg | string | SVG content of the mindmap |
message | string | Status message |
Error Codes
| Code | HTTP Status | Description |
|---|---|---|
INVALID_API_KEY | 401 | API Key is invalid or revoked |
MINDMAP_CREATE_FAILED | 502 | Mindmap creation failed |
LIVEDOC_CREATE_FAILED | 502 | Failed to create LiveDoc |
LIVEDOC_NOT_FOUND | 404 | Specified LiveDoc not found |
LLM_SERVICE_UNAVAILABLE | 503 | LLM service is unavailable |
LLM_REQUEST_TIMEOUT | 504 | LLM request timed out |