Google AI Mode

Perform Search

Overview

Method	Endpoint	Version	Description
`POST`	`/api/v1/open/search`	v1	Google Search API endpoint for retrieving search results

Request Headers

Header	Type	Required	Description
`Content-Type`	`string`	Yes	Must be set to `application/json`
`Accept`	`string`	No	Response format (defaults to `application/json`)

Authentication

API Key Authentication - Pass the API key as a request parameter: api_key=your_api_key - Example: "api_key": "your_api_key_here"

Request Example

curl -X POST "https://domain/api/v1/open/search" \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "your_api_key_here",
    // ...
  }'

Response Format

All responses follow a standardized JSON structure:

{
  "code": 200,
  "msg": "Success",
  "reqId": "req_1234567890",
  "timestamp": "2025-01-08T10:30:00Z",
  "data": {
    // Response data object
  }
}

HTTP Status Codes

Code	Status	Description	Retry
200	OK	Request successful	No

Request Parameters

Parameter	Type	Required	Description	Default
`api_key`	`string`	Yes	API key for authentication
`engine`	`string`	Yes	Search engine type, currently engine value is `google_ai_mode`	google
`q`	`string`	Yes	Search query, supports regular Google search syntax (like inurl:, site:, intitle:) and advanced search parameters
`hl`	`string`	No	Search language code (e.g., en-English, es-Spanish, fr-French). Head to the Google languages page for a full list of supported Google languages.
`gl`	`string`	No	Search country code (e.g., us-United States, uk-United Kingdom, fr-France). Head to the Google countries page for a full list of supported Google countries..
`device`	`string`	No	Device type, currently only supports desktop version	desktop

Response Example

{
  "reqId": "1984168106343272448",
  "code": 200,
  "msg": "OK",
  "data": {
    "search_metadata": {
      "raw_html_file": "oss_html",
      "total_time_taken": 1.768001541,
      "id": "1984168106343272448",
      "json_endpoint": "oss_json",
      "created_at": "2025-10-31 15:58:35",
      "processed_at": "2025-10-31 15:58:39",
      "google_url": "https://www.google.com/search?q=coffee&gl=us&hl=en&udm=50",
      "status": "Success"
    },
    "search_information": {
      "time_taken_displayed": 0
    },
    "search_parameters": {
      "engine": "google_ai_mode",
      "google_domain": "www.google.com",
      "q": "coffee",
      "hl": "en",
      "gl": "us",
      "udm": 50
    },
    "shopping_results": [
      {
        "product_link": "https://www.google.com/search?ds=pvt:hg,pvo:29,imageDocid:3298043635574831120,headlineOfferDocid:16102017173561560504,productDocid:16102017173560504&ibp=oshop&q=product&sa=X&ved=2ahUKEwjkl8_EocaQAxVkgf0HHbJDLI8Q8ccPegQICBAB",
        "price": "$38.64",
        "thumbnail": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBwgHBgkIBwgKCgkLDQY",
        "extracted_price": 38.64
      }
    ],
    "text_blocks": [
      {
        "snippet": "There are two main species of coffee beans: Arabica and Robusta. Arabica beans offer a milder, more flavorful, and aromatic brew, while Robusta beans are hardier and contain more caffeine. The best tasting coffee is made with freshly ground beans, the right water temperature, and a grind size appropriate for your brewing method.",
        "type": "paragraph"
      },
      {
        "type": "list",
        "items": [
          {
            "snippet": "Brazil Santos 250g: Freshly roasted beans from the Matagalpa-Jinotega region. Flavor profile: Fruity and floral with a balanced body."
          }
        ]
      }
    ],
     "references": [
      {
        "title": "How to Brew the Perfect Cup of Coffee at Home - Causffee",
        "link": "/url?sa=i&source=web&rct=j&url=https://www.causffee.com/blog/hg3ecz86i3z2s1lq9mxxovdilvbnfq&ved=2ahUKEwjkl8_EocaQAxVkgf0HHbJDLI8Q1fkOegQIHRAC&opi=89978449&cd&psig=AOvVaw3_c34yiTgjvSGGdoKN6uV1&ust=1761719188401000",
        "source": "Causffee"
      }
    ]
  }
}

Complete Response Parameters Overview

search_metadata

object Contains metadata about the search execution

Parameter	Type	Description	Applicable Terminal
`id`	`string`	Unique identifier for the search request	desktop
`json_endpoint`	`string`	Provide an interface endpoint for searching related JSON data, through which JSON-formatted search data can be obtained	desktop
`created_at`	`string`	The timestamp when the search request was created, recording the time when the search was initiated	desktop
`processed_at`	`string`	The timestamp when the search results were processed and became available for return, recording the time point from processing to completion of the search	desktop
`google_url`	`string`	The Google search URL, which contains the search keyword "coffee" along with language parameters (hl=en for English), regional parameters (gl=us for the United States), and other search parameters, used to redirect to the corresponding Google search page	desktop
`status`	`string`	Status of the search execution (e.g., Success)	desktop
`raw_html_file`	`string`	Identifier for the original HTML file	desktop
`total_time_taken`	`number`	The total time spent on the entire search process (including request sending, result parsing, and other stages)	desktop

search_information

object Contains information about the search results

Parameter	Type	Description	Applicable Terminal
`time_taken_displayed`	`number`	TDisplay time (i.e., the time spent on displaying the search results)	desktop

search_parameters

object Contains the parameters used for the search

Parameter	Type	Description	Applicable Terminal
`q`	`string`	Keywords used for this query	desktop
`gl`	`string`	Used to specify the country or region scope of the search results	desktop
`hl`	`string`	Used to specify the language of the Google search interface	desktop
`engine`	`string`	Search engine used for this query (e.g., google_web)	desktop
`device`	`string`	Device type used during search (e.g., desktop)	desktop
`udm`	`number`	Google Search type identifier	desktop

shopping_results

object[] Corresponds to Google's "Shopping" scenario (such as price comparison/purchase entry points displayed after users search for products)

Parameter	Type	Description	Applicable Terminal
`product_link`	`string`	Google Shopping product detail page link, which can redirect to the Google Shopping platform to view more product information	desktop
`price`	`string`	Product price with currency unit	desktop
`thumbnail`	`string`	Thumbnail link (address of small-sized preview images related to the content, used for quick visual recognition, including data:image/png;base64)	desktop
`extracted_price`	`string`	Pure numeric price extracted from the "price" field (removing the dollar sign)	desktop

text_blocks

object[] Google search "Content Summary" module

Parameter	Type	Description	Applicable Terminal
`snippet`	`string`	Paragraph specific content	desktop
`type`	`string`	ext block format type	desktop
`items`	`object[]`	Array of list item collections	desktop
`items[].snippet`	`string`	Specific content of the list item	desktop

references

object[] The "References" module commonly seen in Google searches (such as the source links provided when answering strategy-related questions)

Parameter	Type	Description	Applicable Terminal
`title`	`string`	Title of the quoted content, clearly indicating the topic of the citation	desktop
`link`	`string`	The jump link for the quoted content, in the format of a redirection URL for Google search	desktop
`source`	`string`	Original source platform / website name of the quoted content	desktop