Request Headers
Suggest Search API Request Headers
This table lists the request headers supported by the Suggest Search API, most of which are optional.
Header | Required | Name | Description |
---|---|---|---|
Accept | No | Accept | The default supported media type is application/json . |
Accept-Encoding | No | Accept-Encoding | The supported compression type is gzip . |
Api-Version | No | Suggest Search API Version | The Brave Suggest Search API version to use. This is denoted in the format YYYY-MM-DD. The latest version is used by default, and the previous ones can be found in the API Changelog. |
Cache-Control | No | Cache Control | Search will return cached suggestions by default. To prevent caching set the
Cache-Control header to |
User-Agent | No | User Agent | The user agent of the client sending the request. Search can utilize the user agent to provide a different experience depending on the client sending the request. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110. User agent string examples by platform:
|
X-Subscription-Token | Yes | Authentication token | The secret token for the subscribed plan to authenticate the request. Can be obtained from API Keys. |