Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Brave Search

API Key dataanalytics

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

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.

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.

Name Type Required Description
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_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.

Name Type Required Description
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.

Name Type Required Description
ids array required Array of location IDs (up to 20) obtained from the locations field in a Brave web search 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.

Name Type Required Description
ids array required Array of location IDs (up to 20) obtained from the locations field in a Brave web search response.
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.

Name Type Required Description
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_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.

Name Type Required Description
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.

Name Type Required Description
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.

Name Type Required Description
key string required The opaque summarizer key returned in a Brave web search response when summary=true was set.
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.

Name Type Required Description
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.

Name Type Required Description
key string required The opaque summarizer key returned in a Brave web search response when summary=true was set.