Skip to main content

Google Search API

Siesta AI - Google Search allows you to programmatically perform web searches via the Google Custom Search JSON API. The connection is read-only and returns structured JSON with results.

1. Setting up Google Search API (practical steps)​

  1. Project in Google Cloud: use an existing project or create a new one.
  2. Enable Custom Search API: search for "Custom Search API" in the API Library and click Enable. Enabling Custom Search API in API Library
  3. Create Programmable Search Engine: go to https://programmablesearchengine.google.com/, open the list of search engines, and click Add. List of search engines in Programmable Search Engine Creating a new search engine
  4. Get Search Engine ID (cx): in the search engine details, open the Basic section and copy the Search Engine ID. Copying Search Engine ID (cx)
  5. Generate API Key: in Google Cloud Console -> APIs & Services -> Credentials -> Create credentials -> API key. Creating API key in Credentials
  6. Key restrictions (recommended):
    • Application restrictions: as needed (None/Websites/IP).
    • API restrictions: Restrict key -> Custom Search API.
  7. Settings in Siesta AI:
    • Connection -> Add Connection -> GoogleSearch.
    • Fill in Key (API Key) and Cx (Search Engine ID) and choose Shared/Private.
    • Save via Continue. Setting up GoogleSearch Connection in Siesta AI

2. Purpose of the document​

The goal is to enable programmatic access to web search results via the Google Custom Search JSON API.

3. Connection Overview​

  • Connection Name: GoogleSearch
  • Type: REST API - Google Custom Search JSON API
  • Authentication: API Key (Google Cloud) + Search Engine ID (cx) (OAuth not required)
  • Scope: read/search only
  • Output: JSON object with search results
  • Note: There are no write operations; all calls are idempotent.

The Google Custom Search JSON API allows you to programmatically retrieve search results from Google via the Programmable Search Engine, which must be created and configured before use.

4. General Principles​

4.1 Configuration​

  • Search Engine ID (cx): identifier for your custom search instance.
  • API Key: mandatory parameter for authorized calls to Google API.
  • Output: JSON contains search metadata and result set (title, snippet, URL, pagemap, etc.).

4.2 Query Syntax​

  • The query parameter (alias q) specifies the search term.
  • Advanced operators such as site:, intitle: etc. can be used (standard Google query syntax).

5. API Operations​

Description: Performs a web search via the Google Custom Search JSON API.
HTTP: GET https://www.googleapis.com/customsearch/v1?key={API_KEY}&cx={SEARCH_ENGINE_ID}&q={query}

ParameterTypeRequiredDescription
queryStringYesSearch term (e.g., "AI best practices").

Output

  • List of results (title, URL, snippet)
  • Metadata about the number of results
  • Possible additional blocks (pagemap)

Behavior and Limits

  • Standard response ~10 results per page; additional pages via start (outside the scope of Connection).

Typical Errors

  • 400 Bad Request - invalid query
  • 401 Unauthorized - invalid API Key
  • 403 Quota Exceeded - daily quota exceeded

6. Security and Governance​

  • Keep the API Key secure; prefer restrictions (domains/IP, limit to Custom Search API).
  • Monitor quotas and log for billing control.
  • Log at least: query string, call time, number of results, HTTP status.

7. Operational Recommendations​

  • Set a rotation policy for the API Key (Rotate key in Google Cloud Console).
  • Keep cx and API Key in a secure secrets store; update Connection when changing the key.

8. Example Usage​

GET https://www.googleapis.com/customsearch/v1
  ?key=YOUR_API_KEY
  &cx=YOUR_SEARCH_ENGINE_ID
  &q=cloud+infrastructure+best+practices

Shortened JSON:

{
  "queries": { "request": [ { "query": "cloud infrastructure best practices" } ] },
  "items": [
    { "title": "...", "link": "...", "snippet": "..." }
  ]
}