> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# DataForSEO: Serp Google Ai Mode Live Html

> Live SERP HTML provides a raw HTML page of 100 search engine results for the specified keyword, search engine, and location.

Live SERP HTML provides a raw HTML page of 100 search engine results for the specified keyword, search engine, and location.

> [!NOTE]
>
> Tool ID: `dataforseo_serp_google_ai_mode_live_html`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'dataforseo_serp_google_ai_mode_live_html',
  {
    "keyword": "software companies hiring engineers"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute dataforseo_serp_google_ai_mode_live_html --input '{
  "keyword": "software companies hiring engineers"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "version": "example",
  "status_code": 123,
  "status_message": "example",
  "time": "example",
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    {}
  ]
}
```

Use `deepline describe dataforseo_serp_google_ai_mode_live_html --json` for the latest machine-readable contract.

## Input reference

Live SERP HTML provides a raw HTML page of 100 search engine results for the specified keyword, search engine, and location.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.keyword` | `string` | Yes | — | keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the "%" character for your keyword , please specify it as "%25". if you need to use the “+” character for your keyword , please specify it as “%2B”. |
| `payload.location_name` | `string` | No | — | full name of search engine location required field if you don't specify location\_code or location\_coordinate if you use this field, you don't need to specify location\_code or location\_coordinate you can receive the list of available locations of the search engine with their location\_name by making a separate request to the [https://api.dataforseo.com/v3/serp/google/locations](https://api.dataforseo.com/v3/serp/google/locations) example: London,England,United Kingdom |
| `payload.location_code` | `integer` | No | — | search engine location code required field if you don't specify location\_name \_or location\_coordinate if you use this field, you don't need to specify location\_name or location\_coordinate you can receive the list of available locations of the search engines with their location\_code by making a separate request to the [https://api.dataforseo.com/v3/serp/google/locations](https://api.dataforseo.com/v3/serp/google/locations) example: 2840 n |
| `payload.location_coordinate` | `string` | No | — | GPS coordinates of a location required field if you don't specify location\_name \_or location\_code if you use this field, you don't need to specify location\_name or location\_code location\_coordinate parameter should be specified in the "latitude,longitude,radius" format the maximum number of decimal digits for "latitude" and "longitude" : 7 the minimum value for "radius" : 199.9 (mm) the maximum value for "radius" : 199999 (mm) example: 53.476225,-2.243572,200 n |
| `payload.language_name` | `string` | No | — | full name of search engine language required field if you don't specify language\_code . if you use this field, you don't need to specify language\_code . You can receive the list of available languages of the search engine with their language\_name by making a separate request to the [https://api.dataforseo.com/v3/serp/google/ai\_mode/languages](https://api.dataforseo.com/v3/serp/google/ai_mode/languages) . |
| `payload.language_code` | `string` | No | — | search engine language code required field if you don't specify language\_name . if you use this field, you don't need to specify language\_name . You can receive the list of available languages of the search engine with their language\_code \_by making a separate request to the [https://api.dataforseo.com/v3/serp/google/ai\_mode/languages](https://api.dataforseo.com/v3/serp/google/ai_mode/languages) n |
| `payload.device` | `string` | No | — | device type optional field return results for a specific device type can take the values: desktop , mobile default value: desktop |
| `payload.os` | `string` | No | — | device operating system optional field if you specify desktop in the device field, choose from the following values: windows , macos default value: windows if you specify mobile in the device field, choose from the following values: android , ios default value: android |
| `payload.tag` | `string` | No | — | user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Live SERP HTML provides a raw HTML page of 100 search engine results for the specified keyword, search engine, and location.",
    "properties": {
      "keyword": {
        "type": "string",
        "description": "keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the \"%\" character for your keyword , please specify it as \"%25\"; if you need to use the “+” character for your keyword , please specify it as “%2B”;"
      },
      "location_name": {
        "type": "string",
        "description": "full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations example: London,England,United Kingdom"
      },
      "location_code": {
        "type": "integer",
        "description": "search engine location code required field if you don't specify location_name _or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/google/locations example: 2840 n"
      },
      "location_coordinate": {
        "type": "string",
        "description": "GPS coordinates of a location required field if you don't specify location_name _or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\" : 7 the minimum value for \"radius\" : 199.9 (mm) the maximum value for \"radius\" : 199999 (mm) example: 53.476225,-2.243572,200 n"
      },
      "language_name": {
        "type": "string",
        "description": "full name of search engine language required field if you don't specify language_code ; if you use this field, you don't need to specify language_code ; you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/google/ai_mode/languages ;"
      },
      "language_code": {
        "type": "string",
        "description": "search engine language code required field if you don't specify language_name ; if you use this field, you don't need to specify language_name ; you can receive the list of available languages of the search engine with their language_code _by making a separate request to the https://api.dataforseo.com/v3/serp/google/ai_mode/languages n"
      },
      "device": {
        "type": "string",
        "description": "device type optional field return results for a specific device type can take the values: desktop , mobile default value: desktop"
      },
      "os": {
        "type": "string",
        "description": "device operating system optional field if you specify desktop in the device field, choose from the following values: windows , macos default value: windows if you specify mobile in the device field, choose from the following values: android , ios default value: android"
      },
      "tag": {
        "type": "string",
        "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response"
      }
    },
    "required": [
      "keyword"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Top-level response envelope for dataforseo\_serp\_google\_ai\_mode\_live\_html.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.version` | `string` | Yes | — | the current version of the API |
| `result.status_code` | `integer` | Yes | — | general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions |
| `result.status_message` | `string` | Yes | — | general informational message you can find the full list of general informational messages here |
| `result.time` | `string` | Yes | — | execution time, seconds |
| `result.tasks_count` | `integer` | Yes | — | the number of tasks in the tasks array |
| `result.tasks_error` | `integer` | Yes | — | the number of tasks in the tasks array returned with an error |
| `result.tasks` | `array` | Yes | — | array of tasks |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Top-level response envelope for dataforseo_serp_google_ai_mode_live_html.",
    "properties": {
      "version": {
        "type": "string",
        "description": "the current version of the API"
      },
      "status_code": {
        "type": "integer",
        "description": "general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions"
      },
      "status_message": {
        "type": "string",
        "description": "general informational message you can find the full list of general informational messages here"
      },
      "time": {
        "type": "string",
        "description": "execution time, seconds"
      },
      "tasks_count": {
        "type": "integer",
        "description": "the number of tasks in the tasks array"
      },
      "tasks_error": {
        "type": "integer",
        "description": "the number of tasks in the tasks array returned with an error"
      },
      "tasks": {
        "type": "array",
        "description": "array of tasks",
        "items": {}
      }
    },
    "required": [
      "version",
      "status_code",
      "status_message",
      "time",
      "tasks_count",
      "tasks_error",
      "tasks"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.03` per pricing unit.

## Related documentation

* [DataForSEO provider guide](https://deepline.com/docs/providers/dataforseo/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.