The subscription token that was generated for the product.

The user’s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.

The search language preference. The 2 or more character language code for which the search results are provided.

User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110.

The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries or ALL for worldwide.

Filters search results for adult content. The following values are supported:

• off - No filtering is done.
• moderate - Filter out explicit content.
• strict - Filter out explicit and suggestive content.

The number of search results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.

The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is 9. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with count. For example, if your user interface displays 20 search results per page, set count to 20 and offset to 0 to show the first page of results. To get subsequent pages, increment offset by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages.

Whether to spell check the provided query. If the spellchecker is enabled, the modified query is always used for search. The modified query can be found in altered key from the query response model.

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

• pd - Pages aged 24 hours or less.
• pw - Pages aged 7 days or less.
• pm - Pages aged 31 days or less.
• py - Pages aged 365 days or less.
• YYYY-MM-DDtoYYYY-MM-DD - A custom date range is also supported by specifying start and end dates e.g. 2022-04-01to2022-07-30.

A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts.

Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, refer to the Goggles repository. The parameter can be repeated to query with multiple goggles.

Include fetch metadata.

Whether to apply search operators.

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.

The default supported media type is application/json.

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.

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.