Extract Google AI Mode
Query Google's AI Mode surface programmatically and receive its generated answer alongside every structured block it renders — from cited sources to shopping cards — for any prompt, country, or locale you specify.
Overview
This endpoint runs a prompt through Google AI Mode and returns the response as machine-readable JSON. Beyond the plain answer text, cloro parses the interactive elements Google layers into the result — reference sources, citation pills, local places, shopping listings, sponsored ads, inline products, videos, and map entries — so you can track how your brand or products appear across different markets. Supply a geographic target through country, location, or a precomputed uule string to see region-specific results, and pick the rendering device with device.
Requests are authenticated with a bearer token in the Authorization header and must send a JSON body with Content-Type: application/json.
Request parameters
| Field | Type | Description |
|---|---|---|
| prompt | string | The question or query text submitted to AI Mode. Required. |
| country | string | Two-letter country code (for example US) that sets the market the query is run against. |
| location | string | A canonical location string such as New York,New York,United States for narrowing results to a specific city or region. |
| uule | string | Optional pre-encoded Google UULE value. Use it when you already have an exact location token and want to bypass location resolution. |
| device | string | The device profile to emulate: desktop or mobile. Controls how the page is rendered. |
| include | object | Toggles for optional payload fields. Set html to also return a hosted snapshot of the rendered page, and markdown to include a Markdown version of the answer. |
Response fields
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates whether the extraction completed successfully. |
| result.text | string | The plain-text answer generated by AI Mode. |
| result.html | string | URL to a stored HTML snapshot of the result page, returned only when requested via include.html. |
| result.markdown | string | Markdown rendering of the answer, returned only when requested via include.markdown. |
| result.sources | array | Reference sources cited in the answer, each with position, url, label, and description. |
| result.citationPills | array | Inline citation chips with label, citationPillId, url, domain, optional description, and position. |
| result.places | array | Local place results, including title, place_id, rating, reviews, type, address, and more. |
| result.shopping_cards | array | Shopping listings with title, price, store, rating, reviews, and product links. |
| result.ads | object | Sponsored placements, containing a heading and an ads array of individual advertised products. |
| result.inline_products | array | Products surfaced inline within the answer, each with pricing, store, and a product link. |
| result.videos | array | Video results with title, link, platform, channel, duration, and thumbnail. |
| result.map | array | Map entries with title, place_id, gps_coordinates, and place metadata. |
Response example
{
"success": true,
"result": {
"text": "Here are some strong laptop picks for programming...",
"html": "https://storage.cloro.cloud/results/c45a5081-808d-4ed3-9c86-e4baf16c8ab8/page-1.html",
"sources": [
{
"position": 1,
"url": "https://example.com/ai-recommendations",
"label": "AI Source",
"description": "AI-curated laptop recommendations"
}
],
"citationPills": [
{
"label": "Best Laptops 2026 — Reuters",
"citationPillId": 1,
"url": "https://example.com/best-laptops-2026",
"domain": "example.com",
"description": "A roundup of the leading laptops for software development this year.",
"position": 1
}
],
"markdown": "Here are some strong laptop picks for programming...",
"places": [
{
"title": "Gion District",
"place_id": "/g/11bw3yq9kp",
"index": 0,
"rating": 4.5,
"reviews": 2900,
"type": "Tourist attraction",
"price_level": "$$",
"address": "Gionmachi, Higashiyama Ward, Kyoto",
"status": "Open now"
}
],
"shopping_cards": [
{
"title": "Wireless Headphones",
"price": { "value": 99.99, "currency": "$" },
"old_price": { "value": 129.99, "currency": "$" },
"store": "Amazon",
"rating": 4.2,
"reviews": "2.3k",
"product_link": "https://www.google.com/example",
"snippet": "Noise-canceling wireless headphones with 30-hour battery life"
}
],
"ads": {
"title": "3D printers to consider",
"ads": [
{
"title": "Bambu Lab X2D",
"url": "https://www.google.com/aclk?sa=L&ai=abc",
"position": 1,
"price": { "value": 899, "currency": "$" },
"store": "Bambu Lab US",
"rating": 4.7,
"reviews": "584"
}
]
},
"inline_products": [
{
"title": "Sony WH-1000XM5",
"position": 1,
"price": { "value": 298, "currency": "$" },
"old_price": { "value": 399.99, "currency": "$" },
"store": "Amazon",
"product_link": "https://www.google.com/shopping/product/example"
}
],
"videos": [
{
"title": "How to Pick the Right 3D Printer",
"link": "https://www.youtube.com/watch?v=g0DZnQdI-xQ",
"platform": "YouTube",
"channel": "3D Print Dood",
"duration": "08:49"
}
],
"map": [
{
"title": "Central Park Cafe",
"place_id": "/g/11bw3yq9kp",
"index": 0,
"gps_coordinates": { "latitude": 40.7831, "longitude": -73.9712 },
"rating": 4.5,
"reviews": 1234,
"type": "Coffee shop",
"address": "123 Broadway, New York",
"status": "Open now"
}
]
}
}
Notes
- The
htmlandmarkdownfields are only populated when the corresponding flags are enabled in theincludeobject. - Structured arrays such as
ads,videos, orplacesappear only when AI Mode renders those blocks for the given prompt; otherwise they may be empty or omitted. - For questions about authentication, quotas, or unexpected responses, reach out to [email protected].