Brave Search
API Key dataanalyticsBrave Search
What you can do
Section titled “What you can do”Connect this agent connector to let your agent:
- Descriptions local — Fetch AI-generated descriptions for locations using IDs from a Brave web search response
- Summary summarizer — Fetch the complete AI-generated summary for a summarizer key
- Search web, local place, image — Search the web using Brave Search’s privacy-focused search engine
- Completions chat — Get AI-generated answers grounded in real-time Brave Search results using an OpenAI-compatible chat completions interface
- Pois local — Fetch detailed Point of Interest (POI) data for up to 20 location IDs returned by a Brave web search response
- Enrichments summarizer — Fetch enrichment data for a Brave AI summary key
Authentication
Section titled “Authentication”This connector uses API Key authentication. Your users provide their Brave Search API key once, and Scalekit stores and manages it securely. Your agent code never handles keys directly — you only pass a connectionName and a user identifier.
Tool list
Section titled “Tool list” brave_chat_completions 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. 8 params
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.
messages array required Array of conversation messages. Each message must have a 'role' (system, user, or assistant) and 'content' (string). country string optional Target country code for search results used to ground the answer (e.g., us, gb). enable_citations boolean optional Include inline citation markers in the response text. enable_entities boolean optional Include entity information (people, places, organizations) in the response. enable_research boolean optional Enable multi-search research mode for more comprehensive answers. language string optional Language code for the response (e.g., en, fr, de). model string optional The model to use. Must be 'brave' to use Brave's search-grounded AI model. stream boolean optional Whether to stream the response as server-sent events. brave_image_search Search for images using Brave Search. Returns image results with thumbnails, source URLs, dimensions, and metadata. Supports filtering by country, language, and safe search. 6 params
Search for images using Brave Search. Returns image results with thumbnails, source URLs, dimensions, and metadata. Supports filtering by country, language, and safe search.
q string required The image search query string. count integer optional Number of image results to return (1–200). Defaults to 50. country string optional Country code for localised results (e.g., us, gb, de), or ALL for no restriction. safesearch string optional Safe search filter level. Defaults to strict (drops all adult content). search_lang string optional Language code for results (e.g., en, fr, de). spellcheck boolean optional Whether to enable spellcheck on the query. Defaults to true. brave_llm_context 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. 14 params
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.
q string required The search query to retrieve grounding context for. Max 400 characters, 50 words. context_threshold_mode string optional Relevance filter aggressiveness for snippet selection. Defaults to balanced. count integer optional Max number of search results to consider (1–50). Defaults to 20. country string optional Country code for localised results (e.g., us, gb, de). Defaults to us. enable_local boolean optional Enable location-aware recall for locally relevant results. freshness string optional Filter results by publish date: pd (past day), pw (past week), pm (past month), py (past year), or YYYY-MM-DDtoYYYY-MM-DD. goggles string optional Custom re-ranking rules via a Goggles URL or inline definition. maximum_number_of_snippets integer optional Maximum total snippets across all URLs (1–100). Defaults to 50. maximum_number_of_snippets_per_url integer optional Maximum snippets per URL (1–100). Defaults to 50. maximum_number_of_tokens integer optional Approximate maximum total tokens across all snippets (1024–32768). Defaults to 8192. maximum_number_of_tokens_per_url integer optional Maximum tokens per URL (512–8192). Defaults to 4096. maximum_number_of_urls integer optional Maximum number of URLs to include in the grounding response (1–50). Defaults to 20. safesearch string optional Safe search filter level. search_lang string optional Language code for results (e.g., en, fr, de). Defaults to en. brave_local_descriptions 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. 1 param
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.
ids array required Array of location IDs (up to 20) obtained from the locations field in a Brave web search response. brave_local_place_search 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. 11 params
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.
count integer optional Number of POI results to return (1–50). Defaults to 20. country string optional ISO 3166-1 alpha-2 country code (e.g., us, gb). Defaults to US. latitude number optional Latitude of the search center point (-90 to +90). Required together with longitude as an alternative to location name. location string optional Location name (e.g., 'san francisco ca united states'). Required unless latitude and longitude are both provided. longitude number optional Longitude of the search center point (-180 to +180). Required together with latitude as an alternative to location name. q string optional Optional keyword query to filter POIs (e.g., 'coffee shops', 'italian restaurants'). Omit for a general area snapshot. radius number optional Search radius in meters from the center point. safesearch string optional Safe search filter level. Defaults to strict. search_lang string optional Language code for results (e.g., en, fr). Defaults to en. spellcheck boolean optional Whether to enable spellcheck on the query. units string optional Measurement system for distances in the response. brave_local_pois 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. 1 param
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.
ids array required Array of location IDs (up to 20) obtained from the locations field in a Brave web search response. brave_news_search 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. 11 params
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.
q string required The news search query string. count integer optional Number of news results to return (1–50). Defaults to 20. country string optional Country code for localised news (e.g., us, gb, de). extra_snippets boolean optional Include additional excerpt snippets per article. Defaults to false. freshness string optional Filter results by publish date: pd (past day), pw (past week), pm (past month), py (past year), or YYYY-MM-DDtoYYYY-MM-DD. goggles string optional Custom re-ranking rules via a Goggles URL or inline definition. offset integer optional Zero-based offset for pagination (0–9). Defaults to 0. safesearch string optional Safe search filter level. Defaults to strict. search_lang string optional Language code for results (e.g., en, fr, de). spellcheck boolean optional Whether to enable spellcheck on the query. Defaults to true. ui_lang string optional User interface language locale for response strings (e.g., en-US). brave_spellcheck Check and correct spelling of a query using Brave Search's spellcheck engine. Returns suggested corrections for misspelled queries. 3 params
Check and correct spelling of a query using Brave Search's spellcheck engine. Returns suggested corrections for misspelled queries.
q string required The query string to spellcheck. country string optional Country code for localised spellcheck (e.g., us, gb). lang string optional Language code for spellcheck (e.g., en, fr, de). brave_suggest_search Get autocomplete search suggestions from Brave Search for a given query prefix. Useful for query completion, exploring related search terms, and building search UIs. 5 params
Get autocomplete search suggestions from Brave Search for a given query prefix. Useful for query completion, exploring related search terms, and building search UIs.
q string required The partial query string to get suggestions for. count integer optional Number of suggestions to return (1–20). Defaults to 5. country string optional Country code for localised suggestions (e.g., us, gb, de). lang string optional Language code for suggestions (e.g., en, fr, de). rich boolean optional Whether to return rich suggestions with additional metadata. brave_summarizer_enrichments Fetch enrichment data for a Brave AI summary key. Returns images, Q&A pairs, entity details, and source references associated with the summary. 1 param
Fetch enrichment data for a Brave AI summary key. Returns images, Q&A pairs, entity details, and source references associated with the summary.
key string required The opaque summarizer key returned in a Brave web search response when summary=true was set. brave_summarizer_entity_info 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. 1 param
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.
key string required The opaque summarizer key returned in a Brave web search response when summary=true was set. brave_summarizer_followups Fetch suggested follow-up queries for a Brave AI summary key. Useful for building conversational search flows and helping users explore related topics. 1 param
Fetch suggested follow-up queries for a Brave AI summary key. Useful for building conversational search flows and helping users explore related topics.
key string required The opaque summarizer key returned in a Brave web search response when summary=true was set. brave_summarizer_search 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. 3 params
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.
key string required The opaque summarizer key returned in a Brave web search response when summary=true was set. entity_info integer optional Set to 1 to include detailed entity metadata in the response. inline_references boolean optional Add citation markers throughout the summary text pointing to sources. brave_summarizer_summary Fetch the complete AI-generated summary for a summarizer key. Returns the full summary content with optional inline citation markers and entity metadata. 3 params
Fetch the complete AI-generated summary for a summarizer key. Returns the full summary content with optional inline citation markers and entity metadata.
key string required The opaque summarizer key returned in a Brave web search response when summary=true was set. entity_info integer optional Set to 1 to include detailed entity metadata in the response. inline_references boolean optional Add citation markers throughout the summary text pointing to sources. brave_summarizer_title Fetch only the title component of a Brave AI summary for a given summarizer key. 1 param
Fetch only the title component of a Brave AI summary for a given summarizer key.
key string required The opaque summarizer key returned in a Brave web search response when summary=true was set. brave_video_search 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. 8 params
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.
q string required The video search query string. count integer optional Number of video results to return (1–50). Defaults to 20. country string optional Country code for localised results (e.g., us, gb, de). freshness string optional Filter results by upload date: pd (past day), pw (past week), pm (past month), py (past year), or YYYY-MM-DDtoYYYY-MM-DD. offset integer optional Zero-based offset for pagination (0–9). Defaults to 0. safesearch string optional Safe search filter level. Defaults to moderate. search_lang string optional Language code for results (e.g., en, fr, de). spellcheck boolean optional Whether to enable spellcheck on the query. Defaults to true. brave_web_search 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. 15 params
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.
q string required Search query string. Max 400 characters, 50 words. count integer optional Number of search results to return (1–20). Defaults to 20. country string optional Country code for search results (e.g., us, gb, de). Defaults to US. extra_snippets boolean optional Include up to 5 additional excerpt snippets per result. Defaults to false. freshness string optional Filter 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. goggles string optional Custom re-ranking rules via a Goggles URL or inline definition to bias search results. offset integer optional Zero-based offset for pagination of results (0–9). Defaults to 0. result_filter string optional Comma-separated list of result types to include in the response. safesearch string optional Safe search filter level. Defaults to moderate. search_lang string optional Language code for result content (e.g., en, fr, de). Defaults to en. spellcheck boolean optional Whether to enable spellcheck on the query. Defaults to true. summary boolean optional Enable summarizer key generation in the response. Use the returned key with the Summarizer endpoints. text_decorations boolean optional Whether to include text decoration markers (bold tags) in result snippets. Defaults to true. ui_lang string optional User interface language locale for response strings (e.g., en-US, fr-FR). units string optional Measurement system for unit-bearing results.