Skip to content
Nappai Documentation

Brave Search API Tool

Brave Search API Tool runs web searches with the Brave Search engine and returns the results: title, link and a snippet of each page.

You can use it as a tool, connecting its Tool output to the Tools input of an agent: the agent decides when to search and what to type. You can also use it as a step in the flow, writing the search in Input and collecting the results from the Data output.

When to use it

  • A customer service assistant needs current public information, such as opening hours or news.
  • You want an agent to research a topic online before writing a report.
  • A flow searches for mentions of your brand and stores them for review.
  • You prefer a search engine other than Google or Bing.

Configuration

You need a Brave Search API credential with your Brave Search key. See Credentials.

FieldWhat it does
Credential (required)The Brave Search API credential used for searches.
Number of ResultsHow many results each search returns. Defaults to 10.
InputThe text to search for. Only used with the Data output; when you connect the Tool output the field is hidden, because the agent writes the search.

Output

  • Tool: connects to an agent’s Tools input. The agent receives the results of every search it runs.
  • Data: a list with one item per result, with its title, link and snippet.

When you connect one of the two outputs, the other one is hidden.

Example

A travel agency wants an assistant that answers questions about destinations with current information.

  1. Add Brave Search API Tool and pick the agency’s credential.
  2. Leave Number of Results at 10.
  3. Connect the Tool output to the agent’s Tools input.
  4. In the agent’s instructions, tell it to search the web when asked about recent events, opening hours or travel requirements.