---
canonical_url: "https://docs.composio.dev/toolkits/brave_search"
markdown_url: "https://docs.composio.dev/toolkits/brave_search.md"
product: "platform"
version: null
last_updated: null
---

# Brave Search

Access Brave's independent search index, grounded AI answers, suggestions, spellcheck, and related search products through one API.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 17
- **Triggers:** 0
- **Slug:** `BRAVE_SEARCH`
- **Version:** 00000000_00

## Tools

### Check Search Spelling

**Slug:** `BRAVE_SEARCH_CHECK_SPELLING`

Return Brave spelling corrections for a search phrase; an empty result means no correction was suggested and requires the Spellcheck product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Search phrase to check for spelling corrections (1-400 characters and at most 50 words). |
| `country` | string | No | Two-letter country code, or ALL, used to localize corrections. |
| `language` | string | No | Language code used as a hint for spelling analysis. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Grounded Answer

**Slug:** `BRAVE_SEARCH_GENERATE_GROUNDED_ANSWER`

Generate one non-streaming web-grounded answer from a single user message using Brave Answers. The connected API key must have the separately activated Answers product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `seed` | integer | No | OpenAI-compatible seed accepted but currently ignored by Brave. |
| `model` | string ("brave-pro" | "brave") | No | Brave Answers model; brave-pro is the higher-capability mode. |
| `country` | string | No | Country code used to localize grounding searches. |
| `language` | string | No | Language code for the answer and grounding searches. |
| `metadata` | object | No | OpenAI-compatible metadata accepted but currently ignored by Brave. |
| `safe_search` | string | No | Brave safe-search setting for grounding retrieval. |
| `user_message` | string | Yes | The single user question or instruction to answer with web grounding. |
| `web_search_options` | object | No | Optional context-size and approximate-location search tuning. |
| `max_completion_tokens` | integer | No | Maximum number of tokens Brave may generate in the answer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Legacy Summary

**Slug:** `BRAVE_SEARCH_GET_LEGACY_SUMMARY`

Fetch one current poll result for a legacy Brave Summarizer key produced by web search with summary=true. This deprecated API is available only to accounts grandfathered into the discontinued Pro AI plan; new accounts cannot obtain access. Complete and failed are terminal statuses, while any other status should be retried later by calling the action again.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `summary_key` | string | Yes | Key returned by a Brave web search made with summary=true. The connected API key must have the discontinued, grandfathered Pro AI entitlement. |
| `inline_references` | boolean | No | Include source references inline in the summary token stream. |
| `include_entity_info` | boolean | No | Include entity information associated with a completed summary. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LLM Context (GET)

**Slug:** `BRAVE_SEARCH_GET_LLM_CONTEXT`

Retrieve token-budgeted web snippets and source metadata for grounding or RAG using URL-friendly parameters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Search recall input used during context extraction; it is not a strict count of returned grounding entries. |
| `query` | string | Yes | Question or search query whose supporting context should be extracted (1-600 characters and at most 75 words). |
| `country` | string | No | Two-letter country code, or ALL for worldwide source retrieval. |
| `goggles` | string | No | One Goggles URL or inline definition, or a list of at most 3 definitions used to rerank or filter source retrieval. |
| `freshness` | string | No | Limit source retrieval by recency (pd, pw, pm, or py) or an inclusive YYYY-MM-DDtoYYYY-MM-DD date range. |
| `spellcheck` | boolean | No | Allow Brave to correct the query. |
| `safe_search` | string ("off" | "moderate" | "strict") | No | Adult-content filtering level. |
| `enable_local` | boolean | No | Force local grounding on or off; omit to let Brave infer local recall from location headers. |
| `location_city` | string | No | Caller city used to infer local grounding. |
| `search_language` | string | No | Language code for source content. |
| `location_country` | string | No | Caller country code used to infer local grounding. |
| `location_latitude` | number | No | Caller latitude for local grounding; provide with location_longitude. |
| `location_longitude` | number | No | Caller longitude for local grounding; provide with location_latitude. |
| `location_state_code` | string | No | Caller state or region code used to infer local grounding. |
| `location_state_name` | string | No | Caller state or region name used to infer local grounding. |
| `location_postal_code` | string | No | Caller postal code used to infer local grounding. |
| `context_threshold_mode` | string ("disabled" | "strict" | "lenient" | "balanced") | No | Relevance threshold policy for including context. |
| `enable_source_metadata` | boolean | No | Include expanded source metadata in the response. |
| `maximum_number_of_urls` | integer | No | URL extraction budget; this is not a strict cap on generic grounding entries. |
| `maximum_number_of_tokens` | integer | No | Overall token budget for extracted context. |
| `maximum_number_of_snippets` | integer | No | Overall snippet extraction budget. |
| `maximum_number_of_tokens_per_url` | integer | No | Per-source token extraction budget. |
| `maximum_number_of_snippets_per_url` | integer | No | Per-source snippet extraction budget. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LLM Context (POST)

**Slug:** `BRAVE_SEARCH_GET_LLM_CONTEXT_POST`

Retrieve token-budgeted web snippets and source metadata for grounding or RAG with a JSON body, suited to complex requests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Search recall input used during extraction; not a strict output-entry count. |
| `query` | string | Yes | Question or search query whose supporting context should be extracted; at most 75 words. |
| `country` | string | No | Two-letter country code, or ALL for worldwide source retrieval. |
| `goggles` | string | No | One Goggles definition, or a list of at most 3, used to rerank or filter source retrieval. |
| `freshness` | string | No | Limit source retrieval by recency using pd, pw, pm, py, or an inclusive YYYY-MM-DDtoYYYY-MM-DD date range. |
| `spellcheck` | boolean | No | Allow Brave to correct the query. |
| `safe_search` | string ("off" | "moderate" | "strict") | No | Adult-content filtering level. |
| `enable_local` | boolean | No | Force local grounding on or off; omit to use Brave's automatic behavior. |
| `search_language` | string | No | Language code for source content. |
| `context_threshold_mode` | string ("disabled" | "strict" | "lenient" | "balanced") | No | Relevance threshold policy for including context. |
| `enable_source_metadata` | boolean | No | Include expanded source metadata in the response. |
| `maximum_number_of_urls` | integer | No | URL extraction budget; not a strict cap on generic grounding entries. |
| `maximum_number_of_tokens` | integer | No | Overall token budget for extracted context. |
| `maximum_number_of_snippets` | integer | No | Overall snippet extraction budget. |
| `maximum_number_of_tokens_per_url` | integer | No | Per-source token extraction budget. |
| `maximum_number_of_snippets_per_url` | integer | No | Per-source snippet extraction budget. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Local Descriptions

**Slug:** `BRAVE_SEARCH_GET_LOCAL_DESCRIPTIONS`

Fetch AI-generated Markdown descriptions for up to 20 ephemeral POI IDs returned recently by place or web search.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `poi_ids` | array | Yes | Ephemeral POI IDs from Search Places or a web search. IDs remain valid for about 8 hours. Each ID is sent as a repeated ids query parameter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Local POIs

**Slug:** `BRAVE_SEARCH_GET_LOCAL_POIS`

Fetch structured details for up to 20 ephemeral POI IDs returned recently by place or web search. Unknown or expired IDs may return null entries in the results array.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `units` | string ("imperial" | "metric") | No | Measurement system for distances and related values. |
| `poi_ids` | array | Yes | Ephemeral POI IDs from Search Places or a web search. IDs remain valid for about 8 hours. Each ID is sent as a repeated ids query parameter. |
| `ui_language` | string | No | Language and region code for response labels. |
| `search_language` | string | No | Language code for POI content. |
| `location_latitude` | number | No | Caller latitude for localized distance information; provide with location_longitude. |
| `location_longitude` | number | No | Caller longitude for localized distance information; provide with location_latitude. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Rich Result

**Slug:** `BRAVE_SEARCH_GET_RICH_RESULT`

Resolve a fresh callback key from a rich-enabled web search into its real-time vertical result, such as weather, finance, sports, conversions, or definitions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `callback_key` | string | Yes | Fresh callback key returned by Search Web when enable_rich_callback is true and a rich match exists. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Search Suggestions

**Slug:** `BRAVE_SEARCH_GET_SEARCH_SUGGESTIONS`

Return typo-tolerant autocomplete suggestions for a partial query, optionally with rich entity metadata; requires the Autosuggest product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rich` | boolean | No | Include entity titles, descriptions, and image URLs when available; requires paid Autosuggest support for rich suggestions. |
| `count` | integer | No | Maximum number of suggestions to return; Brave may return fewer. |
| `query` | string | Yes | Partial or complete query to autocomplete (1-400 characters and at most 50 words). |
| `country` | string | No | Two-letter country code, or ALL, used to localize suggestions. |
| `language` | string | No | Language code used as a hint when generating suggestions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Images

**Slug:** `BRAVE_SEARCH_SEARCH_IMAGES`

Search Brave's image index and return up to 200 image matches in one non-paginated response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Maximum image results to return; this endpoint has no next page. |
| `query` | string | Yes | Image search query (1-400 characters and at most 50 words). |
| `country` | string | No | Two-letter country code, or ALL for worldwide results. |
| `spellcheck` | boolean | No | Allow Brave to correct the search query. |
| `safe_search` | string ("off" | "strict") | No | Adult-content filtering level. |
| `search_language` | string | No | Language code for image result context. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search News (GET)

**Slug:** `BRAVE_SEARCH_SEARCH_NEWS_GET`

Search Brave's news index with URL-friendly parameters and return one requested page of current news results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Maximum news results on this page. |
| `query` | string | Yes | News search query. Brave accepts at most 50 words. |
| `offset` | integer | No | Zero-based result page number, not an item offset. |
| `country` | string | No | Two-letter country code used to localize results. |
| `goggles` | string | No | One Goggle URL or inline definition, or a list of up to three, used to rerank or filter results. |
| `freshness` | string | No | Limit news by recency using pd, pw, pm, py, or an inclusive YYYY-MM-DDtoYYYY-MM-DD date range. |
| `operators` | boolean | No | Interpret supported Brave search operators in the query. |
| `spellcheck` | boolean | No | Allow Brave to correct the search query. |
| `safe_search` | string ("off" | "moderate" | "strict") | No | Adult-content filtering level. |
| `ui_language` | string | No | Language and region code for response labels. |
| `extra_snippets` | boolean | No | Include additional snippets when available. |
| `search_language` | string | No | Language code for news content. |
| `include_fetch_metadata` | boolean | No | Include fetch timestamps and related metadata when available. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search News (POST)

**Slug:** `BRAVE_SEARCH_SEARCH_NEWS_POST`

Search Brave's news index with a JSON body, suited to long queries or complex Goggles, and return one requested result page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Maximum number of news results on this page; the provider may return fewer. |
| `query` | string | Yes | News search query of at most 400 characters and 50 words; use POST when the complete request may exceed practical URL limits. |
| `offset` | integer | No | Zero-based result page number, not an item offset. |
| `country` | string | No | Two-letter supported country code used to localize results, or ALL for worldwide results. |
| `goggles` | string | No | One Goggle URL or inline definition, or a list of at most three, used to rerank or filter results. |
| `freshness` | string | No | Limit news by recency using pd, pw, pm, py, or an inclusive YYYY-MM-DDtoYYYY-MM-DD date range. |
| `operators` | boolean | No | Interpret supported Brave search operators in the query. |
| `spellcheck` | boolean | No | Allow Brave to correct the search query and search using the corrected form. |
| `safe_search` | string ("off" | "moderate" | "strict") | No | Adult-content filtering level. |
| `ui_language` | string | No | Language and region code for response labels. |
| `extra_snippets` | boolean | No | Include up to five additional alternative snippets for each result when available. |
| `search_language` | string | No | Language code for news content. |
| `include_fetch_metadata` | boolean | No | Include provider fetch timestamps and related metadata when available. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Places

**Slug:** `BRAVE_SEARCH_SEARCH_PLACES`

Search Brave's geographic index for POIs and named places. Returns all matching result buckets and ephemeral POI IDs for prompt follow-up with local detail and description tools.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Maximum combined results across all place buckets. |
| `query` | string | No | Place or POI query; omit only to explore general POIs near an anchor. |
| `units` | string ("imperial" | "metric") | No | Measurement system for distances and related values. |
| `country` | string | No | Two-letter country code, or ALL, used to localize place results. |
| `latitude` | number | No | Latitude anchor for the search area; provide with longitude. |
| `location` | string | No | Named place anchor to use instead of latitude and longitude. |
| `longitude` | number | No | Longitude anchor for the search area; provide with latitude. |
| `spellcheck` | boolean | No | Allow Brave to correct the place query. |
| `geolocation` | string | No | Coordinate string in <latitude>x<longitude> format used for distance calculation, for example 37.7749x-122.4194. |
| `safe_search` | string ("off" | "moderate" | "strict") | No | Adult-content filtering level. |
| `ui_language` | string | No | Language and region code for response labels. |
| `radius_meters` | number | No | Distance bias in meters, not a hard result cutoff. |
| `search_language` | string | No | Language code for place content. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Videos (GET)

**Slug:** `BRAVE_SEARCH_SEARCH_VIDEOS_GET`

Search Brave's video index with URL-friendly parameters and return one requested page of video results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Maximum number of video results on this page; Brave may return fewer. |
| `query` | string | Yes | Video search query of at most 400 characters and 50 words. |
| `offset` | integer | No | Zero-based result page number, not an item offset. |
| `country` | string | No | Supported two-letter country code used to localize results, or ALL for worldwide results. |
| `freshness` | string | No | Limit videos by recency using pd, pw, pm, or py, or by an inclusive YYYY-MM-DDtoYYYY-MM-DD date range. |
| `operators` | boolean | No | Interpret supported Brave search operators in the query. |
| `spellcheck` | boolean | No | Allow Brave to correct the query and search using the corrected form. |
| `safe_search` | string ("off" | "moderate" | "strict") | No | Adult-content filtering level. |
| `ui_language` | string | No | Language and region code for response labels. |
| `search_language` | string | No | Language code for video content. |
| `include_fetch_metadata` | boolean | No | Include fetch timestamps and related metadata when available. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Videos (POST)

**Slug:** `BRAVE_SEARCH_SEARCH_VIDEOS_POST`

Search Brave's video index with a JSON body, suited to long requests, and return one requested result page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Maximum number of video results on this page; Brave may return fewer. |
| `query` | string | Yes | Video search query of at most 400 characters and 50 words; use POST when the request may exceed practical URL limits. |
| `offset` | integer | No | Zero-based result page number, not an item offset. |
| `country` | string | No | Supported two-letter country code used to localize results, or ALL for worldwide results. |
| `freshness` | string | No | Limit videos by recency using pd, pw, pm, py, or an inclusive YYYY-MM-DDtoYYYY-MM-DD date range. |
| `operators` | boolean | No | Interpret supported Brave search operators in the query. |
| `spellcheck` | boolean | No | Allow Brave to correct the query and search using the corrected form. |
| `safe_search` | string ("off" | "moderate" | "strict") | No | Adult-content filtering level. |
| `ui_language` | string | No | Language and region code for response labels. |
| `search_language` | string | No | Language code for video content. |
| `include_fetch_metadata` | boolean | No | Include provider fetch timestamps and related metadata when available. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Web (GET)

**Slug:** `BRAVE_SEARCH_SEARCH_WEB_GET`

Search Brave's web index with URL-friendly parameters and return one requested result page plus any matching vertical, local, rich-callback, or legacy-summary metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Maximum number of web results on this page; other vertical counts may differ. |
| `query` | string | Yes | Search query (1-600 characters and at most 75 words); supports Brave search operators when operators is enabled. |
| `units` | string ("imperial" | "metric") | No | Measurement system for applicable rich or local results. |
| `offset` | integer | No | Zero-based result page number, not an item offset. |
| `country` | string | No | Two-letter country code, or ALL for worldwide results. |
| `goggles` | string | No | One Goggles URL or inline definition, or a list of at most 3 definitions. |
| `summary` | boolean | No | Request a legacy Summarizer key. This requires a grandfathered Pro AI entitlement and the key can be passed to the legacy summary action. |
| `freshness` | string | No | Limit results by recency (pd, pw, pm, or py) or an inclusive date range formatted YYYY-MM-DDtoYYYY-MM-DD. |
| `operators` | boolean | No | Interpret supported Brave search operators in the query. |
| `goggles_id` | string | No | Deprecated Goggles identifier; prefer goggles. |
| `spellcheck` | boolean | No | Allow Brave to correct the search query. |
| `user_agent` | string | No | Optional caller identifier sent to Brave for this request. |
| `api_version` | string | No | Optional Brave API version header; omit to use the provider default. |
| `safe_search` | string ("off" | "moderate" | "strict") | No | Adult-content filtering level. |
| `ui_language` | string | No | Language and region code for response labels. |
| `cache_control` | string | No | Optional HTTP cache directive for this search request. |
| `location_city` | string | No | Caller city used as a local-search hint. |
| `result_filter` | string | No | Comma-separated subset of discussions, faq, infobox, news, query, summarizer, videos, web, and locations to return. |
| `extra_snippets` | boolean | No | Include additional result snippets when available. |
| `search_language` | string | No | Language code for result content. |
| `location_country` | string | No | Caller country code used as a local-search hint. |
| `text_decorations` | boolean | No | Include Brave's text decoration markup in result text. |
| `location_latitude` | number | No | Approximate caller latitude used to localize results; provide with location_longitude. |
| `location_timezone` | string | No | IANA timezone used to localize time-sensitive results. |
| `location_longitude` | number | No | Approximate caller longitude used to localize results; provide with location_latitude. |
| `location_state_code` | string | No | Caller state or region code used as a local-search hint. |
| `location_state_name` | string | No | Caller state or region name used as a local-search hint. |
| `enable_rich_callback` | boolean | No | Return a callback key for a matching rich vertical; pass that fresh key promptly to the rich-result action. |
| `location_postal_code` | string | No | Caller postal code used as a local-search hint. |
| `include_fetch_metadata` | boolean | No | Include provider fetch timestamps and related metadata when available. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Web (POST)

**Slug:** `BRAVE_SEARCH_SEARCH_WEB_POST`

Search Brave's web index with a JSON body, suited to long queries or complex Goggles, and return one requested result page plus matching vertical metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Maximum number of web results on this page; other vertical counts may differ. |
| `query` | string | Yes | Search query (1-600 characters and at most 75 words); use this POST variant when the complete request may exceed practical URL limits. |
| `units` | string ("imperial" | "metric") | No | Measurement system for applicable rich or local results. |
| `offset` | integer | No | Zero-based result page number, not an item offset. |
| `country` | string | No | Two-letter country code, or ALL for worldwide results. |
| `goggles` | string | No | One Goggles URL or inline definition, or a list of at most 3 definitions. |
| `summary` | boolean | No | Request a legacy Summarizer key. This requires a grandfathered Pro AI entitlement and the key can be passed to the legacy summary action. |
| `freshness` | string | No | Limit results by recency (pd, pw, pm, or py) or an inclusive date range formatted YYYY-MM-DDtoYYYY-MM-DD. |
| `operators` | boolean | No | Interpret supported Brave search operators in the query. |
| `goggles_id` | string | No | Deprecated Goggles identifier; prefer goggles. |
| `spellcheck` | boolean | No | Allow Brave to correct the search query. |
| `safe_search` | string ("off" | "moderate" | "strict") | No | Adult-content filtering level. |
| `ui_language` | string | No | Language and region code for response labels. |
| `result_filter` | string | No | Comma-separated subset of discussions, faq, infobox, news, query, summarizer, videos, web, and locations to return. |
| `extra_snippets` | boolean | No | Include additional result snippets when available. |
| `search_language` | string | No | Language code for result content. |
| `text_decorations` | boolean | No | Include Brave's text decoration markup in result text. |
| `enable_rich_callback` | boolean | No | Return a callback key for a matching rich vertical; pass that fresh key promptly to the rich-result action. |
| `include_fetch_metadata` | boolean | No | Include provider fetch timestamps and related metadata when available. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |