Request Headers

Spell Check Search API Request Headers

This table lists the request headers supported by the Spellcheck 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 Spell Check Search API Version The Brave Spellcheck 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 spellcheck responses by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.

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:

Android
Mozilla/5.0 (Linux; Android 13; Pixel 7 Pro) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Mobile Safari/537.36
iOS
Mozilla/5.0 (iPhone; CPU IPhone OS 16_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/100.0.0.0 Mobile/15E148 Safari/604.1
macOS
Mozilla/5.0 (Macintosh; Intel Mac OS X 13_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36
Windows
Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36
X-Subscription-Token Yes Authentication token The secret token for the subscribed plan to authenticate the request. Can be obtained from API Keys.