Data API / DataForSEO / AI Optimization

Live ChatGPT LLM Scraper

Asks ChatGPT a keyword as a user would and returns the answer parsed. Returns keyword, location_code, language_code, model, datetime, markdown, sources, fan_out_queries and brand_entities - markdown is the answer as the assistant rendered it, sources the pages it cited, and brand_entities the brands it named. force_web_search makes it browse rather than answer from training. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. This is the endpoint for 'what does ChatGPT say about us'; for counting mentions across many answers use post_dataforseo_ai_llm_mentions_aggregated_metrics_live instead of scraping repeatedly. The raw form is post_dataforseo_ai_chat_gpt_llm_scraper_live_html.

Parameters

No path, query, or header parameters.

Request body

keywordstringRequired
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_namestringOptional
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/llm_scraper/locations example: United States
location_codeintegerOptional
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_namestringOptional
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
language_codestringOptional
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
force_web_searchbooleanOptional
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
tagstringOptional
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

Example request

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/ai_optimization/chat_gpt/llm_scraper/live/advanced" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "keyword": "<string>",
  "location_name": "<string>",
  "location_code": 0,
  "language_name": "<string>",
  "language_code": "<string>",
  "force_web_search": false,
  "tag": "<string>"
}'

Response

Response fields

versionstringOptional
the current version of the API
status_codeintegerOptional
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_messagestringOptional
general informational message you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
total tasks cost, USD
tasks_countintegerOptional
the number of tasks in the tasks array
tasks_errorintegerOptional
the number of tasks in the tasks array returned with an error
tasksstring[]Optional
array of tasks
idstringOptional
task identifier unique task identifier in our system in the UUID format
status_codeintegerOptional
status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here
status_messagestringOptional
informational message of the task you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
cost of the task, USD
result_countintegerOptional
number of elements in the result array
pathstring[]Optional
URL path
dataobjectOptional
contains the same parameters that you specified in the POST request
resultstring[]Optional
array of results
keywordstringOptional
keyword received in a POST array the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)
location_codeintegerOptional
location code in a POST array
language_codestringOptional
language code in a POST array
modelstringOptional
indicates the model version
check_urlstringOptional
direct URL to search engine results you can use it to make sure that we provided exact results
datetimestringOptional
date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00
markdownstringOptional
content of the element in markdown format content of the result formatted in the markdown markup language
search_resultsstring[]Optional
array of search results all web search outputs the model retrieved when looking up information, including duplicates and unused entries
typestringOptional
type of element='chatgpt_search_result'n
urlstringOptional
result URL
domainstringOptional
result domain
titlestringOptional
result title
descriptionstringOptional
result description
breadcrumbstringOptional
breadcrumb
sourcesstring[]Optional
array of sources the sources the model actually cited or relied on in its final answer
typestringOptional
type of element='chat_gpt_source'
titlestringOptional
source title
snippetstringOptional
source description
domainstringOptional
source domain
urlstringOptional
source URL
thumbnailstringOptional
source thumbnail
source_namestringOptional
source name
publication_datestringOptional
date and time when the result was published in the format: “year-month-date:minutes:UTC_difference_hours:UTC_difference_minutes” example: 2019-11-15 12:57:46 +00:00
markdownstringOptional
content of the element in markdown format content of the result formatted in the markdown markup language
fan_out_queriesstring[]Optional
array of fan-out queries contains related search queries derived from the main query to provide a more comprehensive response
brand_entitiesstring[]Optional
array of brand entities contains information on brands mentioned in the response
typestringOptional
type of the element = 'chat_gpt_brand_entity'
titlestringOptional
name of the brand
categorystringOptional
category of the brand
markdownstringOptional
brand name in markdown format contains brand name formatted in the markdown markup language
urlsstring[]Optional
array of URLs and domains relevant to the brand
urlstringOptional
URL
domainstringOptional
domain
se_results_countintegerOptional
total number of results
item_typesstring[]Optional
types of search results contains types of search results (items) found in SERP. possible item types: chat_gpt_text, chat_gpt_table, chat_gpt_navigation_list, chat_gpt_images, chat_gpt_local_businesses, chat_gpt_products
items_countintegerOptional
the number of results returned in the items array
itemsstring[]Optional
elements of ChatGPT results
chat_gpt_textobjectOptional
element in the response
typestringOptional
type of element='chat_gpt_text'
rank_groupintegerOptional
group rank in SERP position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
rank_absoluteintegerOptional
absolute rank in SERP absolute position among all the elements in SERP
markdownstringOptional
content of the element in markdown format content of the result formatted in the markdown markup language
sourcesstring[]Optional
array of sources
typestringOptional
type of element='chat_gpt_source'n
titlestringOptional
source title
snippetstringOptional
source description
domainstringOptional
source domain in SERP
urlstringOptional
source URL
thumbnailstringOptional
source thumbnail
source_namestringOptional
source name
publication_datestringOptional
date and time when the result was published in the format: “year-month-date:minutes:UTC_difference_hours:UTC_difference_minutes” example: 2019-11-15 12:57:46 +00:00
markdownstringOptional
content of the element in markdown format content of the result formatted in the markdown markup language
brand_entitiesstring[]Optional
array of brand entities contains information on brands mentioned in the text
typestringOptional
type of the element = 'chat_gpt_brand_entity'
titlestringOptional
name of the brand
categorystringOptional
category of the brand
markdownstringOptional
brand name in markdown format contains brand name formatted in the markdown markup language
urlsstring[]Optional
array of URLs and domains relevant to the brand
urlstringOptional
URL
domainstringOptional
domain
chat_gpt_tableobjectOptional
element in the response
typestringOptional
type of element='chat_gpt_table'
rank_groupintegerOptional
group rank in SERP position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
rank_absoluteintegerOptional
absolute rank in SERP absolute position among all the elements in SERP
textstringOptional
text of the element
markdownstringOptional
content of the element in markdown format content of the result formatted in the markdown markup language
tableobjectOptional
table present in the element the header and content of the table present in the element
table_headerstring[]Optional
content in the header of the table
table_contentstring[]Optional
array of contents of the table present in the element each array represents the table row
brand_entitiesstring[]Optional
array of brand entities contains information on brands mentioned in the table
typestringOptional
type of the element = 'chat_gpt_brand_entity'
titlestringOptional
name of the brand
categorystringOptional
category of the brand
markdownstringOptional
brand name in markdown format contains brand name formatted in the markdown markup language
urlsstring[]Optional
array of URLs and domains relevant to the brand
urlstringOptional
URL
domainstringOptional
domain
chat_gpt_navigation_listobjectOptional
element in the response
typestringOptional
type of element='chat_gpt_navigation_list'
rank_groupintegerOptional
group rank in SERP position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
rank_absoluteintegerOptional
absolute rank in SERP absolute position among all the elements in SERP
titlestringOptional
title of the element
sourcesstring[]Optional
array of sources
typestringOptional
type of element='chat_gpt_source'
titlestringOptional
source title
snippetstringOptional
source description
domainstringOptional
source domain in SERP
urlstringOptional
source URL
thumbnailstringOptional
source thumbnail
source_namestringOptional
source name
publication_datestringOptional
date and time when the result was published in the format: “year-month-date:minutes:UTC_difference_hours:UTC_difference_minutes” example: 2019-11-15 12:57:46 +00:00
markdownstringOptional
content of the element in markdown format content of the result formatted in the markdown markup language
chat_gpt_imagesobjectOptional
element in the response
typestringOptional
type of element='chat_gpt_images'
rank_groupintegerOptional
group rank in SERP position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
rank_absoluteintegerOptional
absolute rank in SERP absolute position among all the elements in SERP
markdownstringOptional
content of the element in markdown format content of the result formatted in the markdown markup language
itemsstring[]Optional
items present in the element
typestringOptional
type of element = 'chat_gpt_images_element'
altstringOptional
alt tag of the image
urlstringOptional
relevant URL
image_urlstringOptional
URL of the image the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)
markdownstringOptional
content of the element in markdown format content of the result formatted in the markdown markup language
chat_gpt_local_businessesobjectOptional
element in the response
typestringOptional
type of element='chat_gpt_local_businesses'
rank_groupintegerOptional
group rank in SERP position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
rank_absoluteintegerOptional
absolute rank in SERP absolute position among all the elements in SERP
markdownstringOptional
content of the element in markdown format content of the result formatted in the markdown markup language
itemsstring[]Optional
items present in the element
typestringOptional
type of element = 'chat_gpt_local_businesses_element'
titlestringOptional
title of the local business
descriptionstringOptional
description of the local business
addressstringOptional
address of the local business
phonestringOptional
phone of the local business
reviews_countintegerOptional
total number of reviews submitted for the local business
urlstringOptional
website URL of the local business
domainstringOptional
domain name of the local business
ratingobjectOptional
rating of the corresponding local business popularity rate based on reviews and displayed in SERP
rating_typestringOptional
type of rating here you can find the following elements: Max5, Percents, CustomMax
valuenumberOptional
the average rating based on all reviews
votes_countintegerOptional
the number of votes
rating_maxintegerOptional
the maximum value for a rating_type
chat_gpt_productsobjectOptional
element in the response
typestringOptional
type of element='chat_gpt_products'
rank_groupintegerOptional
group rank in SERP position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
rank_absoluteintegerOptional
absolute rank in SERP absolute position among all the elements in SERP
itemsstring[]Optional
items present in the element
typestringOptional
type of element = 'chat_gpt_products_element'
product_idstringOptional
product id
merchantsstringOptional
merchant(s) offering the product
id_to_token_mapstringOptional
product identifier token Base64-encoded token containing Google Shopping product IDs associated with the product
titlestringOptional
title of the product
ratingobjectOptional
rating of the product popularity rate based on reviews and displayed in SERP
rating_typestringOptional
type of rating here you can find the following elements: Max5, Percents, CustomMax
valuenumberOptional
the average rating based on all reviews
votes_countintegerOptional
the number of votes
rating_maxintegerOptional
the maximum value for a rating_type
pricenumberOptional
product price
currencystringOptional
currency of the listed price ISO code of the currency applied to the price
tagstringOptional
tag text
urlstringOptional
result URL
domainstringOptional
result domain in SERP
imagesstring[]Optional
image URLs of the element contains URLs leading to the images on the original resource or DataForSEO storage (in case the original source is not available)
product_idsstring[]Optional
Google Shopping product identifiers array of Google Shopping product IDs associated with the product
typestringOptional
type of element = 'chat_gpt_google_shopping_product'
eistringOptional
event identifier internal event identifier used by Google
product_idstringOptional
product identifier can be used as a data_docid in Google Shopping API endpoints
catalog_idstringOptional
Google Shopping catalog identifier of the product can be used as a product_id in Google Shopping API endpoints
gpcidstringOptional
Google product cluster identifier can be used as a gid in Google Shopping API endpoints
headline_offer_docidstringOptional
document identifier of the main offer in the headline can be used as a data_docid in Google Shopping API endpoints
image_docidstringOptional
identifier for the displayed product’s image
rdsstringOptional
resource descriptor string internal Google resource descriptor string that identifies the product within Google's Shopping index
querystringOptional
search query search query used by ChatGPT to retrieve the product from Google Shopping
midstringOptional
merchant identifier identifier of the seller or merchant account in Google Shopping
pvtstringOptional
product view type internal Google parameter that specifies the product view type used when rendering the product item
uulestringOptional
encoded location parameter indicates the location for a search
glstringOptional
country code indicates the location for which search results are displayed
hlstringOptional
host language code indicates the language in which search results are displayed