Felo API PlatformFelo API Platform

راهنماها

نمای کلی Data API

endpointهای شخص ثالث را از طریق یک پیشوند مشترک، با احراز هویت و مدیریت درخواست یکسان فراخوانی کنید.

Data API کاتالوگی از APIهای شخص ثالث پشت یک کلید Felo است. این API از APIهای /v2 خود Felo و از Model API جداست.

پیشوند مشترک

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

مرجع هر endpoint را به‌صورت مسیر کاملِ آغازشده با /v1/beta نشان می‌دهد. همان مسیر را بی‌تغییر روی میزبان به کار ببرید؛ پیشوند مشترک را دوباره پیش نگذارید. برای نمونه، endpoint جستجوی Tavily این است:

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

یافتن endpoint

  • فهرست API را بر اساس تأمین‌کننده مرور کنید.
  • برای فهرست کامل endpointها، پارامترها و طرح‌واره پاسخ، مرجع Data API را باز کنید.
  • با برچسب‌های مرجع بین تأمین‌کنندگان جابه‌جا شوید.

هر تأمین‌کننده شکل درخواست خودش را نگه می‌دارد. لایه مشترک احراز هویت و مسیریابی را یکسان می‌کند، نه محموله را. پیش از ارسال درخواست، طرح‌واره endpoint را بخوانید.

احراز هویت

از هر یک از این دو سرآیند استفاده کنید:

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
  }'

شکل پاسخ از تأمین‌کننده می‌آید. فیلدهایی مانند نتایج، مکان‌نمای صفحه‌بندی و فراداده در ارائه‌دهندگان مختلف یکسان‌سازی نمی‌شوند.

قراردادها

موضوعچه انتظاری داشته باشید
محمولهJSON مخصوص تأمین‌کننده؛ طرح‌واره endpoint را دنبال کنید
صفحه‌بندینام فیلدها و سبک مکان‌نما بر حسب endpoint متفاوت است
خطاهاJSON با status، code، message و request_id؛ جزئیات ارائه‌دهنده ممکن است در message ظاهر شود
محدودیت نرخمخصوص endpoint و تأمین‌کننده؛ زیر بار 429 انتظار داشته باشید
صورت‌حساببرای هر فراخوانی، از همان مانده اعتبار سرویس Model API

مدیریت خطا

شکست احراز هویت همان پوشش خطای بقیه پلتفرم را برمی‌گرداند:

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

برای شکست در سطح ارائه‌دهنده، وضعیت HTTP و message را بخوانید. متد، مسیر کامل، شکل بدنه درخواست و request_id را ثبت کنید. کلید API کامل را ثبت نکنید.

تلاش دوباره

پاسخ‌های 429 و 5xx را با عقب‌نشینی دوباره تلاش کنید. 400 یا 401 را بی‌تغییر دوباره تلاش نکنید. برخی عملیات ارائه‌دهنده تکرارپذیر نیستند؛ پیش از تلاش دوباره برای یک نوشتن، endpoint را بررسی کنید.

چه وقت به‌جای آن از یک Felo API استفاده کنید

وقتی به منبع داده مشخص شخص ثالث نیاز دارید از Data API استفاده کنید. وقتی گردش‌کار خود Felo را می‌خواهید از یک Felo API استفاده کنید:

مرتبط