Skip to main content
POST
/
v1
/
monitor
/
aimode
Monitor AI Mode Responses
curl --request POST \
  --url https://api.cloro.dev/v1/monitor/aimode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "What are the best laptops for programming?",
  "country": "US",
  "device": "desktop",
  "include": {
    "markdown": false
  }
}
'
{
  "success": true,
  "result": {
    "text": "Here are some excellent laptop recommendations for programming...",
    "html": "https://storage.cloro.dev/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"
      }
    ],
    "markdown": "Here are some excellent laptop recommendations for programming...",
    "places": [
      {
        "title": "Central Park Cafe",
        "rating": 4.5,
        "reviews": 1234,
        "price": "$$",
        "status": "Open now",
        "address": "123 Broadway, New York",
        "thumbnail": "https://example.com/place.jpg",
        "place_id": "ChIJrTLr-GyuEmsRBfyf1GDs-kY",
        "link": "https://www.google.com/search?q=Central+Park+Cafe&kponly&kgmid=ChIJrTLr-GyuEmsRBfyf1GDs-kY",
        "description": "Cozy cafe with outdoor seating"
      }
    ],
    "shopping_cards": [
      {
        "title": "Wireless Headphones",
        "price": {
          "value": 99.99,
          "currency": "$"
        },
        "store": "Amazon",
        "rating": 4.2,
        "reviews": "2.3k",
        "thumbnail": "https://example.com/product.jpg",
        "product_link": "https://www.google.com/example"
      }
    ]
  }
}

Overview

The Google AI Mode endpoint extracts structured data from Google AI Mode, ideal for general knowledge queries, workflow optimization, and technical guidance.
Web search enabledThis endpoint uses AI Mode’s default interface, which combines web search results with AI-generated responses.

Request parameters

Uses common parameters. Endpoint-specific options:
  • device (string): Device type for search results. Options: desktop (default), mobile
  • include.markdown (boolean): Include markdown-formatted response. Defaults to false

Response schema

Includes common response fields plus:

Core response fields

FieldTypeDescription
result.textstringAI Mode’s response text
result.markdownstringResponse formatted in Markdown (included when include.markdown is true)

Sources

Array of sources referenced in the response:
FieldTypeDescription
positionnumberPosition index of the source
urlstringURL of the source
labelstringDisplay label for the source
descriptionstringDescription of the source content

Places (when location intent detected)

Location data extracted from the response:
FieldTypeDescription
titlestringPlace name
ratingnumberStar rating (0-5)
reviewsintegerNumber of reviews
pricestringPrice level (e.g., ”$”, ”$$”, ”$$$“)
statusstringOperating status (e.g., “Open now”)
addressstringFull address
place_idstringGoogle Places ID
linkstringGoogle search URL for the place

Shopping cards (when shopping intent detected)

Shopping product information extracted from the response:
FieldTypeDescription
titlestringProduct title
priceobjectStructured pricing with value and currency
storestringMerchant/store name
ratingnumberProduct rating
product_linkstringDirect product URL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request parameters for monitoring AI Mode responses

prompt
string
required

The prompt to send to AI Mode

Required string length: 1 - 10000
Example:

"What are the best laptops for programming?"

country
string
default:US

Country/region code for localized response

Example:

"US"

device
enum<string>
default:desktop

Device type for search results

Available options:
desktop,
mobile
Example:

"desktop"

include
object

Optional flags for including additional response formats

Response

successful AI Mode monitoring response

success
boolean
required
Example:

true

result
object
required

AI Mode response data