brave-search-api

Execute Brave Search API queries and output structured JSON results.

21|11|Updated Jul 4, 2025
One-click install
npx skills add https://github.com/s-hiraoku/vscode-sidebar-terminal --skill brave-search-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: brave-search-api
Source: https://github.com/s-hiraoku/vscode-sidebar-terminal/tree/main/.claude/skills/brave-search-api
Command: npx skills add https://github.com/s-hiraoku/vscode-sidebar-terminal --skill brave-search-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill enables direct, programmatic web searching using the Brave Search API, bypassing manual browser interaction. It allows users to quickly retrieve current information, news, and articles, saving time and integrating search capabilities directly into automated workflows.

Core Features & Use Cases

  • General Web Search: Perform targeted web searches for current information, articles, and documentation.
  • Local Search: Find local businesses and places based on a query.
  • Response Processing: Easily extract relevant fields like titles, URLs, and descriptions from search results using jq.
  • Use Case: Find the latest articles on VS Code extension development in 2024 and extract their titles and URLs to quickly gather research material.

Quick Start

Use the brave-search-api skill to search for 'latest AI news' and return the top 3 results with their titles and URLs.

Frequently Asked Questions about brave-search-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I perform web searches programmatically without a browser?

Web search via the Brave Search API executes curl-based queries against Brave's endpoints to retrieve current results. Set your BRAVE_API_KEY environment variable, then construct GET requests to /res/v1/web/search with parameters like q, count, and offset to get structured JSON results with titles, URLs, and descriptions.

Can I search for local businesses and places using an API?

Local search is supported through the Brave Search API's /res/v1/local/search endpoint. Query with your location-based search term, count, and offset parameters to retrieve structured results for businesses and places, which you can parse with jq to extract specific fields.

What environment setup do I need to start searching with the Brave API?

You need a BRAVE_API_KEY set as an environment variable and curl capability to make GET requests. The Skill constructs and executes requests directly against Brave Search API endpoints, so no additional dependencies or components are required—only API credentials.

How do I extract specific fields like titles and URLs from search results?

Search results return structured JSON that you can parse with jq. Use jq selectors to extract fields such as titles, URLs, and descriptions from the response, allowing you to quickly filter and format results for research, articles, or documentation gathering.

What's the difference between web search and local search with Brave API?

Web search queries /res/v1/web/search to retrieve current articles, news, and documentation across the internet. Local search queries /res/v1/local/search to find businesses and places geographically. Both accept the same parameter structure but return results tailored to their respective scope.

Can I automate research gathering with real-time web search results?

Yes, the Brave Search API enables workflow automation for research by retrieving current information, articles, and news programmatically. Integrate curl-based queries into scripts to gather latest content on specific topics, eliminating manual browser searches and enabling batch research workflows.