Rich results

GET /v1/web/rich

Error

A valid request URL is required to generate request examples

200

Example

{
  "type": "rich",
  "results": [],
  "response_callback_info": {
    "callback_key": "<string>",
    "callback_status": "success",
    "vertical": "calculator",
    "search_lang": "en"
  }
}

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

callback_key · string · required

The callback key to use for the rich header

Response

200

application/json

Successful Response

type · enum<string> · default: rich

The type of rich search API result. The value is always rich.

Available options: rich

Allowed value: "rich"

results · RichResult · object[]

The detailed information for the vertical matching the query intent.

Show child attributes

response_callback_info · ResponseCallbackInfo · object | null

The response callback info.

Show child attributes