Brave Search

Brave Summarizer Search API

Query Parameters

# Summarizer Search API

The following table lists the query parameters supported by the Summarizer Search API.

Parameter	Required	Type	Default	Description
key	true	string		The key is equal to value of field key as part of the Summarizer response model.
entity_info	false	bool	false	Returns extra entities info with the summary response.
inline_references	false	bool	false	Adds inline references to the summary response.

# Chat Completions API Request

Model of Chat Completions API (POST /res/v1/chat/completions) request JSON body. The request will include the question to be answered.

Note: The following parameters are ones supported by the Brave Summarizer Search API integration. When more parameters are supported they will be added to this document.

Field	Type	Required	Description
messages	list [ ChatCompletionsMessage ]	true	The messages to use for the chat completion. The value is a list of ChatCompletionsMessage response models.
model	string	false	The model to use for the chat completion. The value can be `brave-pro` (default) or `brave`.
stream	bool	false	Whether to stream the response. The value is `true` by default. When using the OpenAI CLI, use `openai.AsyncOpenAI` for streaming and `openai.OpenAI` for blocking mode.
country	string	false	The country backend to use for the chat completion. The value is `us` by default. Note: This parameter is passed in `extra_body` field when using the OpenAI CLI.
language	string	false	The language to use for the chat completion. The value is `en` by default. Note: This parameter is passed in `extra_body` field when using the OpenAI CLI.
enable_entities	bool	false	Whether to enable entities in the chat completion. The value is `false` by default. Note: This parameter is passed in `extra_body` field when using the OpenAI CLI.
enable_citations	bool	false	Whether to enable citations in the chat completion. The value is `false` by default. Note: This parameter is passed in `extra_body` field when using the OpenAI CLI.

# ChatCompletionsMessage

A message to use for the chat completion. Required to be length of 1 (single user message).

Field	Type	Required	Description
role	string	true	The role of the message. Only `user` is supported for now.
content	string	true	The content of the message. The value is the question to be answered.