Felo APIs

Mindmap API

prompts اور اختیاری LiveDoc سیاق سے ذہنی نقشے بنائیں۔

POST/v2/mindmap

تصدیق

Bearer API key

مواد کی قسم

application/json

ریٹ نوٹس

endpoint کے مخصوص حدود لاگو ہو سکتے ہیں۔

LiveDoc API

Mindmap API مائنڈ میپ جنریشن کی صلاحیتیں فراہم کرتا ہے۔ آپ کسی موضوع یا سوال سے مائنڈ میپ بنا سکتے ہیں اور اختیاری طور پر لے آؤٹ کی قسم متعین کر سکتے ہیں۔

تصدیق

تمام درخواستوں کے لیے Authorization ہیڈر میں API کلید درکار ہے:

Authorization: Bearer YOUR_API_KEY

AI ایجنٹس کے ساتھ استعمال

ایجنٹ کو باقی تمام دستیاب Felo Skills کے ساتھ مائنڈ میپ بنانے کی سہولت دینے کے لیے مکمل felo-ai پیکج انسٹال کریں۔ انسٹالر SKILL.md رکھنے والی ہر پیکج ڈائریکٹری کو متحرک طور پر دریافت کرتا ہے، لہٰذا مستقبل کے اضافے بھی شامل رہتے ہیں۔ دریافت شدہ تمام Skills کو Codex میں ~/.codex/skills، Claude Code میں ~/.claude/skills، OpenClaw میں ~/.agents/skills یا Hermes Agent میں ~/.hermes/skills پر انسٹال کریں۔ ہر پلیٹ فارم کے محفوظ سیٹ اپ طریقہ کار کے لیے AI ایجنٹ کی دستی سیٹ اپ گائیڈ کی پیروی کریں۔

مائنڈ میپ بنائیں

کسی استفسار (موضوع یا سوال) کی بنیاد پر مائنڈ میپ بنائیں۔

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 ID۔ اگر فراہم نہ کیا جائے تو خودکار طور پر نیا 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	بنائے گئے مائنڈ میپ کا ریسورس ID
`status`	string	مائنڈ میپ کی حالت (مثلاً `COMPLETED`)
`livedoc_short_id`	string	وہ LiveDoc شارٹ ID جہاں مائنڈ میپ محفوظ ہے
`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 درخواست کا وقت ختم ہو گیا