Google AI Overview
Returns only the AI Overview from a Google results page, and accepts the Google Search parameters except fast_mode. When Google shows no AI Overview for the query, ai_overview is null, search_metadata.ai_overview_state is not_served, and the call is not billed.
Request
- Base URL: https://api.litescrape.com
- URL: https://api.litescrape.com/api/google/ai-overview
- Auth: one of:
- HTTP bearer
- API key in header zc-signature
Query parameters
Search query, up to 2,048 characters. Required unless ludocid or kgmid is supplied.
Decimal Google CID for a local entity search. Can replace q.
Google Knowledge Graph machine ID, such as /m/0k8z. Can replace q.
Human-readable search location, up to 512 characters. Use only one of location, uule, or lat and lon.
Pre-encoded Google location token, up to 2,048 characters. Use only one of location, uule, or lat and lon.
Latitude between -90 and 90. Supply with lon; conflicts with location and uule.
Longitude between -180 and 180. Supply with lat; conflicts with location and uule.
Search radius in meters around location or lat and lon, which it requires. 1 to 199 on desktop, 1 to 1,000 on tablet or mobile.
Opaque Google local or Knowledge Graph signature, up to 4,096 characters.
Opaque cached Google search context, up to 4,096 characters.
Google layout or expansion control, up to 4,096 characters.
Opaque Google filter token, up to 4,096 characters.
Google's light or dark result presentation.
A Google domain from Google's supported list, such as google.com or google.co.uk.
Lowercase two-letter country code used to localize results.
Google interface and result language, such as en, en-US, or de. Defaults to en.
Country restriction: one or more countryXX values joined with |, such as countryUS.
Language restriction: one or more lang_xx values joined with |, such as lang_en.
Google returns its real layout for the selected device: desktop, tablet, or mobile.
Google search-filter string, such as qdr:w, up to 4,096 characters.
Google adult-content filtering: active or off.
Set 1 to disable Google spelling auto-correction, or 0 to allow it.
Google similar-results filtering: 0 or 1.
Google personalization flag: 0 or 1. 0 asks for non-personalized results.
Google personalization companion flag: 0 or 1, forwarded to Google unchanged.
Google vertical: lcl, vid, nws, shop, or pts. Google Images (isch) is rejected with 400 unsupported_search_vertical.
Result offset for pagination. Defaults to 0.
Requested result count, 1 to 10. A best-effort hint: Google may return fewer rows, and results are never padded.
Include (i) or exclude (e) the as_sitesearch host. Requires as_sitesearch.
Exact phrase the results must contain, up to 2,048 characters.
Words the results must not contain, up to 2,048 characters.
Return pages that link to this complete HTTP(S) URL.
Lower bound of a number range. Supply with as_nhi.
Upper bound of a number range. Supply with as_nlo.
Additional terms of which any may match, up to 2,048 characters.
Additional terms that must all match, up to 2,048 characters.
Date range: d, w, m, or y with an optional positive count, such as m3 for the past three months.
Return pages related to this complete HTTP(S) URL.
Hostname to include or exclude, such as example.com. A hostname, not a URL.
Original query text from a Google URL, up to 2,048 characters; forwarded unchanged.
Opaque Google autocomplete-session value from a Google URL, up to 4,096 characters; forwarded unchanged.
Google client label such as gws-wiz-serp: up to 64 letters, digits, dots, underscores, or hyphens.
Optional budget for the entire request in seconds, measured from gateway receipt until the response is ready to send. Includes admission, queueing and settlement. Must be greater than 0 and at most 90. On expiry, the call is not billed and returns 503 request_deadline_exceeded with retryable=true and a request ID. Omit to retain the standard server deadline.
Response
Successful response. When Google shows no AI Overview for the query, ai_overview is null, search_metadata.ai_overview_state is not_served, and the call is not billed.
Changes
No recorded changes to this operation across all 1 revision of this API.