Felo APIs

Mindmap API

نقشه‌های ذهنی را از promptها و زمینه اختیاری LiveDoc بسازید.

POST/v2/mindmap

احراز هویت

Bearer API key

نوع محتوا

application/json

یادداشت نرخ

ممکن است محدودیت‌های مخصوص endpoint اعمال شود.

LiveDoc API

Mindmap API توانمندی تولید نقشه ذهنی را فراهم می‌کند. می‌توانید با یک موضوع یا پرسش نقشه ذهنی بسازید و به‌صورت اختیاری نوع چیدمان را مشخص کنید.

احراز هویت

همه درخواست‌ها به یک کلید API در سرآیند Authorization نیاز دارند:

Authorization: Bearer YOUR_API_KEY

استفاده با عامل‌های هوش مصنوعی

بسته کامل felo-ai را نصب کنید تا یک عامل بتواند در کنار هر Felo Skill در دسترس دیگر نقشه ذهنی بسازد. نصب‌کننده به‌صورت پویا هر پوشه بسته شامل SKILL.md را کشف می‌کند، پس افزوده‌های آینده را هم در بر می‌گیرد. همه Skillهای کشف‌شده را در ~/.codex/skills مربوط به Codex، ~/.claude/skills مربوط به Claude Code، ~/.agents/skills مربوط به OpenClaw یا ~/.hermes/skills مربوط به Hermes Agent نصب کنید. برای رویه راه‌اندازی ایمن در هر پلتفرم راهنمای راه‌اندازی دستی عامل هوش مصنوعی را دنبال کنید.

ساخت نقشه ذهنی

بر اساس یک پرس‌وجو (موضوع یا پرسش) نقشه ذهنی بسازید.

Endpoint

POST https://openapi.felo.ai/v2/mindmap

سرآیندهای درخواست

سرآیند	الزامی	توضیح
`Authorization`	بله	کلید API شما در قالب `Bearer YOUR_API_KEY`
`Content-Type`	بله	باید `application/json` باشد

بدنه درخواست

پارامتر	نوع	الزامی	توضیح
`query`	string	بله	موضوع یا پرسش برای تولید نقشه ذهنی. حداکثر 2000 کاراکتر
`layout`	string	خیر	نوع چیدمان. پیش‌فرض: `MIND_MAP`
`livedoc_short_id`	string	خیر	شناسه LiveDoc. اگر داده نشود، LiveDoc تازه‌ای به‌طور خودکار ساخته می‌شود

نوع‌های چیدمان

چیدمان	توضیح
`MIND_MAP`	نقشه ذهنی کلاسیک (پیش‌فرض)
`LOGICAL_STRUCTURE`	نمودار ساختار منطقی
`ORGANIZATION_STRUCTURE`	چارت سازمانی
`CATALOG_ORGANIZATION`	چارت سازمانی کاتالوگ
`TIMELINE`	نمودار خط زمانی
`FISHBONE`	نمودار استخوان ماهی

نمونه: ساخت با 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"
  }'

نمونه: ساخت با 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"
  }'

پاسخ موفق (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"
  }
}

فیلدهای پاسخ

فیلد	نوع	توضیح
`resource_id`	string	شناسه منبع نقشه ذهنی ساخته‌شده
`status`	string	وضعیت نقشه ذهنی (مثلاً `COMPLETED`)
`livedoc_short_id`	string	شناسه کوتاه LiveDocی که نقشه ذهنی در آن ذخیره شده
`mindmap_url`	string	URL مشاهده نقشه ذهنی (قالب: `{host}/mindmap/{resource_id}`)
`svg`	string	محتوای SVG نقشه ذهنی
`message`	string	پیام وضعیت

کدهای خطا

کد	وضعیت HTTP	توضیح
`UNAUTHORIZED`	401	کلید API نامعتبر یا لغوشده است
`MINDMAP_CREATE_FAILED`	502	ساخت نقشه ذهنی شکست خورد
`LIVEDOC_CREATE_FAILED`	502	ساخت LiveDoc شکست خورد
`LIVEDOC_NOT_FOUND`	404	LiveDoc مشخص‌شده پیدا نشد
`LLM_SERVICE_UNAVAILABLE`	503	سرویس LLM در دسترس نیست
`LLM_REQUEST_TIMEOUT`	504	مهلت درخواست LLM تمام شد