Felo API PlatformFelo API Platform

गाइड

Data API अवलोकन

एक साझा प्रीफ़िक्स से तृतीय-पक्ष endpoints कॉल करें और प्रमाणीकरण व अनुरोध प्रोसेसिंग एक जैसी रखें।

Data API एक Felo key के पीछे तृतीय-पक्ष API का कैटलॉग है। यह Felo की स्वयं की /v2 API और Model API से अलग है।

साझा prefix

https://openapi.felo.ai/v1/beta

संदर्भ हर endpoint को /v1/beta से शुरू होने वाले पूर्ण पथ के रूप में दिखाता है। उसी पथ को host पर जैसा है वैसा उपयोग करें; साझा prefix दोबारा न जोड़ें। उदाहरण के लिए, Tavily search endpoint है:

POST https://openapi.felo.ai/v1/beta/tavily/search

endpoint खोजें

  • API directory को आपूर्तिकर्ता के अनुसार ब्राउज़ करें।
  • पूरी endpoint सूची, पैरामीटर और response schema के लिए Data API संदर्भ खोलें।
  • आपूर्तिकर्ताओं के बीच जाने के लिए संदर्भ के tags का उपयोग करें।

हर आपूर्तिकर्ता अपना अनुरोध स्वरूप रखता है। साझा परत प्रमाणीकरण और रूटिंग को मानकीकृत करती है, payload को नहीं। अनुरोध भेजने से पहले endpoint schema पढ़ें।

प्रमाणीकरण

इनमें से कोई भी हेडर उपयोग करें:

Authorization: Bearer $FELO_API_KEY

या:

X-API-Key: $FELO_API_KEY

JSON body के लिए Content-Type: application/json भेजें।

उदाहरण अनुरोध

curl https://openapi.felo.ai/v1/beta/tavily/search \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "What is Felo AI?",
    "max_results": 3
  }'

प्रतिक्रिया का स्वरूप आपूर्तिकर्ता से आता है। results, pagination cursors और metadata जैसे फ़ील्ड प्रदाताओं के बीच सामान्यीकृत नहीं हैं।

परंपराएं

विषयक्या अपेक्षित है
Payloadआपूर्तिकर्ता-विशिष्ट JSON; endpoint schema का पालन करें
Paginationफ़ील्ड नाम और cursor शैलियां endpoint के अनुसार बदलती हैं
त्रुटियांstatus, code, message और request_id वाला JSON; प्रदाता विवरण message में दिख सकते हैं
दर सीमाएंendpoint और आपूर्तिकर्ता विशिष्ट; लोड के समय 429 की अपेक्षा करें
बिलिंगप्रति कॉल, Model API के उसी सेवा क्रेडिट बैलेंस से

त्रुटि प्रबंधन

प्रमाणीकरण विफलता प्लेटफ़ॉर्म के बाकी हिस्सों जैसा ही envelope लौटाती है:

{
  "status": 401,
  "code": "UNAUTHORIZED",
  "message": "Invalid API Key",
  "request_id": "..."
}

प्रदाता-स्तरीय विफलता के लिए, HTTP स्टेटस और message पढ़ें। method, पूरा पथ, request body का स्वरूप और request_id लॉग करें। पूरी API key लॉग न करें।

पुनः प्रयास

429 और 5xx प्रतिक्रियाओं को backoff के साथ दोबारा प्रयास करें। 400 या 401 को बिना बदलाव दोबारा प्रयास न करें। कुछ प्रदाता संचालन दोहराने के लिए सुरक्षित नहीं हैं; write दोबारा प्रयास करने से पहले endpoint जांचें।

इसके बजाय Felo API कब उपयोग करें

जब आपको कोई विशेष तृतीय-पक्ष डेटा स्रोत चाहिए तो Data API का उपयोग करें। जब आप Felo का अपना वर्कफ़्लो चाहते हैं तो Felo API का उपयोग करें:

  • उद्धरणों के साथ सर्च-आधारित उत्तर: Chat API
  • स्लाइड जनरेशन: PPT Task API
  • Landing pages: Landing Page Task API
  • नॉलेज बेस और पुनर्प्राप्ति: LiveDoc API
  • स्ट्रीमिंग के साथ agent बातचीत: SuperAgent API

संबंधित