Felo APIs

SuperAgent API

बातचीत बनाएं, SSE स्ट्रीम पढ़ें, आगे सवाल पूछें और बातचीत का मेटाडेटा देखें।

POST/v2/conversations

प्रमाणीकरण

Bearer API key

कंटेंट टाइप

application/json and text/event-stream

दर संबंधी नोट

Connect to stream immediately. Use offset for reconnects.

LiveDoc API Chat API

SuperAgent API रीयल-टाइम स्ट्रीमिंग आउटपुट और LiveDoc एकीकरण के साथ AI-संचालित संवाद क्षमताएं देती है। सामान्य वर्कफ़्लो है:

बातचीत बनाएं - stream_key, thread_short_id और live_doc_short_id प्राप्त करें
SSE स्ट्रीम पढ़ें - stream_key का उपयोग करके स्ट्रीम endpoint से जुड़ें
फ़ॉलो-अप करें - उसी बातचीत में फ़ॉलो-अप प्रश्न पूछें, नया stream_key पाएं
बातचीत का विवरण देखें - बातचीत का मेटाडेटा लाने के लिए thread_short_id उपयोग करें
LiveDocs प्रबंधित करें - पूर्ण CRUD और संसाधन प्रबंधन के लिए LiveDoc API देखें

प्रमाणीकरण

सभी अनुरोधों के लिए Authorization हेडर में API Key ज़रूरी है:

Authorization: Bearer YOUR_API_KEY

AI Agent के साथ उपयोग करें

Agent को SuperAgent वर्कफ़्लो और हर अन्य उपलब्ध Felo Skill देने के लिए पूरा felo-ai पैकेज इंस्टॉल करें। इंस्टॉलर SKILL.md वाली हर पैकेज डायरेक्टरी को गतिशील रूप से खोजता है, जिसमें भविष्य में जुड़ने वाले पैकेज भी शामिल हैं। सभी खोजी गई Skills को Codex ~/.codex/skills, Claude Code ~/.claude/skills, OpenClaw ~/.agents/skills या Hermes Agent ~/.hermes/skills में इंस्टॉल करें। मैन्युअल AI Agent सेटअप गाइड सुरक्षित इंस्टॉलेशन प्रक्रिया और प्रति-प्लेटफ़ॉर्म कॉन्फ़िगरेशन बताती है।

1. बातचीत बनाएं

Endpoint

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

अनुरोध हेडर

हेडर	आवश्यक	विवरण
`Authorization`	हां	`Bearer YOUR_API_KEY`
`Content-Type`	हां	`application/json`

अनुरोध बॉडी

पैरामीटर	प्रकार	आवश्यक	विवरण
`query`	string	हां	उपयोगकर्ता क्वेरी, 1-2000 अक्षर
`live_doc_short_id`	string	नहीं	मौजूदा LiveDoc का पुनः उपयोग करें; नया बनाने के लिए छोड़ दें
`selected_resource_ids`	array of strings	नहीं	कॉन्टेक्स्ट में शामिल करने के लिए resource ID
`skill_id`	string	नहीं	इस बातचीत के लिए उपयोग करने वाली Skill ID
`accept_language`	string	नहीं	भाषा प्राथमिकता, जैसे `en`
`device_id`	string	नहीं	डिवाइस पहचानकर्ता
`extra`	object	नहीं	SuperAgent को pass through किए जाने वाले अतिरिक्त पैरामीटर
`ext`	object	नहीं	Extension पैरामीटर (जैसे `style_id`, `theme`)

उदाहरण

curl -X POST 'https://openapi.felo.ai/v2/conversations' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": "What is the latest news about AI?",
    "accept_language": "en",
    "skill_id": "your-skill-id",
    "device_id": "device-001",
    "ext": {"style_id": "xxx", "theme": "dark"}
  }'

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

{
  "status": "ok",
  "message": null,
  "data": {
    "stream_key": "sk_abc123xyz",
    "thread_short_id": "TvyKouzJirXjFdst4uKRK3",
    "live_doc_short_id": "PvyKouzJirXjFdst4uKRK3"
  }
}

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

फ़ील्ड	प्रकार	विवरण
`stream_key`	string	SSE स्ट्रीम पढ़ने के लिए उपयोग होने वाली key (धारा 2 देखें)
`thread_short_id`	string	बातचीत ID, बातचीत का विवरण देखने के लिए उपयोग होती है
`live_doc_short_id`	string	संबद्ध LiveDoc ID

2. SSE स्ट्रीम पढ़ें

बातचीत बनाने के बाद, रीयल-टाइम आउटपुट प्राप्त करने के लिए stream_key का उपयोग करके स्ट्रीम endpoint से जुड़ें।

Endpoint

GET https://openapi.felo.ai/v2/conversations/stream/{stream_key}

Query पैरामीटर

पैरामीटर	प्रकार	आवश्यक	विवरण
`offset`	integer	नहीं	इस स्थिति से स्ट्रीमिंग फिर शुरू करें। डिस्कनेक्ट के बाद पुनः कनेक्ट करने के लिए उपयोग करें।

उदाहरण

curl -N 'https://openapi.felo.ai/v2/conversations/stream/sk_abc123xyz' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: text/event-stream'

offset के साथ पुनः कनेक्ट करें:

curl -N 'https://openapi.felo.ai/v2/conversations/stream/sk_abc123xyz?offset=42' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: text/event-stream'

प्रतिक्रिया

प्रतिक्रिया Content-Type: text/event-stream के साथ मानक Server-Sent Events (SSE) स्ट्रीम है।

हर इवेंट SSE फ़ॉर्मेट का पालन करता है:

event: <event_type>
data: <json_payload>

उदाहरण इवेंट:

event: message
data: {"content": "The latest AI news includes..."}

event: done
data: {}

upstream त्रुटि पर:

event: error
data: {"message": "upstream error: 502"}

नोट्स

बातचीत बनाने के तुरंत बाद जुड़ें - stream_key की वैधता विंडो सीमित है।
SSE-सक्षम क्लाइंट उपयोग करें (जैसे ब्राउज़र में EventSource, या टर्मिनल में curl -N)।
done इवेंट मिलने पर या सर्वर द्वारा कनेक्शन बंद करने पर स्ट्रीम समाप्त होती है।

3. बातचीत में फ़ॉलो-अप करें

मौजूदा बातचीत में फ़ॉलो-अप प्रश्न पूछें। प्रतिक्रिया स्ट्रीम पढ़ने के लिए नया stream_key लौटाता है।

Endpoint

POST https://openapi.felo.ai/v2/conversations/{thread_short_id}/follow_up

अनुरोध हेडर

हेडर	आवश्यक	विवरण
`Authorization`	हां	`Bearer YOUR_API_KEY`
`Content-Type`	हां	`application/json`

अनुरोध बॉडी

पैरामीटर	प्रकार	आवश्यक	विवरण
`query`	string	हां	फ़ॉलो-अप प्रश्न, 1-2000 अक्षर

उदाहरण

curl -X POST 'https://openapi.felo.ai/v2/conversations/TvyKouzJirXjFdst4uKRK3/follow_up' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": "Can you elaborate on that?"
  }'

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

{
  "status": "ok",
  "message": null,
  "data": {
    "stream_key": "sk_def456uvw",
    "thread_short_id": "TvyKouzJirXjFdst4uKRK3",
    "live_doc_short_id": "PvyKouzJirXjFdst4uKRK3"
  }
}

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

फ़ील्ड	प्रकार	विवरण
`stream_key`	string	इस फ़ॉलो-अप के लिए SSE स्ट्रीम पढ़ने की key
`thread_short_id`	string	अनुरोध जैसी ही बातचीत ID
`live_doc_short_id`	string	संबद्ध LiveDoc ID

4. बातचीत का विवरण देखें

Endpoint

GET https://openapi.felo.ai/v2/conversations/{thread_short_id}

उदाहरण

curl 'https://openapi.felo.ai/v2/conversations/TvyKouzJirXjFdst4uKRK3' \
  -H 'Authorization: Bearer YOUR_API_KEY'

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

{
  "status": "ok",
  "message": null,
  "data": {
    "thread_short_id": "TvyKouzJirXjFdst4uKRK3",
    "title": "What is the latest news about AI?",
    "created_at": "2026-03-09T10:00:00Z",
    "updated_at": "2026-03-09T10:00:30Z",
    "live_doc_short_id": "PvyKouzJirXjFdst4uKRK3"
  }
}

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

फ़ील्ड	प्रकार	विवरण
`thread_short_id`	string	बातचीत ID
`title`	string	बातचीत का शीर्षक (क्वेरी से व्युत्पन्न)
`created_at`	string	निर्माण टाइमस्टैम्प (ISO 8601)
`updated_at`	string	अंतिम अपडेट टाइमस्टैम्प (ISO 8601)
`live_doc_short_id`	string	संबद्ध LiveDoc ID

त्रुटि कोड

कोड	HTTP स्टेटस	विवरण
`UNAUTHORIZED`	401	API Key अमान्य या रद्द है
`SUPER_AGENT_CONVERSATION_CREATE_FAILED`	502	बातचीत बनाने में विफल (downstream त्रुटि)
`SUPER_AGENT_CONVERSATION_FOLLOW_UP_FAILED`	502	बातचीत में फ़ॉलो-अप विफल (downstream त्रुटि)
`SUPER_AGENT_CONVERSATION_QUERY_FAILED`	502	बातचीत का विवरण देखने में विफल (downstream त्रुटि)

सामान्य एकीकरण प्रवाह

1. POST /v2/conversations                              → get stream_key + thread_short_id + live_doc_short_id
2. GET  /v2/conversations/stream/{stream_key}          → consume SSE until "done"
3. POST /v2/conversations/{thread_short_id}/follow_up  → ask follow-up, get new stream_key
4. GET  /v2/conversations/stream/{new_stream_key}      → consume follow-up SSE until "done"
5. GET  /v2/conversations/{thread_short_id}            → fetch conversation metadata

LiveDoc प्रबंधन (CRUD, resource upload, URL import, पुनर्प्राप्ति) के लिए LiveDoc API देखें।