---
title: "Google AI Overview"
method: GET
path: "/api/v1/search/ai-overview"
tags: ["Search"]
---

# Google AI Overview

`GET /api/v1/search/ai-overview`

## Request

- Base URL: `https://scrapewhale.dev`
- URL: `https://scrapewhale.dev/api/v1/search/ai-overview`
- Auth: one of:
  - HTTP bearer
  - API key in header `x-api-key`

Google’s full AI Overview for a query — the rich multi-source answer shown above the results: ordered text blocks (paragraphs, headings, lists) with `[n]` citation markers linking into a references list of cited sources. The key input for answer-engine (GEO) monitoring: see what Google’s AI says about a topic and which domains it cites. Overviews exist for roughly half of queries and Google generates them probabilistically — when none is produced the request fails with `empty_result` and the credits are refunded (retrying later can succeed). Cached for 24 hours.

**Credits: 2** (refunded on failure).

## Query parameters

- `q` string, required
- `gl` string
- `hl` string
- `format` 'json' | 'markdown' | 'both'

## Response `200`

Success.

- ExtractionResult: A completed extraction. `data` is omitted when format=markdown; `markdown` is omitted when format=json.
  - `id` string, required
  - `status` 'completed', required
  - `extractor` string, required: Extractor name, e.g. "traffic", "meta-ads", "instagram-profile".
  - `title` string, nullable
  - `sourceUrl` string, nullable: Canonical public URL of the extracted source.
  - `creditsCharged` integer, required: 0 when served from the shared cache.
  - `cached` boolean: True when served from the shared extraction cache (free).
  - `createdAt` integer, required: Unix epoch milliseconds.
  - `data` object, nullable: Raw structured payload from the source.
  - `markdown` string: Clean markdown rendering of the payload.

## Other responses

- `400`: Invalid parameters.
- `401`: Missing or invalid API key.
- `402`: Insufficient credits.
- `422`: Extraction/conversion failed — credits refunded. `code` carries the failure category.
- `429`: Rate limit exceeded (60 requests/min per key).

---

[API](https://skmtc.dev/scrapewhale/apis/scrapewhale-api.md) · [All operations](https://skmtc.dev/scrapewhale/apis/scrapewhale-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scrapewhale/apis/scrapewhale-api/revisions/3a19ec0be862?raw)
