​

Brave Search API

​

Get an API key

1. Create a Brave Search API account at https://brave.com/search/api/
2. In the dashboard, choose the Data for Search plan and generate an API key.
3. Store the key in config (recommended) or set BRAVE_API_KEY in the Gateway environment.

​

Config example

{
  tools: {
    web: {
      search: {
        provider: "brave",
        apiKey: "BRAVE_API_KEY_HERE",
        maxResults: 5,
        timeoutSeconds: 30,
      },
    },
  },
}

​

Tool parameters

// Country and language-specific search
await web_search({
  query: "renewable energy",
  country: "DE",
  language: "de",
});

// Recent results (past week)
await web_search({
  query: "AI news",
  freshness: "week",
});

// Date range search
await web_search({
  query: "AI developments",
  date_after: "2024-01-01",
  date_before: "2024-06-30",
});

​

Notes

• The Data for AI plan is not compatible with web_search.
• Brave provides paid plans; check the Brave API portal for current limits.
• Brave Terms include restrictions on some AI-related uses of Search Results. Review the Brave Terms of Service and confirm your intended use is compliant. For legal questions, consult your counsel.
• Results are cached for 15 minutes by default (configurable via cacheTtlMinutes).