Authorizations
The subscription token that was generated for the product.
Headers
The subscription token that was generated for the product.
"BSAgdIxiH0OLq6fnx6F-xp8Yplv4uOp"
The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available.
The default supported media type is application/json.
application/json, */* Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.
| Title | Const |
|---|---|
| CacheControl | no-cache |
The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.
"**Android** Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36"
"**iOS** Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1"
"**macOS** Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36"
"**Windows** Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36"
Query Parameters
The key is equal to value of field key as part of the Summarizer response model.
Returns extra entities info with the summary response.
Adds inline references to the summary response.
Response
Successful Response
| Title | Const |
|---|---|
| Type | summarizer |
The current status of summarizer for the given key. The value can be either failed or complete.
complete, failed The list of search results used to generate the summary.
The title for the summary.
Details for the summary message.
Enrichments that can be added to the summary message.
Followup queries relevant to the current query.
Details on the entities in the summary message.