# AI 向けのリアルタイムウェブ検索。 **API:** Data API **Endpoint:** `POST /v1/beta/byteplus/web-search` **Tags:** BytePlus AI エージェント向けのリアルタイムウェブ検索を実行し、タイトル、リンク、スニペットを含む関連度順の結果リストを返します。`Query` は必須です。`Count`（20 以下）、`Filter`（`Sites` に限定、または `BlockHosts` を除外）、`Language`、`TimeRange` で結果セットを絞り込めます。レスポンスは `ResponseMetadata.RequestId` とウェブ結果の `Result` リストでラップされます。RAG の検索拡張、競合・PR モニタリング、ファクトチェック、コンテンツ調達に適しています。各結果の URL を `post_byteplus_fetch` と組み合わせるとページ全文を取得できます。 ### 料金の参考情報 - 計測方法：成功リクエストあたりの固定コスト基準。 - 参考リクエスト見積もり：USD 0.0048。 - 参照用の顧客乗数：1.0。確定済みの顧客金額には再適用しないでください。 参考情報のメタデータであり、アカウントへの見積もり、保証された価格、支出上限ではありません。リソースクレジットは Felo クレジットではありません。最終的な請求は Felo の請求記録に従います。 ## Base URL - `https://openapi.felo.ai` ## Authentication - `FeloBearerAuth` (http bearer, bearer format Felo API Key) - `FeloApiKey` (apiKey in header `X-API-Key`) ## Request body Required: **yes** ### application/json Schema: ```json { "type": "object", "properties": { "Query": { "type": "string", "description": "検索クエリ。必須です。最大 400 文字。上流のエンジンでは実質的に約 50 語までに制限されます。", "example": "OpenAI news", "maxLength": 400 }, "Count": { "type": "integer", "description": "返す結果数。任意です。既定は 10、最大 20。", "maximum": 20, "example": 10, "default": 10 }, "Filter": { "type": "object", "description": "任意の結果フィルター。どちらのフィールドも、完全なドメインをパイプ区切りにした文字列です（各最大 5 件）。", "properties": { "Sites": { "type": "string", "description": "結果をこれらの完全なドメインに限定します。パイプ区切り、最大 5 件。例：「bytedance.com|byteplus.com」。（配列を送信すると 10400 Invalid Parameter が返ります。）", "example": "bytedance.com|byteplus.com" }, "BlockHosts": { "type": "string", "description": "これらの完全なドメインからの結果を除外します。パイプ区切り、最大 5 件。例：「reddit.com|quora.com」。", "example": "reddit.com|quora.com" } } }, "Language": { "type": "string", "description": "任意の言語ヒント。上流の形式で指定します（例：EN、ZH-HANS、ZH-HANT）。", "example": "EN" }, "TimeRange": { "description": "任意の時間範囲。OneDay / OneWeek / OneMonth / OneYear のいずれかの名前付き範囲、またはカスタム範囲「YYYY-MM-DD..YYYY-MM-DD」を指定します。省略すると時間フィルターは適用されません。注意：「week」「month」などの値は上流で黙って無視されます。", "oneOf": [ { "type": "string", "enum": [ "OneDay", "OneWeek", "OneMonth", "OneYear" ] }, { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}\\.\\.\\d{4}-\\d{2}-\\d{2}$", "description": "カスタム範囲（例：2026-08-01..2026-09-01）。" } ], "example": "OneWeek" } }, "required": [ "Query" ] } ``` Example: ```json { "Query": "OpenAI news" } ``` ## Responses ### 200 — 検索が正常に完了しました。`Result` にランク付けされたウェブ結果が含まれます。 Headers: - `X-Request-Id` (string) — Felo サポートに問い合わせる際に伝えるリクエスト識別子。 **application/json** Schema: object ```json { "type": "object", "properties": { "ResponseMetadata": { "type": "object", "description": "上流のリクエストメタデータ。", "properties": { "RequestId": { "type": "string", "description": "このリクエストの一意の識別子。" }, "Action": { "type": "string" }, "Version": { "type": "string" }, "Service": { "type": "string" }, "Region": { "type": "string" } } }, "Result": { "type": "object", "description": "検索結果のペイロード。", "properties": { "ResultCount": { "type": "integer", "description": "返されたウェブ結果の数。" }, "WebResults": { "type": "array", "description": "順位付けされたウェブ結果のリスト。", "items": { "type": "object", "properties": { "Id": { "type": "string", "description": "不透明な結果 ID。" }, "SortId": { "type": "integer", "description": "結果の順位（1 始まり）。" }, "Title": { "type": "string", "description": "結果のタイトル。" }, "SiteName": { "type": "string", "description": "ソースサイト名（空の場合があります）。" }, "Url": { "type": "string", "description": "結果の URL。" }, "Snippet": { "type": "string", "description": "ページからの短いテキストスニペット。" }, "Summary": { "type": "string", "description": "ページ内容のより長い要約。" }, "PublishTime": { "type": "string", "description": "ISO 8601 形式の公開日時（空の場合があります）。" }, "PublishTimeUnix": { "type": "integer", "description": "公開日時（Unix 秒、不明な場合は 0）。" }, "LogoUrl": { "type": "string", "description": "署名付きのサイトロゴ URL（期限あり）。" } } } }, "SearchContext": { "type": "object", "description": "解決済みクエリコンテキストのエコー。", "properties": { "OriginQuery": { "type": "string" }, "SearchType": { "type": "string" } } }, "TimeCost": { "type": "integer", "description": "上流の処理時間（ミリ秒）。" }, "LogId": { "type": "string", "description": "上流のログ ID（ResponseMetadata.RequestId と等しい）。" }, "Choices": { "type": [ "array", "null" ], "description": "予約済み。該当しない場合は null。", "items": { "type": "object" } }, "Usage": { "type": [ "object", "null" ], "description": "予約済み。該当しない場合は null。" } } } } } ``` Example: ```json { "ResponseMetadata": { "RequestId": "20260904155503A787EC832774768DC56F", "Action": "", "Version": "", "Service": "", "Region": "" }, "Result": { "ResultCount": 3, "WebResults": [ { "Id": "19b903d59c017bbb04c7832574500d49", "SortId": 1, "Title": "OpenAI News | OpenAI", "SiteName": "OpenAI", "Url": "https://openai.com/news/", "Snippet": "Stay up to speed on the rapid advancement of AI technology and the benefits it offers to humanity.", "Summary": "Stay up to speed on the rapid advancement of AI technology and the benefits it offers to humanity.", "PublishTime": "2026-09-03T07:50:20+08:00", "PublishTimeUnix": 1788393020, "LogoUrl": "https://p16-bpsearch-sign.ibyteimg.com/..." } ], "SearchContext": { "OriginQuery": "OpenAI latest news", "SearchType": "web" }, "TimeCost": 935, "LogId": "20260904155503A787EC832774768DC56F", "Choices": null, "Usage": null } } ``` ### 400 — リクエストを処理できませんでした。リクエストパラメータを確認してください。 ### 401 — 有効な Felo API キーが必要です。 ### 402 — 請求要件が満たされていないため、リクエストを続行できません。 ### 403 — このアカウントにはこの操作を行う権限がありません。 ### 429 — リクエストまたは支出の上限に達しました。 ### 502 — サービスがリクエストを完了できませんでした。 ### 503 — API または請求サービスが一時的に利用できません。 ### 504 — リクエストの処理中にサービスがタイムアウトしました。 ### default — エラーレスポンス。上流のパススルーレスポンスはプロバイダーの形式を使用する場合があります **application/json** Schema: ```json {} ```