# Tavily Crawl を使用したグラフベースのウェブサイト巡回ツール。

**API:** Data API

**Endpoint:** `POST /v1/beta/tavily/crawl`

**Tags:** Web Content

ルート `url` からサイトを巡回し、見つかったページの内容を返します。自然言語の `instructions` と正規表現によるパス・ドメインフィルターで誘導し、`max_depth`、`max_breadth`、`limit` で範囲を制限します。`base_url` と、`url` および `raw_content` を含む `results[]` を返します。1 つのサイトを広くカバーする用途（ドキュメント、カタログ、競合のブログなど）に適しています。同期的に応答する点が `post_firecrawl_crawl` と異なります。後者はバックグラウンドジョブとして実行され、待ち時間が許容できない大規模なクロールに向いています。

### 料金の参考情報

- 計測方法：レスポンスユニット単位で計測。
- 参考リクエスト見積もり：0.024 USD。
- ユニットコスト基準：USD 0.008。
- リソースユニット：`tavily_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
{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "クロールを開始するルート URL。",
      "example": "docs.tavily.com"
    },
    "instructions": {
      "type": "string",
      "description": "クローラー向けの自然言語による指示。"
    },
    "chunks_per_source": {
      "type": "integer",
      "default": 3,
      "description": "ソースごとに返される関連チャンクの最大数。",
      "minimum": 1,
      "maximum": 5
    },
    "max_depth": {
      "type": "integer",
      "default": 1,
      "description": "クロールの最大深度。",
      "minimum": 1,
      "maximum": 5
    },
    "max_breadth": {
      "type": "integer",
      "default": 20,
      "description": "ツリーの各レベルでたどるリンクの最大数。",
      "minimum": 1,
      "maximum": 500
    },
    "limit": {
      "type": "integer",
      "default": 50,
      "description": "クローラーが停止するまでに処理するリンクの総数。",
      "minimum": 1
    },
    "select_paths": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "特定のパスパターンを持つ URL のみを選択する正規表現パターン。"
    },
    "select_domains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "クロールを特定のドメインやサブドメインに限定する正規表現パターン。"
    },
    "exclude_paths": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "特定のパスパターンを持つ URL を除外する正規表現パターン。"
    },
    "exclude_domains": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "クロール時に特定のドメインやサブドメインを除外する正規表現パターン。"
    },
    "allow_external": {
      "type": "boolean",
      "default": true,
      "description": "最終結果リストに外部ドメインのリンクを含めます。"
    },
    "include_images": {
      "type": "boolean",
      "default": false,
      "description": "クロール結果に画像を含めます。"
    },
    "extract_depth": {
      "type": "string",
      "enum": [
        "basic",
        "advanced"
      ],
      "default": "basic",
      "description": "抽出プロセスの深度。"
    },
    "format": {
      "type": "string",
      "enum": [
        "markdown",
        "text"
      ],
      "default": "markdown",
      "description": "抽出されたウェブページコンテンツの形式。"
    },
    "include_favicon": {
      "type": "boolean",
      "default": false,
      "description": "各結果のファビコン URL を含めます。"
    },
    "timeout": {
      "type": "number",
      "format": "float",
      "default": 150,
      "description": "クロール操作の最大待機時間（秒）。",
      "minimum": 10,
      "maximum": 150
    },
    "include_usage": {
      "type": "boolean",
      "default": false,
      "description": "レスポンスにクレジット使用量の情報を含めます。"
    }
  },
  "required": [
    "url"
  ]
}
```

## Responses

### 200 — クロール結果が正常に返されました。

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

**application/json**

Schema: object

```json
{
  "type": "object",
  "properties": {
    "base_url": {
      "type": "string",
      "description": "クロールされたベース URL。"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "description": "クロールされたページの URL。"
          },
          "raw_content": {
            "type": "string",
            "description": "ページから抽出された生のコンテンツ。"
          },
          "favicon": {
            "type": "string",
            "description": "クロールされたページのファビコン URL。"
          }
        }
      }
    },
    "response_time": {
      "type": "number",
      "format": "float",
      "description": "リクエストの完了にかかった時間（秒）。"
    },
    "usage": {
      "type": "object",
      "properties": {
        "credits": {
          "type": "integer",
          "description": "リクエストのクレジット使用量の詳細。"
        }
      }
    },
    "request_id": {
      "type": "string",
      "description": "一意のリクエスト識別子。"
    }
  }
}
```

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

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

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

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

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

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

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

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

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

**application/json**

Schema:

```json
{}
```