Brave Search

other

Intelligent spell checking to improve query quality and help users find what they’re looking for.

Authorization

x-subscription-token string header required

The subscription token that was generated for the product.

Query Parameters

q string required

The phrase to be spell checked. Query can not be empty. Maximum of 400 characters and 50 words in the query.

lang enum<string>

The spell check language preference, where potentially the results could come from. The 2 or more character language code for which the spell check search results are provided. This is a just a hint for calculating spell check responses.

Default: "en"

Available options: areubn

country enum<string>

The spell check country, where potentially the results could come from. The country string is limited to 2 character country codes of supported countries. This is a just a hint for calculating spellcheck responses.

Default: "US"

Available options: ARAUAT

Headers

api-version string

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

accept enum<string>

The default supported media type is application/json.

Default: "application/json"

Available options: application/json*/*

cache-control "no-cache"

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.

user-agent string

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.

Responses

200 Successful Response

type "spellcheck"

query object required

Spellcheck search query string. Only the original query is returned.

results object[]

The list of spell-checked results for given query.

404 Not Found

type string

error object required

time integer

422 Unprocessable Entity

type string

error object required

time integer

429 Too Many Requests

type string

error object required

time integer

curl "https://api.search.brave.com/res/v1/spellcheck/search?q=artifial+inteligence" \
  -H "Accept: application/json" \ 
  -H "Accept-Encoding: gzip" \ 
  -H "X-Subscription-Token: <YOUR_API_KEY>"

import requests

url = "https://api.search.brave.com/res/v1/spellcheck/search"

params = {
    "q": "artifial inteligence"
}

headers = {
    "Accept": "application/json",
    "Accept-Encoding": "gzip",
    "X-Subscription-Token": "<YOUR_API_KEY>"
}

response = requests.get(url, params=params, headers=headers)
print(response.json())