# Brave Web Search API

> Web Search from Brave. Returns the official Brave API response unchanged.

Source: https://www.sandbase.ai/apis/brave/web
API reference: https://www.sandbase.ai/apis/brave/web/docs

## Facts

- Provider: Brave
- Type: Data API
- Endpoint: `POST https://api.sandbase.ai/v1/api/brave/web`
- Price: $0.005 per call
- Free allowance: 100 calls per organization per UTC day, shared across eligible APIs
- Capabilities: api, brave, web search
- Billing: pay per use from one SandBase balance; no provider account or subscription needed

## Call it

`POST https://api.sandbase.ai/v1/api/brave/web` with `Authorization: Bearer $SANDBASE_API_KEY` and the parameters as a JSON body.

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `q` | string | yes |  |
| `count` | integer | no |  |
| `country` | string | no | AR, AU, AT, BE, BR, CA, CL, DK, FI, FR, DE, GR, HK, IN, ID, IT, JP, KR, MY, MX, NL, NZ, NO, CN, PL, PT, PH, RU, SA, ZA, ES, SE, CH, TW, TR, GB, US, ALL |
| `enable_rich_callback` | boolean | no |  |
| `extra_snippets` | boolean | no |  |
| `freshness` | string | no |  |
| `goggles` | string | no |  |
| `goggles_id` | string | no |  |
| `include_fetch_metadata` | boolean | no |  |
| `offset` | integer | no |  |
| `operators` | boolean | no |  |
| `result_filter` | array | no |  |
| `safesearch` | string | no | off, moderate, strict |
| `search_lang` | string | no | ar, eu, bn, bg, ca, zh-hans, zh-hant, hr, cs, da, nl, en, en-gb, et, fi, fr, gl, de, el, gu, he, hi, hu, is, it, ja, jp, kn, ko, lv, lt, ms, ml, mr, nb, pl, pt-br, pt-pt, pa, ro, ru, sr, sk, sl, es, sv, ta, te, th, tr, uk, vi |
| `spellcheck` | boolean | no |  |
| `summary` | boolean | no |  |
| `text_decorations` | boolean | no |  |
| `ui_lang` | string | no | es-AR, en-AU, de-AT, nl-BE, fr-BE, pt-BR, en-CA, fr-CA, es-CL, da-DK, fi-FI, fr-FR, de-DE, el-GR, zh-HK, en-IN, en-ID, it-IT, ja-JP, ko-KR, en-MY, es-MX, nl-NL, en-NZ, no-NO, zh-CN, pl-PL, en-PH, ru-RU, en-ZA, es-ES, sv-SE, fr-CH, de-CH, zh-TW, tr-TR, en-GB, en-US, es-US |
| `units` | string | no | imperial, metric |

## FAQ

### How do I use the Brave Web Search API?

Send a POST request to https://api.sandbase.ai/v1/api/brave/web with your SandBase API key in the Authorization header (Bearer) and the parameters as a JSON body. You can also try it in the Playground on this page without writing code.

### How much does the Brave Web Search API cost?

$0.005 per call. Every organization gets 100 free calls per UTC day, shared across eligible SandBase APIs including this one; after that each call is billed at this price from your SandBase balance. There is no subscription.

### What parameters does the Brave Web Search API accept?

Required: q (string). Optional: count (integer), country (one of AR, AU, AT, BE, BR, CA, CL, DK, FI, FR, DE, GR, HK, IN, ID, IT, JP, KR, MY, MX, NL, NZ, NO, CN, PL, PT, PH, RU, SA, ZA, ES, SE, CH, TW, TR, GB, US, ALL), enable_rich_callback (boolean), extra_snippets (boolean), freshness (string) and goggles (string) and 12 more. The Parameters table and the Playground on this page list every field.

### What does the Brave Web Search API return?

A JSON response returned in the same HTTP request (synchronous).

### Do I need a Brave developer account or API key?

No. Brave Web Search runs through SandBase, so one SandBase API key covers this endpoint and every other API and model in the catalog. You do not need to apply for Brave API access separately.

## README

### Brave Web Search API

Web Search from Brave. Returns the official Brave API response unchanged.

The response is the official Brave API response, unchanged.

#### Request

```bash
curl -X POST "https://api.sandbase.ai/v1/run" \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "brave/web", "q": "weather seattle", "enable_rich_callback": true}'
```

#### Parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `count` | integer | No | The number of search results returned in response. The maximum is 20. The actual number delivered may be less than requested. Combine this parameter with offset |
| `country` | string | No | The 2 character country code where the search results come from. |
| `enable_rich_callback` | boolean | No | Enable rich callback. Allows you to get real time rich results via a callback URL when they are relevant to your query. NOTE : Requires Search plan. |
| `extra_snippets` | boolean | No | 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. |
| `freshness` | string | No | 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 da |
| `goggles` | string | No | 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. |
| `goggles_id` | string | No | Goggles act as a custom re-ranking on top of Brave’s search index. For more details, refer to the Goggles repository. This parameter is deprecated. Please use t |
| `include_fetch_metadata` | boolean | No | Include fetch metadata. |
| `offset` | integer | No | The zero based offset that indicates number of search result pages (count) to skip before returning the result. The default is 0 and the maximum is 9. The actua |
| `operators` | boolean | No | Whether to apply search operators |
| `q` | string | Yes | The user’s search query term. Query can not be empty. Maximum of 600 characters and 75 words in the query. |
| `result_filter` | array | No | A comma delimited string of result types to include in the search response. Not specifying this parameter will return back all result types in search response w |
| `safesearch` | string | No | Filters search results for adult content. The following values are supported: off - No filtering is done. moderate - Filters explicit content, like images and v |
| `search_lang` | string | No | The 2 or more character language code for which the search results are provided. |
| `spellcheck` | boolean | No | Whether to spell check provided query. If the spell checker is enabled, the modified query is always used for search. The modified query can be found in altered |
| `summary` | boolean | No | This parameter enables summary key generation in web search results. This is required for summarizer to be enabled. |
| `text_decorations` | boolean | No | Whether display strings (e.g. result snippets) should include decoration markers (e.g. highlighting characters). |
| `ui_lang` | string | No | User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110 . |
| `units` | string | No | The measurement units. The following values are supported: metric - The standardized measurement system (km, celcius…) imperial - The British Imperial system of |

#### Pricing

Flat price per call. Failed calls are not charged.