# ウェブ検索を実行し、ランキング順の結果を返す

**API:** Data API

**Endpoint:** `POST /v1/beta/firecrawl/search`

**Tags:** Firecrawl

ウェブを検索し、ランキング順の結果を返します。`query` は必須で、`limit` が件数を設定します。`success`、`creditsUsed`、リクエストの `id`、`url`、`title`、`description`、`position` を持つ `data.web[]` を返します。**タイトルとスニペットのみで、ページテキストは含みません**。次の場合は別のものを選んでください。同じ呼び出しでページテキストも欲しい場合は `searchWeb` が返し、所要時間は 3 分の 1 です。URL がすでに分かっている場合は `post_firecrawl_scrape` です。キーワードではなく意味で関連性を判断したい場合は `post_exa_search` です。

### 料金の参考情報

- 計量方式：結果件数単位で計量。
- 参考リクエスト見積もり：USD 0.002142。
- ユニットコスト基準：USD 0.001071。
- リソースユニット：`firecrawl_credit`。
- 参照用の顧客乗数：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
{
  "additionalProperties": false,
  "properties": {
    "enterprise": {
      "default": false,
      "enum": [
        false
      ],
      "type": "boolean"
    },
    "limit": {
      "default": 10,
      "maximum": 100,
      "minimum": 1,
      "type": "integer"
    },
    "query": {
      "maxLength": 2000,
      "minLength": 1,
      "type": "string"
    },
    "sources": {
      "default": [
        "web"
      ],
      "enum": [
        [
          "web"
        ]
      ],
      "items": {
        "type": "string"
      },
      "maxItems": 1,
      "minItems": 1,
      "type": "array"
    }
  },
  "required": [
    "query"
  ],
  "type": "object"
}
```

Example:

```json
{
  "enterprise": false,
  "limit": 10,
  "query": "nike",
  "sources": [
    "web"
  ]
}
```

## Responses

### 200 — 検索が完了しました。

Headers:
- `X-Request-Id` (string) — Felo サポートに問い合わせる際に伝えるリクエスト識別子。

**application/json**

Schema: object

```json
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "description": "search に成功した場合は true。"
    },
    "data": {
      "type": "object",
      "properties": {
        "web": {
          "type": "array",
          "description": "ランク付けされたウェブ検索結果。",
          "items": {
            "type": "object",
            "properties": {
              "title": {
                "type": "string",
                "description": "結果のタイトル。"
              },
              "url": {
                "type": "string",
                "description": "結果の URL。"
              },
              "description": {
                "type": "string",
                "description": "結果のスニペット。"
              }
            }
          }
        }
      }
    },
    "creditsUsed": {
      "type": "integer",
      "description": "消費した Firecrawl クレジット（10 件の結果につき約 2）。"
    }
  }
}
```

### 400 — リクエストを処理できませんでした。リクエストパラメータを確認してください。

### 401 — 有効な Felo API キーが必要です。

### 402 — 請求要件が満たされていないため、リクエストを続行できません。

### 403 — このアカウントにはこの操作を行う権限がありません。

### 429 — リクエストまたは支出の上限に達しました。

### 502 — サービスがリクエストを完了できませんでした。

### 503 — API または請求サービスが一時的に利用できません。

### 504 — リクエストの処理中にサービスがタイムアウトしました。

### default — エラーレスポンス。上流のパススルーレスポンスはプロバイダーの形式を使用する場合があります

**application/json**

Schema:

```json
{}
```