Felo API PlatformFelo API Platform

Felo APIs

LiveDoc API

नॉलेज बेस बनाएं, संसाधन प्रबंधित करें और सेमांटिक रिट्रीवल और राउटिंग चलाएं।

POST/v2/livedocs

प्रमाणीकरण

Bearer API key

कंटेंट टाइप

application/json or multipart/form-data

दर संबंधी नोट

endpoint-विशिष्ट सीमाएं लागू हो सकती हैं।

यह पृष्ठ मौजूदा /v2 Felo APIs का दस्तावेज़ीकरण करता है, जो Felo account entitlements और Pro-credit rules का उपयोग करती हैं। Credits deduct होंगी या नहीं, यह operation पर निर्भर करता है। Platform-balance calls के लिए, समर्थित Felo OpenAPI endpoint चुनें; request और response shapes अलग हो सकती हैं।

LiveDoc web URLs https://felo.ai/livedoc/{short_id} का उपयोग करती हैं। LiveDoc तक access वाला browser session आवश्यक हो सकता है। प्रत्येक endpoint के लिए API के field names वैसे ही रखें: SuperAgent live_doc_short_id लौटाता है, जबकि mindmap और PPT creation livedoc_short_id लौटाती हैं।

LiveDoc API LiveDocs और उनकी resources के लिए full CRUD operations प्रदान करती है, जिनमें document creation, file upload, URL import, और semantic retrieval शामिल हैं।

AI एजेंटों के साथ उपयोग करें

किसी Agent को LiveDoc support और सभी अन्य उपलब्ध Felo Skills देने के लिए पूरा felo-ai package install करें। Installer SKILL.md वाली हर package directory को dynamically discover करता है, जिसमें future package additions भी शामिल हैं। सभी discovered Skills को Agent की native directory में install करें: Codex ~/.codex/skills, Claude Code ~/.claude/skills, OpenClaw ~/.agents/skills, या Hermes Agent ~/.hermes/skills। manual AI Agent setup guide प्रत्येक platform के लिए अलग API key और verification steps को कवर करती है।

प्रमाणीकरण

सभी requests के लिए Authorization header में API Key आवश्यक है:

Authorization: Bearer YOUR_API_KEY

1. LiveDoc बनाएँ

एंडपॉइंट

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

अनुरोध बॉडी

पैरामीटरप्रकारआवश्यकविवरण
namestringहाँLiveDoc नाम
descriptionstringनहींLiveDoc विवरण
iconstringनहीं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": 200,
  "code": "OK",
  "request_id": "req_example",
  "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"
  }
}

प्रतिक्रिया फ़ील्ड

फ़ील्डप्रकारविवरण
short_idstringLiveDoc ID
namestringLiveDoc नाम
descriptionstringLiveDoc विवरण
iconstringLiveDoc आइकन
created_atstringनिर्माण समय-चिह्न (ISO 8601)
modified_atstringअंतिम संशोधन समय-चिह्न (ISO 8601)
is_sharedbooleanक्या यह LiveDoc वर्तमान उपयोगकर्ता के साथ साझा है (उनका स्वामित्व नहीं)

2. LiveDocs सूचीबद्ध करें

एंडपॉइंट

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

क्वेरी पैरामीटर

पैरामीटरप्रकारआवश्यकविवरण
keywordstringनहींकीवर्ड द्वारा फ़िल्टर करें
pageintegerनहींपृष्ठ संख्या (1-आधारित)
sizeintegerनहींपृष्ठ आकार

उदाहरण

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

सफल प्रतिक्रिया (200)

{
  "status": 200,
  "code": "OK",
  "request_id": "req_example",
  "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..."
        }
      }
    ]
  }
}

प्रतिक्रिया फ़ील्ड

items में प्रत्येक item में Create LiveDoc response जैसे ही fields होते हैं, साथ में:

फ़ील्डप्रकारविवरण
readmeobject | nullREADME जानकारी। यदि कोई README मौजूद नहीं है तो null.
readme.summarystring | nullएक-पंक्ति परियोजना विवरण
readme.contentstring | nullREADME सामग्री (Markdown)

एंडपॉइंट

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

अनुरोध बॉडी

पैरामीटरप्रकारआवश्यकविवरण
namestringनहींनया LiveDoc नाम
descriptionstringनहींनया 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)

Updated LiveDoc object लौटाता है (Create जैसी ही structure)।


4. LiveDoc हटाएँ

एंडपॉइंट

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": 200,
  "code": "OK",
  "request_id": "req_example",
  "message": null,
  "data": null
}

5. संसाधन सूचीबद्ध करें

एंडपॉइंट

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

क्वेरी पैरामीटर

पैरामीटरप्रकारआवश्यकविवरण
resource_typesstring[]नहींसंसाधन प्रकारों द्वारा फ़िल्टर करें
pageintegerनहींपृष्ठ संख्या (1-आधारित)
sizeintegerनहींपृष्ठ आकार

उदाहरण

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

सफल प्रतिक्रिया (200)

{
  "status": 200,
  "code": "OK",
  "request_id": "req_example",
  "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"
      }
    ]
  }
}

संसाधन प्रतिक्रिया फ़ील्ड

फ़ील्डप्रकारविवरण
idstringसंसाधन ID
titlestringसंसाधन शीर्षक
linkstringसंसाधन लिंक/URL
snippetstringसंसाधन सारांश
thumbnailstringथंबनेल URL
resource_typestringसंसाधन प्रकार (जैसे web, ai_doc, file)
resource_keystringसंसाधन संबद्धता कुंजी
statusstringसंसाधन स्थिति
sourcestringसंसाधन स्रोत
created_atstringनिर्माण समय-चिह्न (ISO 8601)
modified_atstringअंतिम संशोधन समय-चिह्न (ISO 8601)

6. एकल संसाधन प्राप्त करें

एंडपॉइंट

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)

एक single resource object लौटाता है (List Resources के items जैसी ही structure)।


7. संसाधन अपडेट करें

किसी resource का title, snippet, या thumbnail अपडेट करें। केवल provided fields update की जाती हैं; omitted fields अपनी current values बनाए रखती हैं।

एंडपॉइंट

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

अनुरोध बॉडी

सभी fields optional हैं।

पैरामीटरप्रकारआवश्यकविवरण
titlestringनहींनया संसाधन शीर्षक (अधिकतम 500 वर्ण)
snippetstringनहींनया संसाधन सारांश (अधिकतम 2000 वर्ण)
thumbnailstringनहींनया थंबनेल 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)

Updated resource object लौटाता है (List Resources के items जैसी ही structure)।


8. संसाधन सामग्री अपडेट करें

किसी ai_doc resource का Markdown content अपडेट करें। यह केवल resource_type == ai_doc वाली resources के लिए supported है। snippet field नए content के पहले 2000 bytes से automatically update होती है।

एंडपॉइंट

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

अनुरोध बॉडी

पैरामीटरप्रकारआवश्यकविवरण
contentstringहाँसंसाधन के लिए नई 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)

Updated resource object लौटाता है (List Resources के items जैसी ही structure)।


9. दस्तावेज़ संसाधन बनाएँ

एंडपॉइंट

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

अनुरोध बॉडी

पैरामीटरप्रकारआवश्यकविवरण
titlestringनहींदस्तावेज़ शीर्षक ("New Document" डिफ़ॉल्ट)
contentstringहाँMarkdown दस्तावेज़ सामग्री; सादा पाठ भी वैध Markdown है

यह एक ai_doc resource बनाता है। JSON string में headings, lists, और links को Markdown के रूप में भेजें, जहाँ newlines \n के रूप में escaped हों। Formatted document content के लिए Markdown उपयोग करें।

उदाहरण

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": "# Research Notes\n\n## Key findings\n\n- First finding\n- Second finding"
  }'

सफल प्रतिक्रिया (200)

Created resource object लौटाता है।


10. फ़ाइल को दस्तावेज़ के रूप में अपलोड करें

एक file upload करें और उसे document resource (ai_doc type) में convert करें।

एंडपॉइंट

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

Content-Type

multipart/form-data

अनुरोध भाग

पैरामीटरप्रकारआवश्यकविवरण
filefileहाँअपलोड की जाने वाली फ़ाइल
titlestringनहींदस्तावेज़ शीर्षक

उदाहरण

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)

Created resource object लौटाता है।


11. फ़ाइल संसाधन अपलोड करें

एक file upload करें और उसका original format बनाए रखें।

एंडपॉइंट

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

Content-Type

multipart/form-data

अनुरोध भाग

पैरामीटरप्रकारआवश्यकविवरण
filefileहाँअपलोड की जाने वाली फ़ाइल

उदाहरण

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

सफल प्रतिक्रिया (200)

Created resource object लौटाता है।


12. URL संसाधन जोड़ें

एक या अधिक URLs को LiveDoc में resources के रूप में जोड़ें।

एंडपॉइंट

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

अनुरोध बॉडी

पैरामीटरप्रकारआवश्यकविवरण
urlsarrayहाँजोड़ने के लिए URL आइटमों की सूची (1–10). प्रत्येक आइटम एक सादा स्ट्रिंग या url और वैकल्पिक title वाला ऑब्जेक्ट हो सकता है।

URL आइटम प्रारूप

urls में प्रत्येक entry इनमें से एक हो सकती है:

  • एक plain string: "https://example.com/article"
  • एक object: {"url": "https://example.com/article", "title": "Custom Title"}
फ़ील्डप्रकारआवश्यकविवरण
urlstringहाँजोड़ने के लिए URL (5–2000 वर्ण)
titlestringनहींसंसाधन के लिए कस्टम शीर्षक (अधिकतम 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": 200,
  "code": "OK",
  "request_id": "req_example",
  "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 परिणाम फ़ील्ड

फ़ील्डप्रकारविवरण
urlstringप्रसंस्कृत URL
statusstringपरिणाम स्थिति: success, failed, या existed
fail_reasonstringविफलता का कारण (सफल होने पर null)
resource_idstringबनाया गया संसाधन ID

13. संसाधन हटाएँ

एंडपॉइंट

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": 200,
  "code": "OK",
  "request_id": "req_example",
  "message": null,
  "data": null
}

14. पुनःप्राप्त करें (अर्थगत खोज)

LiveDoc की resources पर semantic retrieval करें।

एंडपॉइंट

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

अनुरोध बॉडी

पैरामीटरप्रकारआवश्यकविवरण
querystringहाँअर्थगत खोज के लिए क्वेरी सामग्री
resource_idsstring[]नहींजिन विशिष्ट संसाधन 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": 200,
  "code": "OK",
  "request_id": "req_example",
  "message": null,
  "data": [
    {
      "id": "res_001",
      "title": "LLM Research Paper",
      "content": "Relevant content excerpt...",
      "score": 0.92,
      "metadata": {}
    }
  ]
}

पुनःप्राप्ति परिणाम फ़ील्ड

फ़ील्डप्रकारविवरण
idstringसंसाधन ID
titlestringसंसाधन शीर्षक
contentstringमिलान की गई सामग्री
scorenumberप्रासंगिकता स्कोर
metadataobjectअतिरिक्त मेटाडेटा

15. संसाधन रूट करें

Query के आधार पर LiveDoc से relevant resources route करें। Resource IDs की list लौटाता है जिसे retrieve endpoint को pass किया जा सकता है।

एंडपॉइंट

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

अनुरोध बॉडी

पैरामीटरप्रकारआवश्यकविवरण
querystringहाँरूटिंग के लिए क्वेरी सामग्री
max_resourcesintegerनहींलौटाए जाने वाले संसाधन 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": 200,
  "code": "OK",
  "request_id": "req_example",
  "message": null,
  "data": ["res_001", "res_003", "res_007"]
}

16. संसाधन स्रोत फ़ाइल डाउनलोड करें

किसी resource की source file प्राप्त करें। Presigned download URL पर 302 redirect लौटाता है।

यह केवल उन resources के लिए supported है जिनसे source file associated हो (जैसे uploaded documents)।

एंडपॉइंट

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

क्वेरी पैरामीटर

पैरामीटरप्रकारआवश्यकविवरण
expires_inintegerनहींURL समाप्ति समय सेकंड में (डिफ़ॉल्ट: 3600)

उदाहरण

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

प्रतिक्रिया

Location header के साथ 302 Found लौटाता है, जो presigned S3 download URL की ओर point करता है। Redirect support वाले HTTP clients (जैसे curl -L) redirect follow करेंगे और file सीधे download करेंगे।


17. संसाधन सामग्री प्राप्त करें

किसी resource का extracted text content fetch करें। अधिकांश resource types (document, web, video, ai_doc, ai_ppt, text, voice, mindmap, आदि) के लिए supported है। image जैसे unsupported types के लिए 400 लौटाता है।

एंडपॉइंट

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": 200,
  "code": "OK",
  "request_id": "req_example",
  "message": null,
  "data": {
    "title": "Q4 Financial Report",
    "type": "document",
    "content": "Full extracted text content of the resource..."
  }
}

प्रतिक्रिया फ़ील्ड

फ़ील्डप्रकारविवरण
titlestringसंसाधन शीर्षक
typestringसंसाधन प्रकार
contentstringसंसाधन सामग्री; व्याख्या type पर निर्भर करती है, जैसा नीचे वर्णित है

संसाधन सामग्री प्रारूप

data.content एक string है। इसे पढ़ने का तरीका चुनने के लिए data.type उपयोग करें:

संसाधन प्रकारसामग्री प्रारूपपठन चरण
ai_docMarkdownस्ट्रिंग को दस्तावेज़ के रूप में रेंडर या संग्रहीत करें; इसमें SuperAgent शोध रिपोर्ट शामिल हैं
mindmapJSON-एन्कोडेड ऑब्जेक्टlayout और text में Markdown शीर्षक रूपरेखा पढ़ने के लिए एक बार डिकोड करें
ai_pptslides वाला JSON-एन्कोडेड ऑब्जेक्टएक बार डिकोड करें, फिर यदि प्रत्येक स्लाइड की content स्ट्रिंग में JSON हो, तो उसे डिकोड करें
अन्य पाठ-युक्त प्रकारनिष्कर्षित पाठअपने अनुप्रयोग की आवश्यकता के अनुसार पाठ प्रदर्शित करें

Decode करने के बाद mindmap content example:

{
  "layout": "mindMap",
  "text": "# Topic\n## Branch\n### Leaf"
}

Decode करने के बाद PPT content example:

{
  "slides": [
    {
      "page": 1,
      "title": "Introduction",
      "content": "{\"coreIdea\":\"Introduce the topic\",\"slideOverview\":\"Overview of key points\",\"themeDescription\":\"Light background\"}",
      "theme": "light",
      "url": "https://example.com/slide-preview?signature=..."
    }
  ]
}

Slide fields generator पर निर्भर करते हैं और absent हो सकते हैं या additional information शामिल कर सकते हैं। coreIdea, slideOverview, और themeDescription को optional presentation metadata मानें। यदि किसी slide का content plain text हो, तो उसे सीधे प्रदर्शित करें।

Slide url values temporary signed links हैं। उनकी lifetime issue होने के समय निर्धारित होती है; link expire होने पर fresh resource content retrieve करें। PPTX downloads के लिए अलग PPT export workflow उपयोग करें, जिसकी response में expires_at शामिल होता है।


18. PPT पृष्ठ पुनःप्राप्त करें

PPT resource के किसी specific page पर deep content retrieval करें। Slide page को scrape करता है और ranked content chunks लौटाता है। Response format Retrieve endpoint के समान है।

एंडपॉइंट

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

अनुरोध बॉडी

पैरामीटरप्रकारआवश्यकविवरण
resource_idstringहाँPPT संसाधन ID
page_numberintegerहाँपुनःप्राप्त करने के लिए पृष्ठ संख्या (1 से शुरू)
querystringहाँक्या देखना है यह बताने वाली क्वेरी सामग्री
max_chunkintegerनहींवापस करने के लिए अधिकतम chunks की संख्या (डिफ़ॉल्ट: 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": 200,
  "code": "OK",
  "request_id": "req_example",
  "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
      }
    }
  ]
}

प्रतिक्रिया फ़ील्ड

Retrieve Result Fields जैसी ही।


त्रुटि कोड

कोडHTTP स्थितिविवरण
INVALID_API_KEY401API Key अमान्य या निरस्त है
LIVEDOC_CREATE_FAILED502LiveDoc बनाने में विफल
LIVEDOC_UPDATE_FAILED502LiveDoc अपडेट करने में विफल
LIVEDOC_DELETE_FAILED502LiveDoc हटाने में विफल
LIVEDOC_NOT_FOUND404LiveDoc नहीं मिला
LIVEDOC_LIST_FAILED502LiveDocs सूचीबद्ध करने में विफल
LIVEDOC_RESOURCE_CREATE_FAILED502संसाधन बनाने में विफल
LIVEDOC_RESOURCE_UPLOAD_FAILED502संसाधन अपलोड करने में विफल
LIVEDOC_RESOURCE_DELETE_FAILED502संसाधन हटाने में विफल
LIVEDOC_RESOURCE_NOT_FOUND404संसाधन नहीं मिला
LIVEDOC_RESOURCE_LIST_FAILED502संसाधनों की सूची बनाने में विफल
LIVEDOC_RESOURCE_RETRIEVE_FAILED502संसाधन पुनःप्राप्त करने में विफल
LIVEDOC_RESOURCE_ADD_URLS_FAILED502URL संसाधन जोड़ने में विफल

19. README प्राप्त करें

किसी LiveDoc का README content प्राप्त करें। यदि कोई README set नहीं की गई है, तो empty string लौटाता है।

एंडपॉइंट

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": 200,
  "code": "OK",
  "request_id": "req_example",
  "message": null,
  "data": {
    "summary": "A brief one-line description of the project.",
    "content": "# My LiveDoc\n\nThis is the README content in Markdown."
  }
}

प्रतिक्रिया फ़ील्ड

फ़ील्डप्रकारविवरण
summarystring | nullएक-पंक्ति परियोजना विवरण। अधिकतम 2000 वर्ण।
contentstringREADME सामग्री (Markdown)। यदि सेट नहीं है तो खाली स्ट्रिंग।

20. README बनाएँ या अपडेट करें

किसी LiveDoc का README create या update करें (upsert semantics)।

एंडपॉइंट

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

अनुरोध बॉडी

पैरामीटरप्रकारआवश्यकविवरण
summarystringनहींएक-पंक्ति परियोजना विवरण (अधिकतम 2000 वर्ण)
contentstringनहींREADME सामग्री (Markdown)

ध्यान दें: summary या content में से कम से कम एक provide करना आवश्यक है।

उदाहरण

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)

Updated README object लौटाता है (Get README जैसी ही structure)।


21. README में जोड़ें

Existing README के अंत में content append करें। यदि कोई README मौजूद नहीं है, तो provided content के साथ नई README create करता है।

एंडपॉइंट

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

अनुरोध बॉडी

पैरामीटरप्रकारआवश्यकविवरण
contentstringहाँजोड़ने के लिए सामग्री (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)

Append करने के बाद complete README object लौटाता है (Get README जैसी ही structure)।


22. README हटाएँ

किसी LiveDoc की README delete करें।

एंडपॉइंट

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": 200,
  "code": "OK",
  "request_id": "req_example",
  "message": null,
  "data": null
}

23. कार्य सूचीबद्ध करें

किसी LiveDoc में tasks की paginated list प्राप्त करें। Results sort asc, status asc, created_at desc के अनुसार sort होते हैं।

एंडपॉइंट

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

क्वेरी पैरामीटर

पैरामीटरप्रकारआवश्यकविवरण
statusintegerनहींस्थिति द्वारा फ़िल्टर करें: 0=TODO, 1=IN_PROGRESS, 2=DONE
labelsstring[]नहींलेबल द्वारा फ़िल्टर करें (कार्यों में निर्दिष्ट सभी लेबल होने चाहिए)
pageintegerनहींपृष्ठ संख्या (1-आधारित)
sizeintegerनहींपृष्ठ आकार

उदाहरण

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

सफल प्रतिक्रिया (200)

{
  "status": 200,
  "code": "OK",
  "request_id": "req_example",
  "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"
      }
    ]
  }
}

कार्य प्रतिक्रिया फ़ील्ड

फ़ील्डप्रकारविवरण
idstringकार्य ID (UUID)
titlestringकार्य शीर्षक
descriptionstringकार्य विवरण
statusintegerकार्य स्थिति: 0=TODO, 1=IN_PROGRESS, 2=DONE
sortintegerक्रमबद्धता (गैर-ऋणात्मक)
labelsstring[]लेबल सूची
operated_bystringऑपरेटर हस्ताक्षर, जैसे claude-code, openclaw
created_atstringनिर्माण समय-चिह्न (ISO 8601)
modified_atstringअंतिम संशोधन समय-चिह्न (ISO 8601)

24. कार्य बनाएँ

किसी LiveDoc में नया task create करें।

एंडपॉइंट

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

अनुरोध बॉडी

पैरामीटरप्रकारआवश्यकविवरण
titlestringहाँकार्य शीर्षक
descriptionstringनहींकार्य विवरण
statusintegerहाँकार्य स्थिति: 0=TODO, 1=IN_PROGRESS, 2=DONE
sortintegerहाँक्रमबद्धता (गैर-ऋणात्मक पूर्णांक)
labelsstring[]नहींलेबल सूची (अधिकतम 10, प्रत्येक अधिकतम 50 वर्ण)
operated_bystringनहींऑपरेटर हस्ताक्षर, जैसे 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)

Created task object लौटाता है (List Tasks के items जैसी ही structure)।


25. कार्य अपडेट करें

किसी task को partially update करें। केवल provided fields update की जाती हैं; omitted fields अपनी current values बनाए रखती हैं।

एंडपॉइंट

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

अनुरोध बॉडी

सभी fields optional हैं।

पैरामीटरप्रकारआवश्यकविवरण
titlestringनहींनया कार्य शीर्षक
descriptionstringनहींनया कार्य विवरण
statusintegerनहींनई स्थिति: 0=TODO, 1=IN_PROGRESS, 2=DONE
sortintegerनहींनई क्रमबद्धता (गैर-ऋणात्मक)
labelsstring[]नहींनई लेबल सूची (अधिकतम 10, प्रत्येक अधिकतम 50 वर्ण)
operated_bystringनहींऑपरेटर हस्ताक्षर, जैसे 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)

Updated task object लौटाता है (List Tasks के items जैसी ही structure)।


26. कार्य हटाएँ

किसी task को soft-delete करें।

एंडपॉइंट

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": 200,
  "code": "OK",
  "request_id": "req_example",
  "message": null,
  "data": null
}

27. कार्य रिकॉर्ड सूचीबद्ध करें

किसी task के records (comments और change history) की paginated list प्राप्त करें, जो created_at ascending के अनुसार sort होती है।

एंडपॉइंट

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

क्वेरी पैरामीटर

पैरामीटरप्रकारआवश्यकविवरण
record_typestringनहींरिकॉर्ड प्रकार द्वारा फ़िल्टर करें: comment, edit, status_change
pageintegerनहींपृष्ठ संख्या (1-आधारित)
sizeintegerनहींपृष्ठ आकार

उदाहरण

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

सफल प्रतिक्रिया (200)

{
  "status": 200,
  "code": "OK",
  "request_id": "req_example",
  "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"
      }
    ]
  }
}

कार्य रिकॉर्ड प्रतिक्रिया फ़ील्ड

फ़ील्डप्रकारविवरण
idstringरिकॉर्ड ID
record_typestringरिकॉर्ड प्रकार: comment / edit / status_change
contentstringटिप्पणी पाठ (केवल comment प्रकार के लिए)
metaobjectपरिवर्तन विवरण (edit और status_change प्रकारों के लिए)
task_idstringमूल कार्य ID
operated_bystringऑपरेटर हस्ताक्षर, जैसे claude-code, openclaw
created_atstringनिर्माण समय-चिह्न (ISO 8601)
modified_atstringअंतिम संशोधन समय-चिह्न (ISO 8601)

28. कार्य टिप्पणी जोड़ें

किसी task में comment जोड़ें।

एंडपॉइंट

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

अनुरोध बॉडी

पैरामीटरप्रकारआवश्यकविवरण
contentstringहाँटिप्पणी सामग्री
operated_bystringनहींऑपरेटर हस्ताक्षर, जैसे 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)

Created record object लौटाता है (List Task Records के items जैसी ही structure)।


त्रुटि कोड (अद्यतन)

कोडHTTP स्थितिविवरण
INVALID_API_KEY401API Key अमान्य या निरस्त है
LIVEDOC_CREATE_FAILED502LiveDoc बनाने में विफल
LIVEDOC_UPDATE_FAILED502LiveDoc अपडेट करने में विफल
LIVEDOC_DELETE_FAILED502LiveDoc हटाने में विफल
LIVEDOC_NOT_FOUND404LiveDoc नहीं मिला
LIVEDOC_LIST_FAILED502LiveDocs सूचीबद्ध करने में विफल
LIVEDOC_RESOURCE_CREATE_FAILED502संसाधन बनाने में विफल
LIVEDOC_RESOURCE_UPLOAD_FAILED502संसाधन अपलोड करने में विफल
LIVEDOC_RESOURCE_DELETE_FAILED502संसाधन हटाने में विफल
LIVEDOC_RESOURCE_NOT_FOUND404संसाधन नहीं मिला
LIVEDOC_RESOURCE_LIST_FAILED502संसाधनों की सूची बनाने में विफल
LIVEDOC_RESOURCE_RETRIEVE_FAILED502संसाधन पुनःप्राप्त करने में विफल
LIVEDOC_RESOURCE_ADD_URLS_FAILED502URL संसाधन जोड़ने में विफल
LIVEDOC_README_GET_FAILED502README प्राप्त करने में विफल
LIVEDOC_README_UPDATE_FAILED502README बनाने या अपडेट करने में विफल
LIVEDOC_README_DELETE_FAILED502README हटाने में विफल
LIVEDOC_README_NOT_FOUND404README नहीं मिला
LIVEDOC_TASK_LIST_FAILED502कार्य सूचीबद्ध करने में विफल
LIVEDOC_TASK_CREATE_FAILED502कार्य बनाने में विफल
LIVEDOC_TASK_UPDATE_FAILED502कार्य अपडेट करने में विफल
LIVEDOC_TASK_DELETE_FAILED502कार्य हटाने में विफल
LIVEDOC_TASK_NOT_FOUND404कार्य नहीं मिला
LIVEDOC_TASK_RECORD_LIST_FAILED502कार्य रिकॉर्ड सूचीबद्ध करने में विफल
LIVEDOC_TASK_COMMENT_CREATE_FAILED502कार्य टिप्पणी बनाने में विफल

मदद चाहिए?