View as Markdown
Brave Search API icon

Brave Search API ACTION

Web Search

Query Brave Search and get back search results from the web. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Brave Search API account once, then configure and run Web Search 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: "brave_search_api-web-search",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    brave_search_api: { authProvisionId: "apn_xxxxxxx" },
    q: "Query",
    country: "Country",
  },
})

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.

Web Search inputs
Property Type Description
q Query string
Search query string
Required
country Country string
Country code to localize search results
Optional
searchLang Search Language string
Language to use for search results
Optional
uiLang UI Language string
Language for the user interface
Optional
safesearch SafeSearch string
SafeSearch filter level
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
brave_search_api-web-search
Version
0.0.2
App
Brave Search API
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes