Felo API PlatformFelo API Platform

رہنما

Data API کا جائزہ

فریق ثالث endpoints کو ایک مشترکہ سابقہ کے ذریعے کال کریں، مستقل تصدیق اور درخواست کی کارروائی کے ساتھ۔

Data API ایک Felo کلید کے پیچھے تیسرے فریق کی APIs کا کیٹلاگ ہے۔ یہ Felo کی اپنی /v2 APIs اور Model API سے الگ ہے۔

مشترکہ پریفکس

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

ریفرنس ہر endpoint کو /v1/beta سے شروع ہونے والے مکمل راستے کے طور پر دکھاتا ہے۔ ہوسٹ پر وہی راستہ ویسا ہی استعمال کریں؛ مشترکہ پریفکس دوبارہ نہ لگائیں۔ مثال کے طور پر، Tavily سرچ endpoint یہ ہے:

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

endpoint تلاش کریں

  • API ڈائریکٹری کو فراہم کنندہ کے لحاظ سے براؤز کریں۔
  • مکمل endpoint فہرست، پیرامیٹرز اور response schemas کے لیے Data API ریفرنس کھولیں۔
  • فراہم کنندگان کے درمیان جانے کے لیے ریفرنس کے tags استعمال کریں۔

ہر فراہم کنندہ اپنی درخواست کی ساخت رکھتا ہے۔ مشترکہ پرت تصدیق اور روٹنگ کو یکساں کرتی ہے، پے لوڈ کو نہیں۔ درخواست بھیجنے سے پہلے endpoint کا schema پڑھیں۔

تصدیق

اِن میں سے کوئی بھی ہیڈر استعمال کریں:

Authorization: Bearer $FELO_API_KEY

یا:

X-API-Key: $FELO_API_KEY

JSON باڈیز کے لیے 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 جیسے فیلڈز تمام فراہم کنندگان میں یکساں نہیں کیے جاتے۔

رواج

موضوعکیا توقع رکھیں
پے لوڈفراہم کنندہ کے مخصوص JSON؛ endpoint کے schema کی پیروی کریں
paginationفیلڈ کے نام اور cursor کے انداز endpoint کے لحاظ سے مختلف
ایررزJSON بمع status، code، message اور request_id؛ فراہم کنندہ کی تفصیلات پیغام میں آ سکتی ہیں
ریٹ کی حدودendpoint اور فراہم کنندہ کے مخصوص؛ بوجھ کے وقت 429 کی توقع رکھیں
بلنگفی کال، Model API کے اُسی سروس کریڈٹ بیلنس سے

ایرر ہینڈلنگ

تصدیق کی ناکامی پلیٹ فارم کے باقی حصوں جیسی ہی انویلپ واپس کرتی ہے:

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

فراہم کنندہ کی سطح کی ناکامی کے لیے HTTP اسٹیٹس اور پیغام پڑھیں۔ میتھڈ، مکمل راستہ، درخواست باڈی کی ساخت اور request_id لاگ کریں۔ مکمل API کلید لاگ نہ کریں۔

دوبارہ کوششیں

429 اور 5xx جوابات پر بیک آف کے ساتھ دوبارہ کوشش کریں۔ 400 یا 401 پر بغیر تبدیلی دوبارہ کوشش نہ کریں۔ کچھ فراہم کنندہ آپریشنز کو دہرانا محفوظ نہیں؛ کسی write کو دوبارہ بھیجنے سے پہلے endpoint چیک کریں۔

کب Felo API استعمال کریں

جب آپ کو کوئی مخصوص تیسرے فریق کا ڈیٹا ماخذ درکار ہو تو Data API استعمال کریں۔ جب آپ Felo کا اپنا ورک فلو چاہتے ہوں تو Felo API استعمال کریں:

متعلقہ