Felo APIs

LiveDoc API

علمی بنیادیں بنائیں، وسائل کا انتظام کریں، اور معنوی بازیابی اور روٹنگ چلائیں۔

POST/v2/livedocs

تصدیق

Bearer API key

مواد کی قسم

application/json or multipart/form-data

ریٹ نوٹس

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

SuperAgent API PPT Task API

LiveDoc API LiveDocs اور اُن کے ریسورسز کے لیے مکمل CRUD آپریشنز فراہم کرتا ہے، بشمول دستاویز کی تخلیق، فائل اپ لوڈ، URL امپورٹ اور سیمنٹک ریٹریول۔

تصدیق

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

Authorization: Bearer YOUR_API_KEY

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

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

1. LiveDoc بنائیں

endpoint

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

درخواست باڈی

پیرامیٹر	قسم	لازمی	تفصیل
`name`	string	ہاں	LiveDoc کا نام
`description`	string	نہیں	LiveDoc کی تفصیل
`icon`	string	نہیں	LiveDoc کا آئیکن

مثال

curl -X POST 'https://openapi.felo.ai/v2/livedocs' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "AI Research Notes",
    "description": "Collection of AI research materials"
  }'

کامیاب جواب (200)

{
  "status": "ok",
  "message": null,
  "data": {
    "short_id": "PvyKouzJirXjFdst4uKRK3",
    "name": "AI Research Notes",
    "description": "Collection of AI research materials",
    "icon": null,
    "created_at": "2026-03-09T10:00:00Z",
    "modified_at": "2026-03-09T10:00:00Z"
  }
}

Response Fields (جواب کے فیلڈز)

فیلڈ	قسم	تفصیل
`short_id`	string	LiveDoc ID
`name`	string	LiveDoc کا نام
`description`	string	LiveDoc کی تفصیل
`icon`	string	LiveDoc کا آئیکن
`created_at`	string	تخلیق کا ٹائم اسٹیمپ (ISO 8601)
`modified_at`	string	آخری تبدیلی کا ٹائم اسٹیمپ (ISO 8601)
`is_shared`	boolean	آیا یہ LiveDoc موجودہ صارف کے ساتھ شیئر کیا گیا ہے (اُس کی ملکیت نہیں)

2. LiveDocs کی فہرست بنائیں

endpoint

GET https://openapi.felo.ai/v2/livedocs

Query Parameters

پیرامیٹر	قسم	لازمی	تفصیل
`keyword`	string	نہیں	کلیدی لفظ سے فلٹر کریں
`page`	integer	نہیں	صفحہ نمبر (1 سے شروع)
`size`	integer	نہیں	صفحے کا سائز

مثال

curl 'https://openapi.felo.ai/v2/livedocs?keyword=AI&page=1&size=20' \
  -H 'Authorization: Bearer YOUR_API_KEY'

کامیاب جواب (200)

{
  "status": "ok",
  "message": null,
  "data": {
    "total": 2,
    "page": 1,
    "size": 20,
    "items": [
      {
        "short_id": "PvyKouzJirXjFdst4uKRK3",
        "name": "AI Research Notes",
        "description": "Collection of AI research materials",
        "icon": null,
        "created_at": "2026-03-09T10:00:00Z",
        "modified_at": "2026-03-09T10:05:00Z",
        "is_shared": false,
        "readme": {
          "summary": "AI research notes and papers collection",
          "content": "# AI Research Notes\n\nThis LiveDoc contains..."
        }
      }
    ]
  }
}

Response Fields (جواب کے فیلڈز)

items کا ہر آئٹم وہی فیلڈز رکھتا ہے جو LiveDoc بنانے کے جواب میں ہیں، مزید:

فیلڈ	قسم	تفصیل
`readme`	object \| null	README کی معلومات۔ اگر کوئی README نہ ہو تو `null`۔
`readme.summary`	string \| null	پروجیکٹ کی ایک سطری تفصیل
`readme.content`	string \| null	README کا مواد (Markdown)

endpoint

PUT https://openapi.felo.ai/v2/livedocs/{short_id}

درخواست باڈی

پیرامیٹر	قسم	لازمی	تفصیل
`name`	string	نہیں	LiveDoc کا نیا نام
`description`	string	نہیں	LiveDoc کی نئی تفصیل

مثال

curl -X PUT 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Updated Research Notes"
  }'

کامیاب جواب (200)

اپ ڈیٹ شدہ LiveDoc آبجیکٹ واپس کرتا ہے (وہی ساخت جو تخلیق کے جواب میں ہے)۔

4. LiveDoc حذف کریں

endpoint

DELETE https://openapi.felo.ai/v2/livedocs/{short_id}

مثال

curl -X DELETE 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3' \
  -H 'Authorization: Bearer YOUR_API_KEY'

کامیاب جواب (200)

{
  "status": "ok",
  "message": null,
  "data": null
}

5. ریسورسز کی فہرست بنائیں

endpoint

GET https://openapi.felo.ai/v2/livedocs/{short_id}/resources

Query Parameters

پیرامیٹر	قسم	لازمی	تفصیل
`resource_types`	string[]	نہیں	ریسورس کی اقسام سے فلٹر کریں
`page`	integer	نہیں	صفحہ نمبر (1 سے شروع)
`size`	integer	نہیں	صفحے کا سائز

مثال

curl 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources?page=1&size=20' \
  -H 'Authorization: Bearer YOUR_API_KEY'

کامیاب جواب (200)

{
  "status": "ok",
  "message": null,
  "data": {
    "total": 2,
    "page": 1,
    "size": 20,
    "items": [
      {
        "id": "res_001",
        "title": "OpenAI Blog Post",
        "link": "https://openai.com/blog/...",
        "snippet": "Summary of the article...",
        "thumbnail": null,
        "resource_type": "web",
        "resource_key": "key_001",
        "status": "completed",
        "source": "url",
        "created_at": "2026-03-09T10:00:10Z",
        "modified_at": "2026-03-09T10:00:15Z"
      }
    ]
  }
}

ریسورس جواب کے فیلڈز

فیلڈ	قسم	تفصیل
`id`	string	ریسورس ID
`title`	string	ریسورس کا عنوان
`link`	string	ریسورس کا لنک/URL
`snippet`	string	ریسورس کا خلاصہ
`thumbnail`	string	تھمب نیل کا URL
`resource_type`	string	ریسورس کی قسم (مثلاً `web`، `ai_doc`، `file`)
`resource_key`	string	ریسورس کی وابستگی کی کلید
`status`	string	ریسورس کی حالت
`source`	string	ریسورس کا ماخذ
`created_at`	string	تخلیق کا ٹائم اسٹیمپ (ISO 8601)
`modified_at`	string	آخری تبدیلی کا ٹائم اسٹیمپ (ISO 8601)

6. واحد ریسورس حاصل کریں

endpoint

GET https://openapi.felo.ai/v2/livedocs/{short_id}/resources/{resource_id}

مثال

curl 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/res_001' \
  -H 'Authorization: Bearer YOUR_API_KEY'

کامیاب جواب (200)

ایک واحد ریسورس آبجیکٹ واپس کرتا ہے (وہی ساخت جو ریسورسز کی فہرست میں آئٹمز کی ہے)۔

7. ریسورس اپ ڈیٹ کریں

ریسورس کا title، snippet یا thumbnail اپ ڈیٹ کریں۔ صرف فراہم کردہ فیلڈز اپ ڈیٹ ہوتے ہیں؛ چھوڑے گئے فیلڈز اپنی موجودہ ویلیوز برقرار رکھتے ہیں۔

endpoint

PUT https://openapi.felo.ai/v2/livedocs/{short_id}/resources/{resource_id}

درخواست باڈی

تمام فیلڈز اختیاری ہیں۔

پیرامیٹر	قسم	لازمی	تفصیل
`title`	string	نہیں	ریسورس کا نیا عنوان (زیادہ سے زیادہ 500 حروف)
`snippet`	string	نہیں	ریسورس کا نیا خلاصہ (زیادہ سے زیادہ 2000 حروف)
`thumbnail`	string	نہیں	تھمب نیل کا نیا URL (زیادہ سے زیادہ 2000 حروف)

مثال

curl -X PUT 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/res_001' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Updated Title",
    "snippet": "Updated summary of the resource."
  }'

کامیاب جواب (200)

اپ ڈیٹ شدہ ریسورس آبجیکٹ واپس کرتا ہے (وہی ساخت جو ریسورسز کی فہرست میں آئٹمز کی ہے)۔

8. ریسورس کا مواد اپ ڈیٹ کریں

ai_doc ریسورس کا Markdown مواد اپ ڈیٹ کریں۔ صرف اُن ریسورسز کے لیے معاون ہے جن کا resource_type == ai_doc ہو۔ snippet فیلڈ نئے مواد کے پہلے 2000 بائٹس سے خودکار طور پر اپ ڈیٹ ہوتا ہے۔

endpoint

PUT https://openapi.felo.ai/v2/livedocs/{short_id}/resources/{resource_id}/content

درخواست باڈی

پیرامیٹر	قسم	لازمی	تفصیل
`content`	string	ہاں	ریسورس کے لیے نیا Markdown مواد

مثال

curl -X PUT 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/res_001/content' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "content": "# Updated Document\n\nThis is the new content."
  }'

کامیاب جواب (200)

اپ ڈیٹ شدہ ریسورس آبجیکٹ واپس کرتا ہے (وہی ساخت جو ریسورسز کی فہرست میں آئٹمز کی ہے)۔

9. دستاویز ریسورس بنائیں

endpoint

POST https://openapi.felo.ai/v2/livedocs/{short_id}/resources/doc

درخواست باڈی

پیرامیٹر	قسم	لازمی	تفصیل
`title`	string	نہیں	دستاویز کا عنوان (ڈیفالٹ "New Document")
`content`	string	ہاں	دستاویز کا مواد

مثال

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/doc' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "My Research Notes",
    "content": "Key findings from the AI research paper..."
  }'

کامیاب جواب (200)

بنایا گیا ریسورس آبجیکٹ واپس کرتا ہے۔

10. فائل کو دستاویز کے طور پر اپ لوڈ کریں

ایک فائل اپ لوڈ کریں اور اُسے دستاویز ریسورس (ai_doc قسم) میں تبدیل کریں۔

endpoint

POST https://openapi.felo.ai/v2/livedocs/{short_id}/resources/upload-doc

Content-Type

multipart/form-data

Request Parts

پیرامیٹر	قسم	لازمی	تفصیل
`file`	file	ہاں	اپ لوڈ کی جانے والی فائل
`title`	string	نہیں	دستاویز کا عنوان

مثال

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/upload-doc' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -F '[email protected]' \
  -F 'title=My PDF Document'

کامیاب جواب (200)

بنایا گیا ریسورس آبجیکٹ واپس کرتا ہے۔

11. فائل ریسورس اپ لوڈ کریں

ایک فائل اپ لوڈ کریں اور اُس کا اصل فارمیٹ برقرار رکھیں۔

endpoint

POST https://openapi.felo.ai/v2/livedocs/{short_id}/resources/upload

Content-Type

multipart/form-data

Request Parts

پیرامیٹر	قسم	لازمی	تفصیل
`file`	file	ہاں	اپ لوڈ کی جانے والی فائل

مثال

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/upload' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -F '[email protected]'

کامیاب جواب (200)

بنایا گیا ریسورس آبجیکٹ واپس کرتا ہے۔

12. URL ریسورسز شامل کریں

LiveDoc میں ایک یا زیادہ URLs بطور ریسورس شامل کریں۔

endpoint

POST https://openapi.felo.ai/v2/livedocs/{short_id}/resources/urls

درخواست باڈی

پیرامیٹر	قسم	لازمی	تفصیل
`urls`	array	ہاں	شامل کیے جانے والے URL آئٹمز کی فہرست (1-10)۔ ہر آئٹم سادہ سٹرنگ یا `url` اور اختیاری `title` والا آبجیکٹ ہو سکتا ہے۔

URL آئٹم کی شکلیں

urls میں ہر اندراج اِن میں سے کوئی ایک ہو سکتا ہے:

سادہ سٹرنگ: "https://example.com/article"
آبجیکٹ: {"url": "https://example.com/article", "title": "Custom Title"}

فیلڈ	قسم	لازمی	تفصیل
`url`	string	ہاں	شامل کرنے کا URL (5-2000 حروف)
`title`	string	نہیں	ریسورس کا حسب ضرورت عنوان (زیادہ سے زیادہ 1000 حروف)۔ اگر نہ دیا جائے تو صفحے سے عنوان خودکار طور پر بنتا ہے۔

مثال

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/urls' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "urls": [
      "https://example.com/article-1",
      {"url": "https://example.com/article-2", "title": "My Custom Title"}
    ]
  }'

کامیاب جواب (200)

{
  "status": "ok",
  "message": null,
  "data": [
    {
      "url": "https://example.com/article-1",
      "status": "success",
      "fail_reason": null,
      "resource_id": "res_003"
    },
    {
      "url": "https://example.com/article-2",
      "status": "existed",
      "fail_reason": null,
      "resource_id": "res_004"
    }
  ]
}

URL نتیجے کے فیلڈز

فیلڈ	قسم	تفصیل
`url`	string	پروسیس شدہ URL
`status`	string	نتیجے کی حالت: `success`، `failed` یا `existed`
`fail_reason`	string	ناکامی کی وجہ (کامیابی پر null)
`resource_id`	string	بنایا گیا ریسورس ID

13. ریسورس حذف کریں

endpoint

DELETE https://openapi.felo.ai/v2/livedocs/{short_id}/resources/{resource_id}

مثال

curl -X DELETE 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/res_001' \
  -H 'Authorization: Bearer YOUR_API_KEY'

کامیاب جواب (200)

{
  "status": "ok",
  "message": null,
  "data": null
}

14. Retrieve — Semantic Search (سیمنٹک سرچ)

LiveDoc کے ریسورسز کے خلاف سیمنٹک ریٹریول انجام دیں۔

endpoint

POST https://openapi.felo.ai/v2/livedocs/{short_id}/resources/retrieve

درخواست باڈی

پیرامیٹر	قسم	لازمی	تفصیل
`query`	string	ہاں	سیمنٹک تلاش کے لیے استفسار کا مواد
`resource_ids`	string[]	نہیں	جن مخصوص ریسورس IDs کے اندر تلاش کرنا ہے (1-50)۔ اگر نہ دیا جائے تو استفسار کی بنیاد پر متعلقہ ریسورسز خودکار طور پر روٹ ہوتے ہیں

مثال

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/retrieve' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": "latest developments in large language models",
    "resource_ids": ["res_001", "res_002"]
  }'

کامیاب جواب (200)

{
  "status": "ok",
  "message": null,
  "data": [
    {
      "id": "res_001",
      "title": "LLM Research Paper",
      "content": "Relevant content excerpt...",
      "score": 0.92,
      "metadata": {}
    }
  ]
}

Retrieve Result Fields (ریٹریو نتیجے کے فیلڈز)

فیلڈ	قسم	تفصیل
`id`	string	ریسورس ID
`title`	string	ریسورس کا عنوان
`content`	string	میل کھانے والا مواد
`score`	number	مطابقت کا اسکور
`metadata`	object	اضافی میٹاڈیٹا

15. ریسورسز روٹ کریں

استفسار کی بنیاد پر LiveDoc سے متعلقہ ریسورسز روٹ کریں۔ ایسی ریسورس IDs کی فہرست واپس کرتا ہے جنہیں retrieve endpoint کو دیا جا سکتا ہے۔

endpoint

POST https://openapi.felo.ai/v2/livedocs/{short_id}/resources/route

درخواست باڈی

پیرامیٹر	قسم	لازمی	تفصیل
`query`	string	ہاں	روٹنگ کے لیے استفسار کا مواد
`max_resources`	integer	نہیں	واپس کرنے کے لیے زیادہ سے زیادہ ریسورس IDs

مثال

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/route' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": "latest developments in large language models",
    "max_resources": 5
  }'

کامیاب جواب (200)

{
  "status": "ok",
  "message": null,
  "data": ["res_001", "res_003", "res_007"]
}

16. ریسورس کا ماخذ فائل ڈاؤن لوڈ کریں

ریسورس کی ماخذ فائل حاصل کریں۔ پہلے سے دستخط شدہ ڈاؤن لوڈ URL پر 302 redirect واپس کرتا ہے۔

صرف اُن ریسورسز کے لیے معاون ہے جن کے ساتھ کوئی ماخذ فائل منسلک ہو (مثلاً اپ لوڈ شدہ دستاویزات)۔

endpoint

GET https://openapi.felo.ai/v2/livedocs/{short_id}/resources/{resource_id}/download

Query Parameters

پیرامیٹر	قسم	لازمی	تفصیل
`expires_in`	integer	نہیں	URL کی میعاد سیکنڈز میں (ڈیفالٹ: 3600)

مثال

curl -L 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/res_001/download' \
  -H 'Authorization: Bearer YOUR_API_KEY'

جواب

302 Found واپس کرتا ہے جس میں Location ہیڈر پہلے سے دستخط شدہ S3 ڈاؤن لوڈ URL کی طرف اشارہ کرتا ہے۔ redirect کی معاونت کرنے والے HTTP کلائنٹس (مثلاً curl -L) redirect کی پیروی کرتے ہیں اور فائل براہ راست ڈاؤن لوڈ کرتے ہیں۔

17. ریسورس کا مواد حاصل کریں

ریسورس کا نکالا گیا متنی مواد حاصل کریں۔ زیادہ تر ریسورس اقسام کے لیے معاون ہے (document، web، video، ai_doc، ai_ppt، text، voice، mindmap وغیرہ)۔ image جیسی غیر معاون اقسام کے لیے 400 واپس کرتا ہے۔

endpoint

GET https://openapi.felo.ai/v2/livedocs/{short_id}/resources/{resource_id}/content

مثال

curl 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/res_001/content' \
  -H 'Authorization: Bearer YOUR_API_KEY'

کامیاب جواب (200)

{
  "status": "ok",
  "message": null,
  "data": {
    "title": "Q4 Financial Report",
    "type": "document",
    "content": "Full extracted text content of the resource..."
  }
}

Response Fields (جواب کے فیلڈز)

فیلڈ	قسم	تفصیل
`title`	string	ریسورس کا عنوان
`type`	string	ریسورس کی قسم
`content`	string	نکالا گیا متنی مواد

18. PPT صفحے کا ریٹریول

PPT ریسورس کے مخصوص صفحے پر گہرا مواد ریٹریول انجام دیں۔ سلائیڈ صفحہ اسکریپ کرتا ہے اور درجہ بند مواد کے چنکس واپس کرتا ہے۔ جواب کا فارمیٹ Retrieve endpoint جیسا ہی ہے۔

endpoint

POST https://openapi.felo.ai/v2/livedocs/{short_id}/resources/ppt-retrieve

درخواست باڈی

پیرامیٹر	قسم	لازمی	تفصیل
`resource_id`	string	ہاں	PPT ریسورس ID
`page_number`	integer	ہاں	ریٹریو کرنے کا صفحہ نمبر (1 سے شروع)
`query`	string	ہاں	استفسار کا مواد جو بتاتا ہے کیا تلاش کرنا ہے
`max_chunk`	integer	نہیں	واپس کرنے کے لیے زیادہ سے زیادہ چنکس (ڈیفالٹ: 3)

مثال

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/resources/ppt-retrieve' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "resource_id": "res_001",
    "page_number": 3,
    "query": "product pricing information",
    "max_chunk": 3
  }'

کامیاب جواب (200)

{
  "status": "ok",
  "message": null,
  "data": [
    {
      "id": "res_001_page_3_chunk_1",
      "title": "Q4 Product Deck",
      "content": "Relevant slide content excerpt...",
      "score": null,
      "metadata": {
        "resource_id": "res_001",
        "page_number": 3,
        "index": 1
      }
    }
  ]
}

Response Fields (جواب کے فیلڈز)

Retrieve Result Fields جیسا ہی۔

ایرر کوڈز

کوڈ	HTTP اسٹیٹس	تفصیل
`UNAUTHORIZED`	401	API کلید غلط یا منسوخ ہے
`LIVEDOC_CREATE_FAILED`	502	LiveDoc بنانے میں ناکامی
`LIVEDOC_UPDATE_FAILED`	502	LiveDoc اپ ڈیٹ کرنے میں ناکامی
`LIVEDOC_DELETE_FAILED`	502	LiveDoc حذف کرنے میں ناکامی
`LIVEDOC_NOT_FOUND`	404	LiveDoc نہیں ملا
`LIVEDOC_LIST_FAILED`	502	LiveDocs کی فہرست بنانے میں ناکامی
`LIVEDOC_RESOURCE_CREATE_FAILED`	502	ریسورس بنانے میں ناکامی
`LIVEDOC_RESOURCE_UPLOAD_FAILED`	502	ریسورس اپ لوڈ کرنے میں ناکامی
`LIVEDOC_RESOURCE_DELETE_FAILED`	502	ریسورس حذف کرنے میں ناکامی
`LIVEDOC_RESOURCE_NOT_FOUND`	404	ریسورس نہیں ملا
`LIVEDOC_RESOURCE_LIST_FAILED`	502	ریسورسز کی فہرست بنانے میں ناکامی
`LIVEDOC_RESOURCE_RETRIEVE_FAILED`	502	ریسورسز ریٹریو کرنے میں ناکامی
`LIVEDOC_RESOURCE_ADD_URLS_FAILED`	502	URL ریسورسز شامل کرنے میں ناکامی

19. README حاصل کریں

LiveDoc کا README مواد حاصل کریں۔ اگر کوئی README سیٹ نہ ہو تو خالی سٹرنگ واپس کرتا ہے۔

endpoint

GET https://openapi.felo.ai/v2/livedocs/{short_id}/readme

مثال

curl 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/readme' \
  -H 'Authorization: Bearer YOUR_API_KEY'

کامیاب جواب (200)

{
  "status": "ok",
  "message": null,
  "data": {
    "summary": "A brief one-line description of the project.",
    "content": "# My LiveDoc\n\nThis is the README content in Markdown."
  }
}

Response Fields (جواب کے فیلڈز)

فیلڈ	قسم	تفصیل
`summary`	string \| null	پروجیکٹ کی ایک سطری تفصیل۔ زیادہ سے زیادہ 2000 حروف۔
`content`	string	README کا مواد (Markdown)۔ سیٹ نہ ہو تو خالی سٹرنگ۔

20. README بنائیں یا اپ ڈیٹ کریں

LiveDoc کا README بنائیں یا اپ ڈیٹ کریں (upsert سیمنٹکس)۔

endpoint

PUT https://openapi.felo.ai/v2/livedocs/{short_id}/readme

درخواست باڈی

پیرامیٹر	قسم	لازمی	تفصیل
`summary`	string	نہیں	پروجیکٹ کی ایک سطری تفصیل (زیادہ سے زیادہ 2000 حروف)
`content`	string	نہیں	README کا مواد (Markdown)

نوٹ: summary یا content میں سے کم از کم ایک فراہم کرنا لازمی ہے۔

مثال

curl -X PUT 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/readme' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "summary": "A brief one-line description of the project.",
    "content": "# My LiveDoc\n\nThis is the README content in Markdown."
  }'

کامیاب جواب (200)

اپ ڈیٹ شدہ README آبجیکٹ واپس کرتا ہے (وہی ساخت جو README حاصل کرنے میں ہے)۔

21. README میں ضمیمہ کریں

موجودہ README کے آخر میں مواد شامل کریں۔ اگر کوئی README نہ ہو تو فراہم کردہ مواد کے ساتھ نیا بناتا ہے۔

endpoint

POST https://openapi.felo.ai/v2/livedocs/{short_id}/readme/append

درخواست باڈی

پیرامیٹر	قسم	لازمی	تفصیل
`content`	string	ہاں	ضمیمہ کرنے کا مواد (Markdown)

مثال

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/readme/append' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "content": "\n\n## New Section\n\nAdditional content appended to README."
  }'

کامیاب جواب (200)

ضمیمہ کرنے کے بعد مکمل README آبجیکٹ واپس کرتا ہے (وہی ساخت جو README حاصل کرنے میں ہے)۔

22. README حذف کریں

LiveDoc کا README حذف کریں۔

endpoint

DELETE https://openapi.felo.ai/v2/livedocs/{short_id}/readme

مثال

curl -X DELETE 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/readme' \
  -H 'Authorization: Bearer YOUR_API_KEY'

کامیاب جواب (200)

{
  "status": "ok",
  "message": null,
  "data": null
}

23. ٹاسکس کی فہرست بنائیں

LiveDoc میں ٹاسکس کی صفحات میں تقسیم شدہ فہرست حاصل کریں۔ نتائج sort asc، status asc، created_at desc کے مطابق ترتیب دیے جاتے ہیں۔

endpoint

GET https://openapi.felo.ai/v2/livedocs/{short_id}/tasks

Query Parameters

پیرامیٹر	قسم	لازمی	تفصیل
`status`	integer	نہیں	حالت سے فلٹر کریں: `0`=TODO، `1`=IN_PROGRESS، `2`=DONE
`labels`	string[]	نہیں	لیبلز سے فلٹر کریں (ٹاسکس میں تمام مخصوص لیبلز شامل ہونے چاہئیں)
`page`	integer	نہیں	صفحہ نمبر (1 سے شروع)
`size`	integer	نہیں	صفحے کا سائز

مثال

curl 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/tasks?status=0&page=1&size=20' \
  -H 'Authorization: Bearer YOUR_API_KEY'

کامیاب جواب (200)

{
  "status": "ok",
  "message": null,
  "data": {
    "total": 1,
    "page": 1,
    "size": 20,
    "items": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "title": "Write documentation",
        "description": "Write API documentation for the new endpoints",
        "status": 0,
        "sort": 0,
        "labels": ["docs", "priority-high"],
        "created_at": "2026-03-19T10:00:00Z",
        "modified_at": "2026-03-19T10:00:00Z"
      }
    ]
  }
}

ٹاسک جواب کے فیلڈز

فیلڈ	قسم	تفصیل
`id`	string	ٹاسک ID (UUID)
`title`	string	ٹاسک کا عنوان
`description`	string	ٹاسک کی تفصیل
`status`	integer	ٹاسک کی حالت: `0`=TODO، `1`=IN_PROGRESS، `2`=DONE
`sort`	integer	ترتیب (غیر منفی)
`labels`	string[]	لیبلز کی فہرست
`operated_by`	string	آپریٹر دستخط، مثلاً `claude-code`، `openclaw`
`created_at`	string	تخلیق کا ٹائم اسٹیمپ (ISO 8601)
`modified_at`	string	آخری تبدیلی کا ٹائم اسٹیمپ (ISO 8601)

24. ٹاسک بنائیں

LiveDoc میں نیا ٹاسک بنائیں۔

endpoint

POST https://openapi.felo.ai/v2/livedocs/{short_id}/tasks

درخواست باڈی

پیرامیٹر	قسم	لازمی	تفصیل
`title`	string	ہاں	ٹاسک کا عنوان
`description`	string	نہیں	ٹاسک کی تفصیل
`status`	integer	ہاں	ٹاسک کی حالت: `0`=TODO، `1`=IN_PROGRESS، `2`=DONE
`sort`	integer	ہاں	ترتیب (غیر منفی عدد)
`labels`	string[]	نہیں	لیبلز کی فہرست (زیادہ سے زیادہ 10، ہر ایک زیادہ سے زیادہ 50 حروف)
`operated_by`	string	نہیں	آپریٹر دستخط، مثلاً `claude-code`، `openclaw` (زیادہ سے زیادہ 100 حروف)

مثال

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/tasks' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Write documentation",
    "description": "Write API documentation for the new endpoints",
    "status": 0,
    "sort": 0,
    "labels": ["docs", "priority-high"]
  }'

کامیاب جواب (200)

بنایا گیا ٹاسک آبجیکٹ واپس کرتا ہے (وہی ساخت جو ٹاسکس کی فہرست میں آئٹمز کی ہے)۔

25. ٹاسک اپ ڈیٹ کریں

ٹاسک کو جزوی طور پر اپ ڈیٹ کریں۔ صرف فراہم کردہ فیلڈز اپ ڈیٹ ہوتے ہیں؛ چھوڑے گئے فیلڈز اپنی موجودہ ویلیوز برقرار رکھتے ہیں۔

endpoint

PATCH https://openapi.felo.ai/v2/livedocs/{short_id}/tasks/{task_id}

درخواست باڈی

تمام فیلڈز اختیاری ہیں۔

پیرامیٹر	قسم	لازمی	تفصیل
`title`	string	نہیں	ٹاسک کا نیا عنوان
`description`	string	نہیں	ٹاسک کی نئی تفصیل
`status`	integer	نہیں	نئی حالت: `0`=TODO، `1`=IN_PROGRESS، `2`=DONE
`sort`	integer	نہیں	نئی ترتیب (غیر منفی)
`labels`	string[]	نہیں	لیبلز کی نئی فہرست (زیادہ سے زیادہ 10، ہر ایک زیادہ سے زیادہ 50 حروف)
`operated_by`	string	نہیں	آپریٹر دستخط، مثلاً `claude-code`، `openclaw` (زیادہ سے زیادہ 100 حروف)

مثال

curl -X PATCH 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/tasks/550e8400-e29b-41d4-a716-446655440000' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": 1
  }'

کامیاب جواب (200)

اپ ڈیٹ شدہ ٹاسک آبجیکٹ واپس کرتا ہے (وہی ساخت جو ٹاسکس کی فہرست میں آئٹمز کی ہے)۔

26. ٹاسک حذف کریں

ٹاسک کو سافٹ ڈیلیٹ کریں۔

endpoint

DELETE https://openapi.felo.ai/v2/livedocs/{short_id}/tasks/{task_id}

مثال

curl -X DELETE 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/tasks/550e8400-e29b-41d4-a716-446655440000' \
  -H 'Authorization: Bearer YOUR_API_KEY'

کامیاب جواب (200)

{
  "status": "ok",
  "message": null,
  "data": null
}

27. ٹاسک ریکارڈز کی فہرست بنائیں

ٹاسک کے ریکارڈز (کمنٹس اور تبدیلی کی تاریخ) کی صفحات میں تقسیم شدہ فہرست حاصل کریں، جو created_at کے صعودی ترتیب میں ہوتی ہے۔

endpoint

GET https://openapi.felo.ai/v2/livedocs/{short_id}/tasks/{task_id}/records

Query Parameters

پیرامیٹر	قسم	لازمی	تفصیل
`record_type`	string	نہیں	ریکارڈ کی قسم سے فلٹر کریں: `comment`، `edit`، `status_change`
`page`	integer	نہیں	صفحہ نمبر (1 سے شروع)
`size`	integer	نہیں	صفحے کا سائز

مثال

curl 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/tasks/550e8400-e29b-41d4-a716-446655440000/records' \
  -H 'Authorization: Bearer YOUR_API_KEY'

کامیاب جواب (200)

{
  "status": "ok",
  "message": null,
  "data": {
    "total": 2,
    "page": 1,
    "size": 20,
    "items": [
      {
        "id": "rec_001",
        "record_type": "comment",
        "content": "This is a comment",
        "meta": null,
        "task_id": "550e8400-e29b-41d4-a716-446655440000",
        "created_at": "2026-03-19T10:05:00Z",
        "modified_at": "2026-03-19T10:05:00Z"
      },
      {
        "id": "rec_002",
        "record_type": "status_change",
        "content": null,
        "meta": {"from": 0, "to": 1},
        "task_id": "550e8400-e29b-41d4-a716-446655440000",
        "created_at": "2026-03-19T10:10:00Z",
        "modified_at": "2026-03-19T10:10:00Z"
      }
    ]
  }
}

ٹاسک ریکارڈ جواب کے فیلڈز

فیلڈ	قسم	تفصیل
`id`	string	ریکارڈ ID
`record_type`	string	ریکارڈ کی قسم: `comment` / `edit` / `status_change`
`content`	string	کمنٹ کا متن (صرف `comment` قسم کے لیے)
`meta`	object	تبدیلی کی تفصیلات (`edit` اور `status_change` اقسام کے لیے)
`task_id`	string	بنیادی ٹاسک ID
`operated_by`	string	آپریٹر دستخط، مثلاً `claude-code`، `openclaw`
`created_at`	string	تخلیق کا ٹائم اسٹیمپ (ISO 8601)
`modified_at`	string	آخری تبدیلی کا ٹائم اسٹیمپ (ISO 8601)

28. ٹاسک کمنٹ شامل کریں

ٹاسک میں کمنٹ شامل کریں۔

endpoint

POST https://openapi.felo.ai/v2/livedocs/{short_id}/tasks/{task_id}/comments

درخواست باڈی

پیرامیٹر	قسم	لازمی	تفصیل
`content`	string	ہاں	کمنٹ کا مواد
`operated_by`	string	نہیں	آپریٹر دستخط، مثلاً `claude-code`، `openclaw` (زیادہ سے زیادہ 100 حروف)

مثال

curl -X POST 'https://openapi.felo.ai/v2/livedocs/PvyKouzJirXjFdst4uKRK3/tasks/550e8400-e29b-41d4-a716-446655440000/comments' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "content": "This task is now in progress."
  }'

کامیاب جواب (200)

بنایا گیا ریکارڈ آبجیکٹ واپس کرتا ہے (وہی ساخت جو ٹاسک ریکارڈز کی فہرست میں آئٹمز کی ہے)۔

ایرر کوڈز (اپ ڈیٹ شدہ)

کوڈ	HTTP اسٹیٹس	تفصیل
`UNAUTHORIZED`	401	API کلید غلط یا منسوخ ہے
`LIVEDOC_CREATE_FAILED`	502	LiveDoc بنانے میں ناکامی
`LIVEDOC_UPDATE_FAILED`	502	LiveDoc اپ ڈیٹ کرنے میں ناکامی
`LIVEDOC_DELETE_FAILED`	502	LiveDoc حذف کرنے میں ناکامی
`LIVEDOC_NOT_FOUND`	404	LiveDoc نہیں ملا
`LIVEDOC_LIST_FAILED`	502	LiveDocs کی فہرست بنانے میں ناکامی
`LIVEDOC_RESOURCE_CREATE_FAILED`	502	ریسورس بنانے میں ناکامی
`LIVEDOC_RESOURCE_UPLOAD_FAILED`	502	ریسورس اپ لوڈ کرنے میں ناکامی
`LIVEDOC_RESOURCE_DELETE_FAILED`	502	ریسورس حذف کرنے میں ناکامی
`LIVEDOC_RESOURCE_NOT_FOUND`	404	ریسورس نہیں ملا
`LIVEDOC_RESOURCE_LIST_FAILED`	502	ریسورسز کی فہرست بنانے میں ناکامی
`LIVEDOC_RESOURCE_RETRIEVE_FAILED`	502	ریسورسز ریٹریو کرنے میں ناکامی
`LIVEDOC_RESOURCE_ADD_URLS_FAILED`	502	URL ریسورسز شامل کرنے میں ناکامی
`LIVEDOC_README_GET_FAILED`	502	README حاصل کرنے میں ناکامی
`LIVEDOC_README_UPDATE_FAILED`	502	README بنانے یا اپ ڈیٹ کرنے میں ناکامی
`LIVEDOC_README_DELETE_FAILED`	502	README حذف کرنے میں ناکامی
`LIVEDOC_README_NOT_FOUND`	404	README نہیں ملا
`LIVEDOC_TASK_LIST_FAILED`	502	ٹاسکس کی فہرست بنانے میں ناکامی
`LIVEDOC_TASK_CREATE_FAILED`	502	ٹاسک بنانے میں ناکامی
`LIVEDOC_TASK_UPDATE_FAILED`	502	ٹاسک اپ ڈیٹ کرنے میں ناکامی
`LIVEDOC_TASK_DELETE_FAILED`	502	ٹاسک حذف کرنے میں ناکامی
`LIVEDOC_TASK_NOT_FOUND`	404	ٹاسک نہیں ملا
`LIVEDOC_TASK_RECORD_LIST_FAILED`	502	ٹاسک ریکارڈز کی فہرست بنانے میں ناکامی
`LIVEDOC_TASK_COMMENT_CREATE_FAILED`	502	ٹاسک کمنٹ بنانے میں ناکامی