View as Markdown
Search API icon

Search API ACTION

Google Search API

Run a Google web search. Returns organic_results alongside whichever other blocks Google included for the query See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Search API account once, then configure and run Google Search API from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "search_api-google-search",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    search_api: { authProvisionId: "apn_xxxxxxx" },
    q: "Query",
    device: "Device",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Google Search API inputs
Property Type Description
q Query string
The search query
Required
device Device string
The device to use for the search
Optional
domain Domain string
The domain to use for the search
Optional
hl Interface Language string
The default parameter en defines the interface language of the search.
Optional
gl Search Country string
The default parameter us defines the country of the search.
Optional
timePeriod Time Period string
This parameter restricts results to URLs based on date.
Optional
num Number of Results integer
This parameter specifies the number of results to display per page. Use in combination with the page parameter to implement pagination functionality.
Optional
page Page integer
This parameter indicates which page of results to return. By default, it is set to 1. Use in combination with the num parameter to implement pagination.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
search_api-google-search
Version
0.0.4
App
Search API
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes