← Tools Reference

Brave Search

Brave Search integration (Data). Imported from open-connector.

API key4 toolshttps://api.search.brave.com
GET
brave_search_web_search
Search the Brave Search web index and return the selected result families.

/res/v1/web/search

16 parameters
ParamTypeRequiredDescription
qstringrequiredThe user's search query term. Maximum of 400 characters.
search_langstringoptionalThe preferred search result language code.
ui_langstringoptionalThe preferred user interface language for response formatting.
countrystringoptionalThe two-letter country code for result localization, or ALL for worldwide resul…
safesearchstringoptionalFilters adult content from web results.
countintegeroptionalThe maximum number of web results to return.
offsetintegeroptionalThe zero-based results page offset used for pagination.
spellcheckbooleanoptionalWhether Brave Search should spellcheck the query before searching.
freshnessstringoptionalFilters web results by page age.
result_filterstringoptionalA comma-delimited list of result types to include, such as web,news,videos,loca…
extra_snippetsbooleanoptionalWhether Brave Search should return extra alternate snippets.
gogglesstringoptionalOne or more Brave Search goggles used to rerank results.
text_decorationsbooleanoptionalWhether display strings should include decoration markers such as highlights.
unitsstringoptionalThe measurement units used for localized results.
operatorsbooleanoptionalWhether Brave Search should apply search operators.
include_fetch_metadatabooleanoptionalWhether Brave Search should include fetch metadata in results when available.
GET
brave_search_news_search
Search Brave's news index for recent articles related to a query.

/res/v1/news/search

13 parameters
ParamTypeRequiredDescription
qstringrequiredThe user's search query term. Maximum of 400 characters.
search_langstringoptionalThe preferred search result language code.
ui_langstringoptionalThe preferred user interface language for response formatting.
countrystringoptionalThe two-letter country code for result localization, or ALL for worldwide resul…
safesearchstringoptionalFilters adult content from news results.
countintegeroptionalThe maximum number of results to return.
offsetintegeroptionalThe zero-based results page offset used for pagination.
spellcheckbooleanoptionalWhether Brave Search should spellcheck the query before searching.
freshnessstringoptionalFilters news results by page age.
extra_snippetsbooleanoptionalWhether Brave Search should return extra alternate snippets.
gogglesstringoptionalOne or more Brave Search goggles used to rerank results.
operatorsbooleanoptionalWhether Brave Search should apply search operators.
include_fetch_metadatabooleanoptionalWhether Brave Search should include fetch metadata in results when available.
GET
brave_search_video_search
Search Brave's video index for videos related to a query.

/res/v1/videos/search

11 parameters
ParamTypeRequiredDescription
qstringrequiredThe user's search query term. Maximum of 400 characters.
search_langstringoptionalThe preferred search result language code.
ui_langstringoptionalThe preferred user interface language for response formatting.
countrystringoptionalThe two-letter country code for result localization, or ALL for worldwide resul…
safesearchstringoptionalFilters adult content from video results.
countintegeroptionalThe maximum number of results to return.
offsetintegeroptionalThe zero-based results page offset used for pagination.
spellcheckbooleanoptionalWhether Brave Search should spellcheck the query before searching.
freshnessstringoptionalFilters video results by page age.
operatorsbooleanoptionalWhether Brave Search should apply search operators.
include_fetch_metadatabooleanoptionalWhether Brave Search should include fetch metadata in results when available.
GET
brave_search_image_search
Search Brave's image index for images related to a query.

/res/v1/images/search

6 parameters
ParamTypeRequiredDescription
qstringrequiredThe user's search query term. Maximum of 400 characters.
search_langstringoptionalThe preferred search result language code.
countrystringoptionalThe two-letter country code for result localization, or ALL for worldwide resul…
safesearchstringoptionalFilters adult content from image results.
countintegeroptionalThe maximum number of image results to return.
spellcheckbooleanoptionalWhether Brave Search should spellcheck the query before searching.