# SERP API AI 摘要

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/serp/ai_summary`

**Tags:** DataForSEO

傳回 Google 針對某個查詢在搜尋結果上方顯示的 AI 總覽。傳回 `keyword`、`type`、`se_domain`、`location_code`、`language_code`、`check_url`、`datetime`、`spell`、`refinement_chips`、`item_types`、`items_count` 與 `items`。採用 DataForSEO 的信封結構：資料位於 `tasks[0].result`，結果狀態位於 `tasks[0].status_code`——被拒絕的請求仍會回傳 HTTP 200。

### 計費參考

- 計量方式：依回報的回應成本計量。
- 參考請求估算：0.02 美元。
- 參考客戶倍率：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: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "task_id": {
            "type": "string",
            "description": "<em>任務識別碼</em><br><strong>必填欄位</strong><br>關聯任務的唯一識別碼，採用 <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> 格式<br>你可以在 <strong>30 天</strong>內使用它隨時請求該任務的結果"
          },
          "prompt": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>AI 提示詞</em><br>選填欄位<br>AI 摘要器的附加任務；<br>任何形式的文字、問題或資訊，用於向 AI 傳達你期望的回應；<br>可指定的最大符號或字元數：<code>2000</code>；<br><strong>注意：</strong>提示詞必須與 POST 請求中向 SERP API 指定的關鍵字相關"
          },
          "support_extra": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>支援額外的 SERP 功能</em><br>選填欄位<br>如果設為 <code>true</code>，除 <code>organic</code> 結果外，AI 模型還將考量以下額外的 SERP 功能：<code>answer_box</code>、<code>knowledge_graph</code>、<code>featured_snippet</code>；<br>預設值：<code>true</code>"
          },
          "fetch_content": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>從 SERP 中的頁面擷取內容</em><br>選填欄位<br>如果設為 <code>true</code>，API 將從 SERP 結果中顯示的頁面擷取內容，AI 模型在產生結果中的摘要時會參考此內容；<br>預設值：<code>false</code>"
          },
          "include_links": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>在摘要中包含來源連結</em><br>選填欄位<br>如果設為 <code>true</code>，API 回應中的 <code>summary</code> 欄位將包含所產生摘要的來源連結；<br>預設值：<code>false</code>"
          }
        },
        "example": [
          {
            "task_id": "07031739-1535-0139-0000-9d1e639a5b7d",
            "prompt": "explain what DataForSEO is",
            "include_links": true,
            "fetch_content": true
          }
        ]
      }
    ]
  },
  "example": [
    {
      "task_id": "07031739-1535-0139-0000-9d1e639a5b7d",
      "prompt": "explain what DataForSEO is",
      "include_links": true,
      "fetch_content": true
    }
  ]
}
```

## Responses

### 200 — 操作成功

Headers:
- `X-Request-Id` (string) — 聯絡 Felo 支援時需提供的請求識別碼。

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_SerpAiSummaryResponseInfo"
    }
  ]
}
```

### 400 — 無法處理該要求。請檢查請求參數。

### 401 — 需要有效的 Felo API 金鑰。

### 402 — 由於未符合計費要求，要求無法繼續。

### 403 — 該帳戶無權執行此操作。

### 429 — 已達到要求或支出上限。

### 502 — 服務無法完成該要求。

### 503 — API 或計費服務暫時無法使用。

### 504 — 服務在處理要求時逾時。

### default — 錯誤回應；上游透傳回應可能採用供應商格式

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "API 的目前版本"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "一般狀態碼\n完整回應碼清單請見此處"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "一般資訊訊息\n完整的一般資訊訊息清單請見此處"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "總執行時間，秒"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "任務總費用，美元",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "tasks 陣列中的任務數",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "tasks 陣列中傳回錯誤的任務數",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "任務識別碼\n我們系統中 UUID 格式的唯一任務識別碼"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "任務的狀態碼\n由 DataForSEO 產生，範圍如下：10000-60000\n完整回應碼清單請見此處"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "任務的資訊訊息\n完整的一般資訊訊息清單請見此處"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "執行時間，秒"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "任務總費用，美元",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "result 陣列中的元素數",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "URL 路徑"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "包含你在 POST 請求中指定的相同參數"
    }
  }
}
```

### Response36Afe1097B20_SerpAiSummaryItem

`#/components/schemas/Response36Afe1097B20_SerpAiSummaryItem`

```json
{
  "type": "object",
  "properties": {
    "summary": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>產生的摘要</em><br>AI 模型依照請求中指定的參數產生的摘要"
    }
  }
}
```

### Response36Afe1097B20_SerpAiSummaryResponseInfo

`#/components/schemas/Response36Afe1097B20_SerpAiSummaryResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_SerpAiSummaryTaskInfo"
              }
            ]
          },
          "description": "<em>任務陣列</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_SerpAiSummaryResultInfo

`#/components/schemas/Response36Afe1097B20_SerpAiSummaryResultInfo`

```json
{
  "type": "object",
  "properties": {
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>結果陣列中的項目數</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_SerpAiSummaryItem"
          }
        ]
      },
      "description": "<em>項目陣列</em>"
    }
  }
}
```

### Response36Afe1097B20_SerpAiSummaryTaskInfo

`#/components/schemas/Response36Afe1097B20_SerpAiSummaryTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_SerpAiSummaryResultInfo"
              }
            ]
          },
          "description": "<em>結果陣列</em>"
        }
      }
    }
  ]
}
```