Skip to main content
Brave Search logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 17
  • Triggers: 0
  • Slug: BRAVE_SEARCH
  • Version: 00000000_00

Tools

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

Input Parameters

string
required
Search phrase to check for spelling corrections (1-400 characters and at most 50 words).
string
Two-letter country code, or ALL, used to localize corrections.
string
Language code used as a hint for spelling analysis.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAVE_SEARCH_GENERATE_GROUNDED_ANSWERGenerate 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAVE_SEARCH_GET_LEGACY_SUMMARYFetch 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

string
required
Key returned by a Brave web search made with summary=true. The connected API key must have the discontinued, grandfathered Pro AI entitlement.
boolean
Include source references inline in the summary token stream.
boolean
Include entity information associated with a completed summary.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAVE_SEARCH_GET_LLM_CONTEXTRetrieve token-budgeted web snippets and source metadata for grounding or RAG using URL-friendly parameters.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAVE_SEARCH_GET_LLM_CONTEXT_POSTRetrieve token-budgeted web snippets and source metadata for grounding or RAG with a JSON body, suited to complex requests.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAVE_SEARCH_GET_LOCAL_DESCRIPTIONSFetch AI-generated Markdown descriptions for up to 20 ephemeral POI IDs returned recently by place or web search.

Input Parameters

array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAVE_SEARCH_GET_LOCAL_POISFetch 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

string ("imperial" | "metric")
Measurement system for distances and related values.
array
required
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.
string
Language and region code for response labels.
string
Language code for POI content.
number
Caller latitude for localized distance information; provide with location_longitude.
number
Caller longitude for localized distance information; provide with location_latitude.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAVE_SEARCH_GET_RICH_RESULTResolve 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

string
required
Fresh callback key returned by Search Web when enable_rich_callback is true and a rich match exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAVE_SEARCH_GET_SEARCH_SUGGESTIONSReturn typo-tolerant autocomplete suggestions for a partial query, optionally with rich entity metadata; requires the Autosuggest product.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAVE_SEARCH_SEARCH_IMAGESSearch Brave’s image index and return up to 200 image matches in one non-paginated response.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAVE_SEARCH_SEARCH_NEWS_GETSearch Brave’s news index with URL-friendly parameters and return one requested page of current news results.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAVE_SEARCH_SEARCH_NEWS_POSTSearch Brave’s news index with a JSON body, suited to long queries or complex Goggles, and return one requested result page.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAVE_SEARCH_SEARCH_PLACESSearch 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAVE_SEARCH_SEARCH_VIDEOS_GETSearch Brave’s video index with URL-friendly parameters and return one requested page of video results.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAVE_SEARCH_SEARCH_VIDEOS_POSTSearch Brave’s video index with a JSON body, suited to long requests, and return one requested result page.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAVE_SEARCH_SEARCH_WEB_GETSearch 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BRAVE_SEARCH_SEARCH_WEB_POSTSearch 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not