> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/brave-search.md).

# Brave Search

Search Brave's independent web, news, image, and video indexes and generate summaries for eligible accounts.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector    | Authentication     |
| ------------ | ------------------ |
| Brave Search | Subscription Token |

#### Brave Search

Connect to Brave Search to find web pages, news, images, videos, and eligible AI summaries.

**Set up in Brave Search**

1. Prepare the Brave Search account or service that the workflow will access. Grant access to the required resources and operations.
2. **Subscription Token:** Create or copy a subscription token from the Brave Search API dashboard.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Brave Search**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field      | Required | What to enter                                                                                                                                      |
| ------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| Subscription Token | Yes      | Create or copy a subscription token from the Brave Search API dashboard. [Provider instructions](https://api-dashboard.search.brave.com/app/keys). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Brave Search** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Search Web

Find relevant web pages with Brave Search.

**Inputs**

| Field           | Type            | Required | Description                                                                                     |
| --------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------- |
| Search Query    | string          | Yes      | Words or a question to search for.                                                              |
| Maximum Results | integer         | No       | Soft cap across Brave result pages. Minimum: 1. Maximum: 200. Default: 20.                      |
| Page            | integer         | No       | Continue from a page returned by an earlier search. Minimum: 1. Maximum: 10. Default: 1.        |
| Country         | string          | No       | Prefer results from a two-letter country code. Default: US.                                     |
| Search Language | string          | No       | Prefer content in this language. Default: en.                                                   |
| Safe Search     | select (string) | No       | Control filtering of adult content. Available values: Off, Moderate, Strict. Default: moderate. |

**Outputs**

| Field       | Type          | Description                           |
| ----------- | ------------- | ------------------------------------- |
| Web Results | object\_array | Typed matching page records.          |
| Next Page   | integer       | Page to use for the next search call. |

#### Search News

Find current or historical news articles with Brave Search.

**Inputs**

| Field           | Type            | Required | Description                                                                                                     |
| --------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
| Search Query    | string          | Yes      | Topic or event to find in the news.                                                                             |
| Maximum Results | integer         | No       | Soft cap across Brave news pages. Minimum: 1. Maximum: 500. Default: 20.                                        |
| Page            | integer         | No       | Continue from a later news page. Minimum: 1. Maximum: 10. Default: 1.                                           |
| Country         | string          | No       | Prefer news from a two-letter country code, or choose ALL for worldwide results. Default: US.                   |
| Search Language | string          | No       | Prefer news in this language. Default: en.                                                                      |
| Safe Search     | select (string) | No       | Control filtering of adult content. Available values: Off, Moderate, Strict. Default: strict.                   |
| Freshness       | select (string) | No       | Limit news to the past day, week, month, or year. Available values: Past Day, Past Week, Past Month, Past Year. |

**Outputs**

| Field        | Type          | Description                                     |
| ------------ | ------------- | ----------------------------------------------- |
| News Results | object\_array | Matching news articles.                         |
| Next Page    | integer       | Pass this back as Page to continue, if present. |

#### Search Images

Find images and their source pages with Brave Search.

**Inputs**

| Field           | Type            | Required | Description                                                                                     |
| --------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------- |
| Search Query    | string          | Yes      | What the images should depict.                                                                  |
| Maximum Images  | integer         | No       | Maximum images to return. Minimum: 1. Maximum: 200. Default: 50.                                |
| Country         | string          | No       | Prefer images from a two-letter country code, or choose ALL for worldwide results. Default: US. |
| Search Language | string          | No       | Prefer source pages in this language. Default: en.                                              |
| Safe Search     | select (string) | No       | Keep strict filtering or turn filtering off. Available values: Off, Strict. Default: strict.    |

**Outputs**

| Field              | Type          | Description                                          |
| ------------------ | ------------- | ---------------------------------------------------- |
| Image Results      | object\_array | Typed matching image records.                        |
| Might Be Offensive | boolean       | Whether Brave warns the result set may be offensive. |

#### Search Videos

Find videos and useful playback metadata with Brave Search.

**Inputs**

| Field           | Type            | Required | Description                                                                                                       |
| --------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
| Search Query    | string          | Yes      | Topic or video to search for.                                                                                     |
| Maximum Results | integer         | No       | Soft cap across Brave video pages. Minimum: 1. Maximum: 500. Default: 20.                                         |
| Page            | integer         | No       | Continue from a later video page. Minimum: 1. Maximum: 10. Default: 1.                                            |
| Country         | string          | No       | Prefer videos from a two-letter country code, or choose ALL for worldwide results. Default: US.                   |
| Search Language | string          | No       | Prefer videos in this language. Default: en.                                                                      |
| Safe Search     | select (string) | No       | Control filtering of adult content. Available values: Off, Moderate, Strict. Default: moderate.                   |
| Freshness       | select (string) | No       | Limit videos to the past day, week, month, or year. Available values: Past Day, Past Week, Past Month, Past Year. |

**Outputs**

| Field              | Type          | Description                                          |
| ------------------ | ------------- | ---------------------------------------------------- |
| Video Results      | object\_array | Typed matching video records.                        |
| Might Be Offensive | boolean       | Whether Brave warns the result set may be offensive. |
| Next Page          | integer       | Pass this back as Page to continue, if present.      |

#### Get AI Summary

Generate Brave's AI summary for a web query.

**Inputs**

| Field             | Type            | Required | Description                                                                                            |
| ----------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------ |
| Question          | string          | Yes      | Question for Brave to research and summarize.                                                          |
| Country           | string          | No       | Prefer source results from a two-letter country code. Default: US.                                     |
| Search Language   | string          | No       | Prefer sources in this language. Default: en.                                                          |
| Safe Search       | select (string) | No       | Control filtering of adult source content. Available values: Off, Moderate, Strict. Default: moderate. |
| Inline References | boolean         | No       | Include source markers within the summary when available. Default: true.                               |

**Outputs**

| Field               | Type          | Description                                  |
| ------------------- | ------------- | -------------------------------------------- |
| Status              | string        | Brave summary completion status.             |
| Title               | string        | Title generated for the summary.             |
| Summary             | string        | Completed AI-generated summary text.         |
| References          | object\_array | Typed source references used in the summary. |
| Follow-up Questions | string\_array | Related questions suggested by Brave.        |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/brave-search.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
