# Tavily Extract

**API:** Data API

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

**Tags:** Web Content

1 つの URL または URL の配列から読み取り可能なコンテンツを抽出します。format で text または Markdown を選択します。results と failed_results の両方を確認してください。失敗した URL は、それ以外は成功した HTTP レスポンス内で報告されることがあります。include_usage を設定するとリソース使用量情報を受け取れます。usage.credits は Felo の課金ではありません。

### 料金の参考情報

- 計測方法：レスポンスユニット単位で計測。
- 参考リクエスト見積もり：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": {
    "urls": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ],
      "description": "コンテンツを抽出する URL。単一の URL 文字列と URL 文字列の配列のどちらも受け付けます。",
      "example": [
        "https://en.wikipedia.org/wiki/Artificial_intelligence"
      ]
    },
    "query": {
      "type": "string",
      "description": "抽出されたコンテンツチャンクの再ランク付けに使用するユーザー意図。"
    },
    "chunks_per_source": {
      "type": "integer",
      "default": 3,
      "description": "ソースごとに返される関連チャンクの最大数。query が指定されている場合にのみ利用できます。",
      "minimum": 1,
      "maximum": 5
    },
    "extract_depth": {
      "type": "string",
      "enum": [
        "basic",
        "advanced"
      ],
      "default": "basic",
      "description": "抽出プロセスの深度。"
    },
    "include_images": {
      "type": "boolean",
      "default": false,
      "description": "URL から抽出された画像のリストを含めます。"
    },
    "include_favicon": {
      "type": "boolean",
      "default": false,
      "description": "各結果のファビコン URL を含めます。"
    },
    "format": {
      "type": "string",
      "enum": [
        "markdown",
        "text"
      ],
      "default": "markdown",
      "description": "抽出されたウェブページコンテンツの形式。"
    },
    "timeout": {
      "type": "number",
      "format": "float",
      "description": "URL 抽出の最大待機時間（秒）。省略した場合、既定のタイムアウトは extract_depth によって異なります。basic は 10 秒、advanced は 30 秒です。",
      "minimum": 1,
      "maximum": 60
    },
    "include_usage": {
      "type": "boolean",
      "default": false,
      "description": "レスポンスにリソース使用量の情報を含めます。これは Felo の請求情報ではありません。"
    }
  },
  "required": [
    "urls"
  ]
}
```

Example:

```json
{
  "urls": [
    "https://example.com"
  ],
  "extract_depth": "basic",
  "format": "text",
  "include_usage": true
}
```

## Responses

### 200 — 抽出結果が正常に返されました。

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

**application/json**

Schema: object

```json
{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string",
            "description": "抽出されたコンテンツの URL。"
          },
          "title": {
            "type": "string",
            "description": "抽出されたページのタイトル。"
          },
          "raw_content": {
            "type": "string",
            "description": "URL から抽出された生のコンテンツ。"
          },
          "images": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "include_images が true の場合に URL から抽出された画像。"
          },
          "favicon": {
            "type": [
              "string",
              "null"
            ],
            "description": "抽出されたコンテンツのファビコン URL。"
          }
        }
      }
    },
    "failed_results": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "処理できなかった URL のリスト。"
    },
    "response_time": {
      "type": "number",
      "format": "float",
      "description": "リクエストの完了にかかった時間（秒）。"
    },
    "usage": {
      "type": "object",
      "properties": {
        "credits": {
          "type": "integer",
          "description": "このリクエストで消費されたリソース単位。米ドルや Felo クレジットではありません。"
        }
      }
    },
    "request_id": {
      "type": "string",
      "description": "一意のリクエスト識別子。"
    }
  }
}
```

Example:

```json
{
  "results": [
    {
      "url": "https://example.com",
      "title": "Example Domain",
      "raw_content": "This domain is for use in documentation examples.",
      "images": []
    }
  ],
  "failed_results": [],
  "response_time": 0.5,
  "usage": {
    "credits": 1
  },
  "request_id": "example-extract-request"
}
```

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

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

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

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

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

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

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

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

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

**application/json**

Schema:

```json
{}
```