# 实时 Google AI Mode SERP HTML

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/serp/google/ai_mode/live/html`

**Tags:** DataForSEO

同步返回 Google 针对某个查询给出的 AI Mode 回答，以及它引用的来源。返回原始页面源码而非解析后的结果。采用 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": {
          "keyword": {
            "type": "string",
            "description": "<em>关键词</em><br><strong>必填字段</strong><br>在 <code>keyword</code> 字段中最多可指定 <strong>700 个字符</strong><br>所有 %## 都将被解码（加号“+”将被解码为空格字符）<br>如果需要为 <code>keyword</code> 使用“%”字符，请将其指定为“%25”；<br>如果需要为 <code>keyword</code> 使用“+”字符，请将其指定为“%2B”；"
          },
          "location_name": {
            "type": "string",
            "description": "<em>搜索引擎地点全名</em><br><strong>未指定 <code>location_code</code> 或 <code>location_coordinate</code> 时为必填字段</strong><br><strong>如果使用此字段，则无需指定 <code>location_code</code> 或 <code>location_coordinate</code></strong><br>可单独向 <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code> 发起请求，获取搜索引擎可用地点及其 <code>location_name</code> 的列表<br>示例：<br><code class=\"long-string\">London,England,United Kingdom</code>"
          },
          "location_code": {
            "type": "integer",
            "description": "<em>搜索引擎地点代码</em><br><strong>未指定 <code>location_name</code> 或 <code>location_coordinate</code> 时为必填字段</strong><br><strong>如果使用此字段，则无需指定 <code>location_name</code> 或 <code>location_coordinate</code></strong><br>可单独向 <code>https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations</code> 发起请求，获取搜索引擎可用地点及其 <code>location_code</code> 的列表<br>示例：<br><code class=\"long-string\">2840</code>"
          },
          "location_coordinate": {
            "type": "string",
            "description": "<em>地点的 GPS 坐标</em><br><strong>未指定</strong> <code>location_name</code> 或 <code>location_code</code> 时为必填字段<br><strong>如果使用此字段，则无需指定 <code>location_name</code> 或 <code>location_code</code></strong><br><code>location_coordinate</code> 参数应按 <em>\"latitude,longitude,radius\"</em> 格式指定<br><em>\"latitude\"</em> 和 <em>\"longitude\"</em> 的最大小数位数为 7<br><em>\"radius\"</em> 的最小值：199.9（mm）<br><em>\"radius\"</em> 的最大值：199999（mm）<br>示例：<br><code class=\"long-string\">53.476225,-2.243572,200</code>"
          },
          "language_name": {
            "type": "string",
            "description": "<em>搜索引擎语言全名</em><br>未指定 <code>language_code</code> 时为必填字段；<br>如果使用此字段，则无需指定 <code>language_code</code>；<br>可单独向 <code>https://api.dataforseo.com/v3/serp/google/ai_mode/languages</code> 发起请求，获取搜索引擎可用语言及其 <code>language_name</code> 的列表；"
          },
          "language_code": {
            "type": "string",
            "description": "<em>搜索引擎语言代码</em><br>未指定 <code>language_name</code> 时为必填字段；<br>如果使用此字段，则无需指定 <code>language_name</code>；<br>可单独向 <code>https://api.dataforseo.com/v3/serp/google/ai_mode/languages</code> 发起请求，获取搜索引擎可用语言及其 <code>language_code</code> 的列表"
          },
          "device": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>设备类型</em><br>可选字段<br>返回特定设备类型的结果<br>可取值为：<code>desktop</code>、<code>mobile</code><br>默认值：<code>desktop</code>"
          },
          "os": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>设备操作系统</em><br>可选字段<br>如果在 <code>device</code> 字段中指定 <code>desktop</code>，请从以下值中选择：<code>windows</code>、<code>macos</code><br>默认值：<code>windows</code><br>如果在 <code>device</code> 字段中指定 <code>mobile</code>，请从以下值中选择：<code>android</code>、<code>ios</code><br>默认值：<code>android</code>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>用户自定义任务标识符</em><br>可选字段<br><em>字符数上限为 255</em><br>可使用此参数标识任务，并将其与结果对应<br>可在响应的 <code>data</code> 对象中找到指定的 <code>tag</code> 值"
          }
        },
        "example": [
          {
            "language_code": "en",
            "location_code": 2840,
            "keyword": "albert einstein"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "language_code": "en",
      "location_code": 2840,
      "keyword": "albert einstein"
    }
  ]
}
```

## Responses

### 200 — 操作成功

Headers:
- `X-Request-Id` (string) — 联系 Felo 支持时需提供的请求标识符。

**application/json**

Schema: object | null

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

### 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_HtmlItemInfo

`#/components/schemas/Response36Afe1097B20_HtmlItemInfo`

```json
{
  "type": "object",
  "properties": {
    "page": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<i>返回的 HTML 页面序号</i>"
    },
    "date": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>扫描 HTML 页面的日期和时间</em><br>UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”<br>示例：<br><code class=\"long-string\">2019-11-15 12:57:46 +00:00</code>"
    },
    "html": {
      "type": [
        "string",
        "null"
      ],
      "description": "<i>HTML</i> <i>页面</i>"
    }
  }
}
```

### Response36Afe1097B20_SerpGoogleAiModeLiveHtmlResponseInfo

`#/components/schemas/Response36Afe1097B20_SerpGoogleAiModeLiveHtmlResponseInfo`

```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_SerpGoogleAiModeLiveHtmlTaskInfo"
              }
            ]
          },
          "description": "<em>任务数组</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_SerpGoogleAiModeLiveHtmlResultInfo

`#/components/schemas/Response36Afe1097B20_SerpGoogleAiModeLiveHtmlResultInfo`

```json
{
  "type": "object",
  "properties": {
    "keyword": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 数组中收到的关键词<br></em><strong>返回的关键词已解码 %##（加号字符 '+' 会被解码为空格字符）</strong>"
    },
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "元素类型"
    },
    "se_domain": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 数组中的搜索引擎域名</em>"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>POST 数组中的位置代码</em>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 数组中的语言代码</em>"
    },
    "datetime": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>收到结果的日期和时间</em><br>采用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”<br>示例：<br><code class=\"long-string\">2019-11-15 12:57:46 +00:00</code>"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em><strong><code>items</code></strong> 数组中返回的结果数</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_HtmlItemInfo"
          }
        ]
      },
      "description": "<em>SERP 中找到的搜索结果的元素</em>"
    }
  }
}
```

### Response36Afe1097B20_SerpGoogleAiModeLiveHtmlTaskInfo

`#/components/schemas/Response36Afe1097B20_SerpGoogleAiModeLiveHtmlTaskInfo`

```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_SerpGoogleAiModeLiveHtmlResultInfo"
              }
            ]
          },
          "description": "<em>结果数组</em>"
        }
      }
    }
  ]
}
```
