# Felo API セットアップ

検索、Web コンテンツ、X データ、プレゼンテーションのために、プラットフォーム残高を使用して Data API で Felo エンドポイントをセットアップします。

Felo は [Data API](https://openapi.felo.ai/ja/docs/data-api) の 1 つのプロバイダーで、Web 検索、Web 読み取り、X データ、検索基盤の回答、プレゼンテーションを提供します。各 Felo エンドポイントは、関連する Data API カテゴリ内で他のプロバイダーと並んで見つけられます。

これらのエンドポイントは **プラットフォーム残高** と `/api/v1/data` プレフィックスを使用します。このガイドでは、認証、最初のリクエスト、課金ルールの場所について説明します。

Felo Pro クレジットを使うには、[既存の Felo API](https://openapi.felo.ai/ja/docs/api-reference/felo-apis.md) を参照してください。プラットフォーム残高と Pro クレジットは別物です。

## 最初のリクエストを送る

1. [Console → API Keys](https://openapi.felo.ai/console/api-keys) でキーを作成します。
2. [Console → Billing](https://openapi.felo.ai/console/billing) で **プラットフォーム残高** を確認するか、チャージします。
3. サーバーまたはローカルシェルでキーを設定します:

```bash
export FELO_API_KEY="YOUR_API_KEY"
```

`Authorization: Bearer $FELO_API_KEY` を送信します。`X-API-Key` も受け付けられるため、認証方法はどちらか 1 つを選んでください。JSON リクエストでは `Content-Type: application/json` が必要です。

```bash
curl -sS --request POST "https://openapi.felo.ai/api/v1/data/web/search" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"What is retrieval augmented generation?","count":3}'
```

HTTP 200 は、ページタイトル、リンク、スニペットを含む `resources` 配列と `total` を返します。会話形式の回答は生成しません。その場合は [Chat](https://openapi.felo.ai/ja/docs/data-api/guides/felo-chat.md) を使用してください。

## API を確認する

| ガイド | 操作 | 返される内容 | 課金単位 |
|---|---|---|---|
| [ウェブ検索](https://openapi.felo.ai/ja/docs/data-api/guides/felo-web-search.md) | Web を検索する | ページタイトル、リンク、スニペット | リクエスト |
| [ウェブページ取得](https://openapi.felo.ai/ja/docs/data-api/guides/felo-web-read.md) | URL を読み取る | Markdown、テキスト、HTML、またはスクリーンショット | リクエスト |
| [X データ](https://openapi.felo.ai/ja/docs/data-api/guides/felo-x-data.md) | プロフィール、ユーザー検索、ユーザー投稿、投稿検索、返信 | 構造化されたユーザーと投稿。対応している場合はページ分割付き | 返された結果 |
| [ウェブ検索付きチャット](https://openapi.felo.ai/ja/docs/data-api/guides/felo-chat.md) | 質問に答える | 回答と Web ソース | リクエスト |
| [PPT](https://openapi.felo.ai/ja/docs/data-api/guides/felo-ppt.md) | 作成、ステータス、結果、エクスポート、エクスポートステータス、削除 | 生成タスクとダウンロード可能な PPTX | 生成ページごと。エクスポートは別途課金 |
| [課金とエラー](https://openapi.felo.ai/ja/docs/data-api/guides/felo-billing.md) | 共通の統合ガイダンス | 価格、残高の取り扱い、再試行ルール | — |

これらのガイド全体で **14 のコア操作** があります。PPT 作成が `stream_key` を返す場合、[PPT ガイド](https://openapi.felo.ai/ja/docs/data-api/guides/felo-ppt.md#sse-生成-読-取) には SSE で生成イベントを読み取る方法も記載されています。ステータスおよび結果の照会、export-status の照会、削除では新しい課金は発生しません。

## 既存の統合を移行する前に

呼び出している正確なエンドポイントのガイドを使用してください。`/v2` を `/api/v1/data` に置き換えるだけでは、完全な移行にはなりません:

- ウェブページ取得 は `/web/read` を使用し、1 回のリクエストにつき出力形式は 1 つです。
- Chat は `status: "ok"` を返し、非ストリーミング JSON のみをサポートします。
- PPT の結果は **POST** `/tasks/{task_id}/historical` を使用します。
- PPT 作成は JSON ルートで識別子を返します。`task_id` と `ppt_business_id` の両方を保存してください。
- 生成された PPT は 7 日後に期限切れになります。期限切れ前にエクスポートしてファイルを保存してください。

LiveDoc CRUD、Mindmap、SuperAgent など、ここで文書化されているすべての `/v2` ワークフローに対するネイティブの OpenAPI 相当はありません。引き続き、それぞれの [Felo APIs ガイド](https://openapi.felo.ai/ja/docs/api-reference/felo-apis.md) と Pro クレジット課金を使用してください。

## 契約と現在の価格

- [公開された OpenAPI スキーマ](https://openapi.felo.ai/api/v1/data/openapi.json) — フィールド定義とレスポンススキーマ。
- [OpenAPI YAML スキーマ](https://openapi.felo.ai/api/v1/data/openapi.yaml) — YAML を受け付けるツール向け。
- [現在の価格](https://openapi.felo.ai/api/v1/data/prices) — 操作 ID、課金単位、現在の料金。

これらのリソースは公開されており、キーなしで読み取れます。自動再試行を追加する前に [課金とエラー](https://openapi.felo.ai/ja/docs/data-api/guides/felo-billing.md) を参照してください。