Felo API PlatformFelo API Platform

ガイド

Data API 概要

共通プレフィックス経由でサードパーティの endpoint を呼び、認証とリクエスト処理を一貫させます。

Data API は、1 つの Felo key の背後にあるサードパーティ API のカタログです。Felo 独自の /v2 API や Model API とは別物です。

共通プレフィックス

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

リファレンスでは各 endpoint を /v1/beta で始まる完全なパスとして表示しています。host 上ではそのパスをそのまま使い、共通プレフィックスを再度付けないでください。たとえば Tavily の検索 endpoint は次のとおりです。

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

endpoint を探す

  • API ディレクトリをプロバイダー別に閲覧します。
  • 完全な endpoint 一覧、パラメータ、レスポンス schema は Data API reference を開いてください。
  • リファレンスの tag を使ってプロバイダー間を移動できます。

各プロバイダーは独自のリクエスト形式を持ちます。共通レイヤーが標準化するのは認証とルーティングであり、payload ではありません。リクエストを送る前に 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 cursor、metadata などのフィールドはプロバイダー間で正規化されません。

規約

項目期待されること
Payloadプロバイダー固有の JSON。endpoint schema に従う
Paginationフィールド名や cursor の形式は endpoint ごとに異なる
Errorsstatus、code、message、request_id を含む JSON。プロバイダーの詳細が message に現れることがある
Rate limitsendpoint とプロバイダーに依存。負荷時は 429 を想定する
Billing呼び出しごと。Model API と同じサービス利用枠から支払う

エラー処理

認証に失敗すると、プラットフォームの他の部分と同じ封筒が返ります。

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

プロバイダーレベルの失敗では、HTTP ステータスと message を読みます。method、完全なパス、リクエストボディの形、request_id を記録してください。API key 全体は記録しないでください。

リトライ

429 と 5xx はバックオフ付きで再試行します。400 や 401 をそのまま再試行しないでください。プロバイダーの操作には繰り返しに適さないものがあります。書き込みを再試行する前に endpoint を確認してください。

Felo API を使うべき場合

特定のサードパーティデータソースが必要なときに Data API を使います。Felo 独自のワークフローが欲しいときは Felo API を使います。

関連