Agentic Platform
Documentation API reference Tools Skills

Tools

Google Ai Overview

google_ai_overview Google Web search

Query Google AI Overview to get an AI-generated summary from a query.

Fetch the AI-powered summary from Google AI Overview, a snapshot of key information about a topic or question with links. When `save_to_tmp_storage` is enabled, the summary is written to temporary project storage and a URL is returned instead of the inline results.

Playground

POST
item
query required

The search query to analyze

config
location_id

Location ID (optional)

location_request

Location request (ex: Paris, FR), will translate to location ID

country_code

ISO3166 country code (ex: GB)

lang_code

BCP47 language code (ex: "en", "en-GB")

device

Device to use for search (optional - defaults to mobile)

save_to_tmp_storage

Save the bulky result payload to Botify temporary storage and return the temporary URL instead of the payload. Use this to save output tokens.

Credits

Fixed cost per query requested, plus one AI Overview results page per query, which search engines charge more for than a plain results page. Called while you wait it is billed live; submitted as a background batch it is billed async, which costs appreciably less, and collecting the finished batch is free. A query that has no AI Overview is still billed: the page was fetched.

These usage SKUs can be charged on a call.

SKU Credits Description
Tool call 1 per request Charged once per successful item, on top of any usage below.
AI Overview results (async) 12 per 10 query The same AI Overview page, submitted as a background batch.
AI Overview results (live) 4 per query A results page including its AI Overview block, which search engines charge more for than a plain results page.

Schemas

item is what you send, config how the tool behaves, and the response is what you get back.

Item

object
Properties
query string required

The search query to analyze

max length 700

Example
{
  "query": "string"
}

Configuration

object
Properties
location_id integer | null

Location ID (optional)

Default: null

location_request string | null

Location request (ex: Paris, FR), will translate to location ID

Default: null

country_code string | null

ISO3166 country code (ex: GB)

Default: null

lang_code string | null

BCP47 language code (ex: "en", "en-GB")

Default: null

device string

Device to use for search (optional - defaults to mobile)

Values: mobile desktop

Default: "mobile"

save_to_tmp_storage boolean

Save the bulky result payload to Botify temporary storage and return the temporary URL instead of the payload. Use this to save output tokens.

Default: false

Example
{
  "location_id": null,
  "location_request": null,
  "country_code": null,
  "lang_code": null,
  "device": "mobile",
  "save_to_tmp_storage": false
}

Response

object

AI Overview result that can offload `results` to temporary storage.

Properties
query string required

The original search query

location_name string required

The location used for the search, if any

results GoogleAiOverviewResults

The AI-generated search results. Omitted when `save_to_tmp_storage` is True; see `results_tmp_storage_url` instead.

Type: GoogleAiOverviewResults

Default: null

results_tmp_storage_url string | null

Temporary storage URL of the AI Overview results. Returned instead of `results` when `save_to_tmp_storage` is True.

Default: null

Example
{
  "query": "string",
  "location_name": "string",
  "results": null,
  "results_tmp_storage_url": null
}

Type Definitions

5 types

These are the available sub-object types that can be used in the properties above.

GooglAiOverviewReference object
#
type string required
source string required
domain string required
url string required
title string required
text string | null

Default: null

GoogleAiOverviewElement object
#
type string required
title string | null

Default: null

text string | null

Default: null

markdown string | null

Default: null

links GoogleAiOverviewLinkElement

Items: GoogleAiOverviewLinkElement

Default: null

images GoogleAiOverviewImageElement

Items: GoogleAiOverviewImageElement

Default: null

references GooglAiOverviewReference

Items: GooglAiOverviewReference

Default: null

GoogleAiOverviewImageElement object
#
type string required
alt string | null

Default: null

url string | null

Default: null

image_url string required
GoogleAiOverviewLinkElement object
#
type string required
title string required
description string | null

Default: null

url string | null

Default: null

domain string | null

Default: null

GoogleAiOverviewResults object
#
type string required
markdown string | null

Default: null

items GoogleAiOverviewElement

Items: GoogleAiOverviewElement

Default: null

model string | null

Name / version of the model used

Default: null

Endpoints

POST http://agents.botify.com/{organization}/{project}/google_ai_overview/process
POST http://agents.botify.com/{organization}/{project}/google_ai_overview/batch_process
POST http://agents.botify.com/{organization}/{project}/google_ai_overview/async_process
POST http://agents.botify.com/{organization}/{project}/google_ai_overview/async_batch_process

See running a long job in the background for the polling flow.

cURL

curl -X POST "http://agents.botify.com/{organization}/{project}/google_ai_overview/process" \
  -H "Authorization: Bearer $BOTIFY_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "item": {
    "query": "<query>"
  }
}'

Raw metadata