資料 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