Skip to content
Talk to an Engineer Dashboard

Brave Search

Connect to Brave Search to perform web, image, video, and news searches with privacy-focused results, plus AI-powered suggestions and spellcheck.

Connect to Brave Search to perform web, image, video, and news searches with privacy-focused results, plus AI-powered suggestions and spellcheck.

Brave Search logo

Supports authentication: API Key

Get AI-generated answers grounded in real-time Brave Search results using an OpenAI-compatible chat completions interface. Returns summarized, cited answers with source references and token usage statistics.

NameTypeRequiredDescription
countrystringNoTarget country code for search results used to ground the answer (e.g., us, gb).
enable_citationsbooleanNoInclude inline citation markers in the response text.
enable_entitiesbooleanNoInclude entity information (people, places, organizations) in the response.
enable_researchbooleanNoEnable multi-search research mode for more comprehensive answers.
languagestringNoLanguage code for the response (e.g., en, fr, de).
messagesarray<object>YesArray of conversation messages. Each message must have a ‘role’ (system, user, or assistant) and ‘content’ (string).
modelstringNoThe model to use. Must be ‘brave’ to use Brave’s search-grounded AI model.
streambooleanNoWhether to stream the response as server-sent events.

Search for images using Brave Search. Returns image results with thumbnails, source URLs, dimensions, and metadata. Supports filtering by country, language, and safe search.

NameTypeRequiredDescription
countintegerNoNumber of image results to return (1–200). Defaults to 50.
countrystringNoCountry code for localised results (e.g., us, gb, de), or ALL for no restriction.
qstringYesThe image search query string.
safesearchstringNoSafe search filter level. Defaults to strict (drops all adult content).
search_langstringNoLanguage code for results (e.g., en, fr, de).
spellcheckbooleanNoWhether to enable spellcheck on the query. Defaults to true.

Retrieve real-time web search results optimized as grounding context for LLMs. Returns curated snippets, source URLs, titles, and metadata specifically structured to maximize contextual relevance for AI-generated answers. Supports fine-grained token and snippet budgets.

NameTypeRequiredDescription
context_threshold_modestringNoRelevance filter aggressiveness for snippet selection. Defaults to balanced.
countintegerNoMax number of search results to consider (1–50). Defaults to 20.
countrystringNoCountry code for localised results (e.g., us, gb, de). Defaults to us.
enable_localbooleanNoEnable location-aware recall for locally relevant results.
freshnessstringNoFilter results by publish date: pd (past day), pw (past week), pm (past month), py (past year), or YYYY-MM-DDtoYYYY-MM-DD.
gogglesstringNoCustom re-ranking rules via a Goggles URL or inline definition.
maximum_number_of_snippetsintegerNoMaximum total snippets across all URLs (1–100). Defaults to 50.
maximum_number_of_snippets_per_urlintegerNoMaximum snippets per URL (1–100). Defaults to 50.
maximum_number_of_tokensintegerNoApproximate maximum total tokens across all snippets (1024–32768). Defaults to 8192.
maximum_number_of_tokens_per_urlintegerNoMaximum tokens per URL (512–8192). Defaults to 4096.
maximum_number_of_urlsintegerNoMaximum number of URLs to include in the grounding response (1–50). Defaults to 20.
qstringYesThe search query to retrieve grounding context for. Max 400 characters, 50 words.
safesearchstringNoSafe search filter level.
search_langstringNoLanguage code for results (e.g., en, fr, de). Defaults to en.

Fetch AI-generated descriptions for locations using IDs from a Brave web search response. Returns natural language summaries describing the place, its atmosphere, and what visitors can expect.

NameTypeRequiredDescription
idsarray<string>YesArray of location IDs (up to 20) obtained from the locations field in a Brave web search response.

Search 200M+ Points of Interest (POIs) by geographic center and radius using Brave’s Place Search API. Either ‘location’ (text name) OR both ‘latitude’ and ‘longitude’ (coordinates) must be provided. Supports an optional keyword query to filter results. Ideal for map applications and local discovery.

NameTypeRequiredDescription
countintegerNoNumber of POI results to return (1–50). Defaults to 20.
countrystringNoISO 3166-1 alpha-2 country code (e.g., us, gb). Defaults to US.
latitudenumberNoLatitude of the search center point (-90 to +90). Required together with longitude as an alternative to location name.
locationstringNoLocation name (e.g., ‘san francisco ca united states’). Required unless latitude and longitude are both provided.
longitudenumberNoLongitude of the search center point (-180 to +180). Required together with latitude as an alternative to location name.
qstringNoOptional keyword query to filter POIs (e.g., ‘coffee shops’, ‘italian restaurants’). Omit for a general area snapshot.
radiusnumberNoSearch radius in meters from the center point.
safesearchstringNoSafe search filter level. Defaults to strict.
search_langstringNoLanguage code for results (e.g., en, fr). Defaults to en.
spellcheckbooleanNoWhether to enable spellcheck on the query.
unitsstringNoMeasurement system for distances in the response.

Fetch detailed Point of Interest (POI) data for up to 20 location IDs returned by a Brave web search response. Returns rich local business data including address, phone, hours, ratings, and reviews. Note: location IDs are ephemeral and expire after ~8 hours.

NameTypeRequiredDescription
idsarray<string>YesArray of location IDs (up to 20) obtained from the locations field in a Brave web search response.

Search for news articles using Brave Search. Returns recent news results with titles, URLs, snippets, publication dates, and source information. Supports filtering by country, language, freshness, and custom re-ranking via Goggles.

NameTypeRequiredDescription
countintegerNoNumber of news results to return (1–50). Defaults to 20.
countrystringNoCountry code for localised news (e.g., us, gb, de).
extra_snippetsbooleanNoInclude additional excerpt snippets per article. Defaults to false.
freshnessstringNoFilter results by publish date: pd (past day), pw (past week), pm (past month), py (past year), or YYYY-MM-DDtoYYYY-MM-DD.
gogglesstringNoCustom re-ranking rules via a Goggles URL or inline definition.
offsetintegerNoZero-based offset for pagination (0–9). Defaults to 0.
qstringYesThe news search query string.
safesearchstringNoSafe search filter level. Defaults to strict.
search_langstringNoLanguage code for results (e.g., en, fr, de).
spellcheckbooleanNoWhether to enable spellcheck on the query. Defaults to true.
ui_langstringNoUser interface language locale for response strings (e.g., en-US).

Check and correct spelling of a query using Brave Search’s spellcheck engine. Returns suggested corrections for misspelled queries.

NameTypeRequiredDescription
countrystringNoCountry code for localised spellcheck (e.g., us, gb).
langstringNoLanguage code for spellcheck (e.g., en, fr, de).
qstringYesThe query string to spellcheck.

Get autocomplete search suggestions from Brave Search for a given query prefix. Useful for query completion, exploring related search terms, and building search UIs.

NameTypeRequiredDescription
countintegerNoNumber of suggestions to return (1–20). Defaults to 5.
countrystringNoCountry code for localised suggestions (e.g., us, gb, de).
langstringNoLanguage code for suggestions (e.g., en, fr, de).
qstringYesThe partial query string to get suggestions for.
richbooleanNoWhether to return rich suggestions with additional metadata.

Fetch enrichment data for a Brave AI summary key. Returns images, Q&A pairs, entity details, and source references associated with the summary.

NameTypeRequiredDescription
keystringYesThe opaque summarizer key returned in a Brave web search response when summary=true was set.

Fetch detailed entity metadata for entities mentioned in a Brave AI summary. Returns structured information about people, places, organizations, and concepts referenced in the summary.

NameTypeRequiredDescription
keystringYesThe opaque summarizer key returned in a Brave web search response when summary=true was set.

Fetch suggested follow-up queries for a Brave AI summary key. Useful for building conversational search flows and helping users explore related topics.

NameTypeRequiredDescription
keystringYesThe opaque summarizer key returned in a Brave web search response when summary=true was set.

Retrieve a full AI-generated summary for a summarizer key obtained from a Brave web search response (requires summary=true on the web search). Returns the complete summary with title, content, enrichments, follow-up queries, and entity details.

NameTypeRequiredDescription
entity_infointegerNoSet to 1 to include detailed entity metadata in the response.
inline_referencesbooleanNoAdd citation markers throughout the summary text pointing to sources.
keystringYesThe opaque summarizer key returned in a Brave web search response when summary=true was set.

Fetch the complete AI-generated summary for a summarizer key. Returns the full summary content with optional inline citation markers and entity metadata.

NameTypeRequiredDescription
entity_infointegerNoSet to 1 to include detailed entity metadata in the response.
inline_referencesbooleanNoAdd citation markers throughout the summary text pointing to sources.
keystringYesThe opaque summarizer key returned in a Brave web search response when summary=true was set.

Fetch only the title component of a Brave AI summary for a given summarizer key.

NameTypeRequiredDescription
keystringYesThe opaque summarizer key returned in a Brave web search response when summary=true was set.

Search for videos using Brave Search. Returns video results with titles, URLs, thumbnails, durations, and publisher metadata. Supports filtering by country, language, freshness, and safe search.

NameTypeRequiredDescription
countintegerNoNumber of video results to return (1–50). Defaults to 20.
countrystringNoCountry code for localised results (e.g., us, gb, de).
freshnessstringNoFilter results by upload date: pd (past day), pw (past week), pm (past month), py (past year), or YYYY-MM-DDtoYYYY-MM-DD.
offsetintegerNoZero-based offset for pagination (0–9). Defaults to 0.
qstringYesThe video search query string.
safesearchstringNoSafe search filter level. Defaults to moderate.
search_langstringNoLanguage code for results (e.g., en, fr, de).
spellcheckbooleanNoWhether to enable spellcheck on the query. Defaults to true.

Search the web using Brave Search’s privacy-focused search engine. Returns real-time web results including titles, URLs, snippets, news, videos, images, locations, and rich data. Supports filtering by country, language, safe search, freshness, and custom re-ranking via Goggles.

NameTypeRequiredDescription
countintegerNoNumber of search results to return (1–20). Defaults to 20.
countrystringNoCountry code for search results (e.g., us, gb, de). Defaults to US.
extra_snippetsbooleanNoInclude up to 5 additional excerpt snippets per result. Defaults to false.
freshnessstringNoFilter results by publish date. Use pd (past day), pw (past week), pm (past month), py (past year), or a date range YYYY-MM-DDtoYYYY-MM-DD.
gogglesstringNoCustom re-ranking rules via a Goggles URL or inline definition to bias search results.
offsetintegerNoZero-based offset for pagination of results (0–9). Defaults to 0.
qstringYesSearch query string. Max 400 characters, 50 words.
result_filterstringNoComma-separated list of result types to include in the response.
safesearchstringNoSafe search filter level. Defaults to moderate.
search_langstringNoLanguage code for result content (e.g., en, fr, de). Defaults to en.
spellcheckbooleanNoWhether to enable spellcheck on the query. Defaults to true.
summarybooleanNoEnable summarizer key generation in the response. Use the returned key with the Summarizer endpoints.
text_decorationsbooleanNoWhether to include text decoration markers (bold tags) in result snippets. Defaults to true.
ui_langstringNoUser interface language locale for response strings (e.g., en-US, fr-FR).
unitsstringNoMeasurement system for unit-bearing results.