Skip to main content
GET
/
v1
/
summarizer
/
search
Error
A valid request URL is required to generate request examples
{
  "type": "summarizer",
  "status": "failed",
  "results": [
    {
      "summary": "<string>",
      "type": "summarizer_result",
      "answer": {
        "text": "<string>",
        "location": {
          "start": 123,
          "end": 123
        }
      },
      "references": []
    }
  ],
  "title": "<string>",
  "summary": [
    {
      "type": "token",
      "data": {
        "uuid": "<string>",
        "name": "<string>",
        "url": "<string>",
        "text": "<string>",
        "images": [
          {
            "thumbnail": {
              "src": "<string>",
              "alt": "<string>",
              "height": 123,
              "width": 123,
              "bg_color": "<string>",
              "original": "<string>",
              "logo": true,
              "duplicated": true,
              "theme": "<string>"
            },
            "url": "<string>",
            "properties": {
              "url": "<string>",
              "resized": "<string>",
              "placeholder": "<string>",
              "content_size": "<string>",
              "height": 123,
              "width": 123,
              "format": "<string>"
            },
            "text": "<string>"
          }
        ],
        "highlight": [
          {
            "start": 123,
            "end": 123
          }
        ]
      }
    }
  ],
  "enrichments": {
    "raw": "<string>",
    "images": [
      {
        "thumbnail": {
          "src": "<string>",
          "alt": "<string>",
          "height": 123,
          "width": 123,
          "bg_color": "<string>",
          "original": "<string>",
          "logo": true,
          "duplicated": true,
          "theme": "<string>"
        },
        "url": "<string>",
        "properties": {
          "url": "<string>",
          "resized": "<string>",
          "placeholder": "<string>",
          "content_size": "<string>",
          "height": 123,
          "width": 123,
          "format": "<string>"
        },
        "text": "<string>"
      }
    ],
    "qa": [
      {
        "answer": "<string>",
        "score": 123,
        "highlight": {
          "start": 123,
          "end": 123
        }
      }
    ],
    "entities": [
      {
        "uuid": "<string>",
        "name": "<string>",
        "url": "<string>",
        "text": "<string>",
        "images": [
          {
            "thumbnail": {
              "src": "<string>",
              "alt": "<string>",
              "height": 123,
              "width": 123,
              "bg_color": "<string>",
              "original": "<string>",
              "logo": true,
              "duplicated": true,
              "theme": "<string>"
            },
            "url": "<string>",
            "properties": {
              "url": "<string>",
              "resized": "<string>",
              "placeholder": "<string>",
              "content_size": "<string>",
              "height": 123,
              "width": 123,
              "format": "<string>"
            },
            "text": "<string>"
          }
        ],
        "highlight": [
          {
            "start": 123,
            "end": 123
          }
        ]
      }
    ],
    "context": [
      {
        "title": "<string>",
        "url": "<string>",
        "meta_url": {
          "scheme": "<string>",
          "netloc": "<string>",
          "hostname": "<string>",
          "favicon": "<string>",
          "path": "<string>"
        }
      }
    ]
  },
  "followups": [
    "<string>"
  ],
  "entities_infos": {}
}

Authorizations

​
x-subscription-token
string
header
required

The subscription token that was generated for the product.

Headers

​
x-subscription-token
string
required

The subscription token that was generated for the product.

Example:

"BSAgdIxiH0OLq6fnx6F-xp8Yplv4uOp"

​
api-version
string | null

The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available.

​
accept
enum<string>
default:application/json

The default supported media type is application/json.

Available options:
application/json,
*/*
Example:

"application/json"

​
cache-control
enum<string> | null

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.

Available options:
no-cache
Allowed value: "no-cache"
​
user-agent
string | null

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.

Example:

"**Android** Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36"

Query Parameters

​
key
string
required

The key is equal to value of field key as part of the Summarizer response model.

​
entity_info
boolean
default:false

Returns extra entities info with the summary response.

​
inline_references
boolean
default:false

Adds inline references to the summary response.

Response

Successful Response

​
type
enum<string>
default:summarizer
Available options:
summarizer
Allowed value: "summarizer"
​
status
enum<string>
default:failed

The current status of summarizer for the given key. The value can be either failed or complete.

Available options:
complete,
failed
​
results
SummarizerResult · object[] | null

The list of search results used to generate the summary.

​
title
string | null

The title for the summary.

​
summary
SummaryMessage · object[] | null

Details for the summary message.

​
enrichments
SummaryEnrichments · object

Enrichments that can be added to the summary message.

​
followups
string[] | null

Followup queries relevant to the current query.

​
entities_infos
Entities Infos · object

Details on the entities in the summary message.