Skip to main content

Brave Search API

Velaclaw supports Brave Search API as a web_search provider.

Get an API key

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

Config example

Provider-specific Brave search settings now live under plugins.entries.brave.config.webSearch.*. Legacy tools.web.search.apiKey still loads through the compatibility shim, but it is no longer the canonical config path. webSearch.mode controls the Brave transport:
  • web (default): normal Brave web search with titles, URLs, and snippets
  • llm-context: Brave LLM Context API with pre-extracted text chunks and sources for grounding

Tool parameters

Examples:

Notes

  • Velaclaw uses the Brave Search plan. If you have a legacy subscription (e.g. the original Free plan with 2,000 queries/month), it remains valid but does not include newer features like LLM Context or higher rate limits.
  • Each Brave plan includes $5/month in free credit (renewing). The Search plan costs $5 per 1,000 requests, so the credit covers 1,000 queries/month. Set your usage limit in the Brave dashboard to avoid unexpected charges. See the Brave API portal for current plans.
  • The Search plan includes the LLM Context endpoint and AI inference rights. Storing results to train or tune models requires a plan with explicit storage rights. See the Brave Terms of Service.
  • llm-context mode returns grounded source entries instead of the normal web-search snippet shape.
  • llm-context mode does not support ui_lang, freshness, date_after, or date_before.
  • ui_lang must include a region subtag like en-US.
  • Results are cached for 15 minutes by default (configurable via cacheTtlMinutes).