> ## Documentation Index
> Fetch the complete documentation index at: https://clair.im/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Google AI Overview API reference

> Google AI Overview API: search Google and get the AI Overview above the results, full text and every source it links, as JSON.

One endpoint, one key. It searches Google signed out and unpersonalized, and
reads the AI Overview above the results, including the part behind
**Show more**, with every source it links.

See the [Google AI Overview API: overview, pricing, and free tier](https://clair.im/apis/google-ai-overview).

## AI Overview

`GET /v1/google-ai-overview` · **1 request**

```sh theme={null}
curl -G https://api.clair.im/v1/google-ai-overview \
  -H "Authorization: Bearer YOUR_KEY" \
  --data-urlencode "q=best project management software for small teams"
```

| Parameter | Required | Contract |
| - | - | - |
| `q` | yes | The question, as a person would type it, up to 500 characters. |
| `country` | no | Two-letter country code the question is asked from, such as `us` or `gb`. Defaults to `us`. |

Google shows an overview on some searches only: on the rest, `answer` is
`null`. That is a successful request, and it is billed.

```json theme={null}
{
  "engine": "google_ai_overview",
  "family": "ai",
  "query": {
    "q": "best project management software for small teams",
    "country": "us"
  },
  "answer": {
    "text": "The best project management tools for small teams depend on your workflow style, budget, and how much structure you need:\nTrello: Best for visual Kanban boards and simplicity. Great for small teams that want an intuitive, card-and-list system with a generous free tier.\nAsana: Best for clean task tracking and ease of use. It is popular for cross-functional projects, marketing teams, and non-technical groups.\n...",
    "citations": [
      {
        "position": 1,
        "title": "YouTube · George Vlasyev",
        "url": "https://www.youtube.com/watch?v=Q1qUIaUDV5M&vl=en&t=110",
        "domain": "youtube.com"
      },
      {
        "position": 2,
        "title": "Reddit · r/projectmanagement",
        "url": "https://www.reddit.com/r/projectmanagement/comments/1vtl07f/project_management_tool_for_a_very_small_team/",
        "domain": "reddit.com"
      },
      {
        "position": 3,
        "title": "YouTube · George Vlasyev",
        "url": "https://www.youtube.com/watch?v=y30dYbckzfg&vl=en&t=40",
        "domain": "youtube.com"
      }
    ]
  }
}
```

| Field | Contents |
| - | - |
| `answer.text` | The answer as the page shows it, a line per paragraph, heading, or list item. |
| `answer.citations` | The sources the answer links, in the order it shows them, each once: `position`, `title`, `url`, `domain`. |

Answers change from one asking to the next, so nothing is cached. To measure
visibility, ask each question several times and count how often a brand is
named in `text` or its domain appears in `citations`.

## What counts as a citation

* A link to a source, in the answer or in the source list beside it, with
  Google's redirect resolved to the page itself.
* Not Google's product cards: a product's name linked to some page that
  mentions it. The product's name is still in `text`.
* Each URL once, in the order the answer first shows it.

## Errors

A page that loads with no answer, after every scraping vendor has tried, is
`502` `scrape_failed`; the request is not billed. A missing `q`, a `q` over
500 characters, or a `country` that is not two letters is `400`.

## What this API does not do

* It does not return the organic results; the
  [Google Search API](https://clair.im/docs/search-api/google-search.md) does.
* It does not return ads, shopping cards, or images shown with the overview.

Auth, plans, rate limits, and error codes: [Authentication](https://clair.im/docs/authentication.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.