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.

Параметры

Параметров пути, запроса и заголовков нет.

Тело запроса

keywordstringОбязательный
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_namestringНеобязательный
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_codeintegerНеобязательный
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_namestringНеобязательный
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_codestringНеобязательный
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_searchbooleanНеобязательный
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
tagstringНеобязательный
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

Пример запроса

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>"
}'

Ответ

Поля ответа

versionstringНеобязательный
the current version of the API
status_codeintegerНеобязательный
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_messagestringНеобязательный
general informational message you can find the full list of general informational messages here
timestringНеобязательный
execution time, seconds
costnumberНеобязательный
total tasks cost, USD
tasks_countintegerНеобязательный
the number of tasks in the tasks array
tasks_errorintegerНеобязательный
the number of tasks in the tasks array returned with an error
tasksstring[]Необязательный
array of tasks
idstringНеобязательный
task identifier unique task identifier in our system in the UUID format
status_codeintegerНеобязательный
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_messagestringНеобязательный
informational message of the task you can find the full list of general informational messages here
timestringНеобязательный
execution time, seconds
costnumberНеобязательный
cost of the task, USD
result_countintegerНеобязательный
number of elements in the result array
pathstring[]Необязательный
URL path
dataobjectНеобязательный
contains the same parameters that you specified in the POST request
resultstring[]Необязательный
array of results
keywordstringНеобязательный
keyword received in a POST array the keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)
location_codeintegerНеобязательный
location code in a POST array
language_codestringНеобязательный
language code in a POST array
modelstringНеобязательный
indicates the model version
check_urlstringНеобязательный
direct URL to search engine results you can use it to make sure that we provided exact results
datetimestringНеобязательный
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
markdownstringНеобязательный
content of the element in markdown format content of the result formatted in the markdown markup language
search_resultsstring[]Необязательный
array of search results all web search outputs the model retrieved when looking up information, including duplicates and unused entries
typestringНеобязательный
type of element='chatgpt_search_result'n
urlstringНеобязательный
result URL
domainstringНеобязательный
result domain
titlestringНеобязательный
result title
descriptionstringНеобязательный
result description
breadcrumbstringНеобязательный
breadcrumb
sourcesstring[]Необязательный
array of sources the sources the model actually cited or relied on in its final answer
typestringНеобязательный
type of element='chat_gpt_source'
titlestringНеобязательный
source title
snippetstringНеобязательный
source description
domainstringНеобязательный
source domain
urlstringНеобязательный
source URL
thumbnailstringНеобязательный
source thumbnail
source_namestringНеобязательный
source name
publication_datestringНеобязательный
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
markdownstringНеобязательный
content of the element in markdown format content of the result formatted in the markdown markup language
fan_out_queriesstring[]Необязательный
array of fan-out queries contains related search queries derived from the main query to provide a more comprehensive response
brand_entitiesstring[]Необязательный
array of brand entities contains information on brands mentioned in the response
typestringНеобязательный
type of the element = 'chat_gpt_brand_entity'
titlestringНеобязательный
name of the brand
categorystringНеобязательный
category of the brand
markdownstringНеобязательный
brand name in markdown format contains brand name formatted in the markdown markup language
urlsstring[]Необязательный
array of URLs and domains relevant to the brand
urlstringНеобязательный
URL
domainstringНеобязательный
domain
se_results_countintegerНеобязательный
total number of results
item_typesstring[]Необязательный
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_countintegerНеобязательный
the number of results returned in the items array
itemsstring[]Необязательный
elements of ChatGPT results
chat_gpt_textobjectНеобязательный
element in the response
typestringНеобязательный
type of element='chat_gpt_text'
rank_groupintegerНеобязательный
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_absoluteintegerНеобязательный
absolute rank in SERP absolute position among all the elements in SERP
markdownstringНеобязательный
content of the element in markdown format content of the result formatted in the markdown markup language
sourcesstring[]Необязательный
array of sources
typestringНеобязательный
type of element='chat_gpt_source'n
titlestringНеобязательный
source title
snippetstringНеобязательный
source description
domainstringНеобязательный
source domain in SERP
urlstringНеобязательный
source URL
thumbnailstringНеобязательный
source thumbnail
source_namestringНеобязательный
source name
publication_datestringНеобязательный
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
markdownstringНеобязательный
content of the element in markdown format content of the result formatted in the markdown markup language
brand_entitiesstring[]Необязательный
array of brand entities contains information on brands mentioned in the text
typestringНеобязательный
type of the element = 'chat_gpt_brand_entity'
titlestringНеобязательный
name of the brand
categorystringНеобязательный
category of the brand
markdownstringНеобязательный
brand name in markdown format contains brand name formatted in the markdown markup language
urlsstring[]Необязательный
array of URLs and domains relevant to the brand
urlstringНеобязательный
URL
domainstringНеобязательный
domain
chat_gpt_tableobjectНеобязательный
element in the response
typestringНеобязательный
type of element='chat_gpt_table'
rank_groupintegerНеобязательный
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_absoluteintegerНеобязательный
absolute rank in SERP absolute position among all the elements in SERP
textstringНеобязательный
text of the element
markdownstringНеобязательный
content of the element in markdown format content of the result formatted in the markdown markup language
tableobjectНеобязательный
table present in the element the header and content of the table present in the element
table_headerstring[]Необязательный
content in the header of the table
table_contentstring[]Необязательный
array of contents of the table present in the element each array represents the table row
brand_entitiesstring[]Необязательный
array of brand entities contains information on brands mentioned in the table
typestringНеобязательный
type of the element = 'chat_gpt_brand_entity'
titlestringНеобязательный
name of the brand
categorystringНеобязательный
category of the brand
markdownstringНеобязательный
brand name in markdown format contains brand name formatted in the markdown markup language
urlsstring[]Необязательный
array of URLs and domains relevant to the brand
urlstringНеобязательный
URL
domainstringНеобязательный
domain
chat_gpt_navigation_listobjectНеобязательный
element in the response
typestringНеобязательный
type of element='chat_gpt_navigation_list'
rank_groupintegerНеобязательный
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_absoluteintegerНеобязательный
absolute rank in SERP absolute position among all the elements in SERP
titlestringНеобязательный
title of the element
sourcesstring[]Необязательный
array of sources
typestringНеобязательный
type of element='chat_gpt_source'
titlestringНеобязательный
source title
snippetstringНеобязательный
source description
domainstringНеобязательный
source domain in SERP
urlstringНеобязательный
source URL
thumbnailstringНеобязательный
source thumbnail
source_namestringНеобязательный
source name
publication_datestringНеобязательный
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
markdownstringНеобязательный
content of the element in markdown format content of the result formatted in the markdown markup language
chat_gpt_imagesobjectНеобязательный
element in the response
typestringНеобязательный
type of element='chat_gpt_images'
rank_groupintegerНеобязательный
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_absoluteintegerНеобязательный
absolute rank in SERP absolute position among all the elements in SERP
markdownstringНеобязательный
content of the element in markdown format content of the result formatted in the markdown markup language
itemsstring[]Необязательный
items present in the element
typestringНеобязательный
type of element = 'chat_gpt_images_element'
altstringНеобязательный
alt tag of the image
urlstringНеобязательный
relevant URL
image_urlstringНеобязательный
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)
markdownstringНеобязательный
content of the element in markdown format content of the result formatted in the markdown markup language
chat_gpt_local_businessesobjectНеобязательный
element in the response
typestringНеобязательный
type of element='chat_gpt_local_businesses'
rank_groupintegerНеобязательный
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_absoluteintegerНеобязательный
absolute rank in SERP absolute position among all the elements in SERP
markdownstringНеобязательный
content of the element in markdown format content of the result formatted in the markdown markup language
itemsstring[]Необязательный
items present in the element
typestringНеобязательный
type of element = 'chat_gpt_local_businesses_element'
titlestringНеобязательный
title of the local business
descriptionstringНеобязательный
description of the local business
addressstringНеобязательный
address of the local business
phonestringНеобязательный
phone of the local business
reviews_countintegerНеобязательный
total number of reviews submitted for the local business
urlstringНеобязательный
website URL of the local business
domainstringНеобязательный
domain name of the local business
ratingobjectНеобязательный
rating of the corresponding local business popularity rate based on reviews and displayed in SERP
rating_typestringНеобязательный
type of rating here you can find the following elements: Max5, Percents, CustomMax
valuenumberНеобязательный
the average rating based on all reviews
votes_countintegerНеобязательный
the number of votes
rating_maxintegerНеобязательный
the maximum value for a rating_type
chat_gpt_productsobjectНеобязательный
element in the response
typestringНеобязательный
type of element='chat_gpt_products'
rank_groupintegerНеобязательный
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_absoluteintegerНеобязательный
absolute rank in SERP absolute position among all the elements in SERP
itemsstring[]Необязательный
items present in the element
typestringНеобязательный
type of element = 'chat_gpt_products_element'
product_idstringНеобязательный
product id
merchantsstringНеобязательный
merchant(s) offering the product
id_to_token_mapstringНеобязательный
product identifier token Base64-encoded token containing Google Shopping product IDs associated with the product
titlestringНеобязательный
title of the product
ratingobjectНеобязательный
rating of the product popularity rate based on reviews and displayed in SERP
rating_typestringНеобязательный
type of rating here you can find the following elements: Max5, Percents, CustomMax
valuenumberНеобязательный
the average rating based on all reviews
votes_countintegerНеобязательный
the number of votes
rating_maxintegerНеобязательный
the maximum value for a rating_type
pricenumberНеобязательный
product price
currencystringНеобязательный
currency of the listed price ISO code of the currency applied to the price
tagstringНеобязательный
tag text
urlstringНеобязательный
result URL
domainstringНеобязательный
result domain in SERP
imagesstring[]Необязательный
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[]Необязательный
Google Shopping product identifiers array of Google Shopping product IDs associated with the product
typestringНеобязательный
type of element = 'chat_gpt_google_shopping_product'
eistringНеобязательный
event identifier internal event identifier used by Google
product_idstringНеобязательный
product identifier can be used as a data_docid in Google Shopping API endpoints
catalog_idstringНеобязательный
Google Shopping catalog identifier of the product can be used as a product_id in Google Shopping API endpoints
gpcidstringНеобязательный
Google product cluster identifier can be used as a gid in Google Shopping API endpoints
headline_offer_docidstringНеобязательный
document identifier of the main offer in the headline can be used as a data_docid in Google Shopping API endpoints
image_docidstringНеобязательный
identifier for the displayed product’s image
rdsstringНеобязательный
resource descriptor string internal Google resource descriptor string that identifies the product within Google's Shopping index
querystringНеобязательный
search query search query used by ChatGPT to retrieve the product from Google Shopping
midstringНеобязательный
merchant identifier identifier of the seller or merchant account in Google Shopping
pvtstringНеобязательный
product view type internal Google parameter that specifies the product view type used when rendering the product item
uulestringНеобязательный
encoded location parameter indicates the location for a search
glstringНеобязательный
country code indicates the location for which search results are displayed
hlstringНеобязательный
host language code indicates the language in which search results are displayed