Extract structured data from AI Mode about your brand, products, or any topic across various regions
Documentation Index
Fetch the complete documentation index at: https://docs.cloro.dev/llms.txt
Use this file to discover all available pages before exploring further.
prompt (string): The query to send to AI Mode (1-10,000 characters)country (string): ISO 3166-1 alpha-2 country code for localized results. Defaults to USlocation (string): Google canonical location name for geo-targeted results (e.g., New York,New York,United States). See Google’s geo target list for all ~100,000 supported locations. Mutually exclusive with uuleuule (string): Pre-encoded Google UULE string for precise geo-targeting. Use this when you have a pre-built UULE value instead of a location name. Mutually exclusive with locationdevice (string): Device type for search results. Options: desktop (default), mobileinclude.markdown (boolean): Include markdown-formatted response. Defaults to falseinclude.html (boolean): Include raw HTML response. Defaults to false| Section | Description |
|---|---|
| Sources | Source citations referenced in the response |
| Places | Inline place cards when location intent is detected |
| Shopping cards | Product carousel when shopping intent is detected |
| Ads | Sponsored ad section when commercial intent is detected |
| Inline products | Individual product references embedded in the response text |
| Videos | Inline video cards (currently YouTube) embedded in the response |
| Map | GPS-enriched location data when map-aware results are surfaced |
| Field | Type | Description |
|---|---|---|
result.text | string | AI Mode’s response text |
result.markdown | string | Response formatted in Markdown (included when include.markdown is true) |
result.sources | array | Array of sources referenced in the response |
result.places | array | Array of places (when location intent detected) |
result.shopping_cards | array | Array of shopping cards (when shopping intent detected) |
result.ads | object | Ad section wrapper with title and ads array (when commercial intent detected) |
result.inline_products | array | Array of inline products found within the response text |
result.videos | array | Array of videos embedded in the response (currently YouTube) |
result.map | array | Array of map entries with GPS coordinates (when map-aware results surfaced) |
location with country to get AI Mode results targeted to a specific city or region. The location parameter accepts Google canonical location names:
uule with a pre-encoded Google UULE string instead of location. This is useful when you generate your own UULE values for precise location control:
location and uule are mutually exclusive: provide one or the other, not both. Use location for city-level targeting with canonical names, and uule when you need to supply a pre-encoded UULE string.Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Request parameters for monitoring AI Mode responses
The prompt to send to AI Mode
1 - 10000"What are the best laptops for programming?"
Country/region code for localized response
"US"
Google canonical location name for geo-targeted results, in comma-separated format: 'City,Region,Country' (see https://developers.google.com/google-ads/api/reference/data/geotargets for all ~100,000 supported locations). Use alongside 'country' for city-level precision. Mutually exclusive with 'uule' — provide one or the other, not both.
"New York,New York,United States"
Pre-encoded Google UULE string for precise geo-targeting. Use this when you have a pre-built UULE value instead of a location name. Mutually exclusive with 'location' — provide one or the other, not both.
"w+CAIQICIeV2VzdCBOZXcgWW9yayxOZXcgSmVyc2V5"
Device type for search results
desktop, mobile "desktop"
Optional flags for including additional response formats