> ## 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: Ai Optimization Chat Gpt Llm Scraper Live Html

> Live ChatGPT LLM Scraper API HTML provides a raw HTML page of the results for the specified keyword, language, and location.

Live ChatGPT LLM Scraper API HTML provides a raw HTML page of the results for the specified keyword, language, and location.

> [!NOTE]
>
> Tool ID: `dataforseo_ai_optimization_chat_gpt_llm_scraper_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_ai_optimization_chat_gpt_llm_scraper_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_ai_optimization_chat_gpt_llm_scraper_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_ai_optimization_chat_gpt_llm_scraper_live_html --json` for the latest machine-readable contract.

## Input reference

Live ChatGPT LLM Scraper API HTML provides a raw HTML page of the results for the specified keyword, language, and location.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.keyword` | `string` | Yes | — | keyword required field you can specify up to 2000 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” learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article |
| `payload.location_name` | `string` | No | — | full name of search engine location required field if you don't specify location\_code if you use this field, you don't need to specify location\_code 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/ai\_optimization/chat\_gpt/locations](https://api.dataforseo.com/v3/ai_optimization/chat_gpt/locations) example: United States |
| `payload.location_code` | `integer` | No | — | search engine location code required field if you don't specify location\_name if you use this field, you don't need to specify location\_name 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/ai\_optimization/chat\_gpt/llm\_scraper/locations](https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/locations) example: 2840 |
| `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/ai\_optimization/chat\_gpt/llm\_scraper/languages](https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/languages) example: English |
| `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/ai\_optimization/chat\_gpt/llm\_scraper/languages](https://api.dataforseo.com/v3/ai_optimization/chat_gpt/llm_scraper/languages) example: en n |
| `payload.force_web_search` | `boolean` | No | — | force AI agent to use web search optional field when enabled, the AI model is forced to access and cite current web information. default value: false . Note: even if the parameter is set to true , there is no guarantee web sources will be cited in the response |
| `payload.expand_citations` | `boolean` | No | — | return expanded citation bar in HTML results optional field to enable this parameter, force\_web\_search must also be enabled. when enabled, the endpoint will return HTML data from the expanded citation bar. default value: false |
| `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 ChatGPT LLM Scraper API HTML provides a raw HTML page of the results for the specified keyword, language, and location.",
    "properties": {
      "keyword": {
        "type": "string",
        "description": "keyword required field you can specify up to 2000 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” learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article"
      },
      "location_name": {
        "type": "string",
        "description": "full name of search engine location required field if you don't specify location_code if you use this field, you don't need to specify location_code 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/ai_optimization/chat_gpt/locations example: United States"
      },
      "location_code": {
        "type": "integer",
        "description": "search engine location code required field if you don't specify location_name if you use this field, you don't need to specify location_name 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/ai_optimization/chat_gpt/llm_scraper/locations example: 2840"
      },
      "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/ai_optimization/chat_gpt/llm_scraper/languages example: English"
      },
      "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/ai_optimization/chat_gpt/llm_scraper/languages example: en n"
      },
      "force_web_search": {
        "type": "boolean",
        "description": "force AI agent to use web search optional field when enabled, the AI model is forced to access and cite current web information; default value: false ; Note: even if the parameter is set to true , there is no guarantee web sources will be cited in the response"
      },
      "expand_citations": {
        "type": "boolean",
        "description": "return expanded citation bar in HTML results optional field to enable this parameter, force_web_search must also be enabled; when enabled, the endpoint will return HTML data from the expanded citation bar; default value: false"
      },
      "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\_ai\_optimization\_chat\_gpt\_llm\_scraper\_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_ai_optimization_chat_gpt_llm_scraper_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: `per_page` (per page).
* Estimated Deepline credits: `0.06` 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.