qstringrequired
Parameter defines the query you want to search.
Brave AI Mode
https://api.sandbase.ai/v1/api/brave/ai-modeGet the AI-generated answer Brave Search shows for a query, with answer text, cited sources and location and language options.
- Price
- $0.01USD / call
- Method
- POST
- Response
- JSON
- Parameters
- 1 required · 9 optional
Playground
Input
Parameter defines the query you want to search.
Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. It is recommended to specify `location` at the city level in order to simulate a real user’s search. If `location` is omitted, the search may take on the location of the proxy. Parameter can't be used with `lat` or `lon` parameters.
Parameter defines a GPS latitude for the search origin. Parameter is required when using `lon` parameter. Parameter can't be used with `location` parameter.
Parameter defines a GPS longitude for the search origin. Parameter is required when using `lat` parameter. Parameter can't be used with `location` parameter.
Parameter defines the country to use for the Brave AI search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Brave countries page for a full list of supported Brave AI Mode countries.
Parameter defines the language to use for the Brave AI search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Brave languages page for a full list of supported Brave AI Mode languages.
Parameter defines the level of filtering for adult content. It can be set to: `off` - Off `moderate` - Moderate `strict` - Strict
Parameter defines the units of measurement to use. It can be set to: `metric` - Metric `us` - Imperial (US)
Parameter defines the token used to continue a Brave AI Mode conversation. Pass this token to send a follow-up question that includes the prior exchange as context (multi-turn). The token is returned by the API from your previous request using our Brave AI Mode API. When using this token, include a new `q` for your follow-up prompt. For consistent behavior, reuse the same localization settings (`gl`, `hl`, and location) you used to obtain the token.
Parameter defines the fields you want to include in the output, reducing payload size for faster response. See the JSON Restrictor documentation for more details.
OutputReady
Your output will appear here
Complete the inputs, then click Run.
API README
Brave AI Mode
Get the AI-generated answer Brave Search shows for a query, with answer text, cited sources and location and language options.
Request
curl -X POST "https://api.sandbase.ai/v1/api/brave/ai-mode" \
-H "Authorization: Bearer $SANDBASE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"q": "How does a heat pump work?"}'
The result is returned in outputs[0].data as structured JSON.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
q | string | Yes | Parameter defines the query you want to search. |
location | string | No | Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. It is recommended to specif |
lat | string | No | Parameter defines a GPS latitude for the search origin. Parameter is required when using lon parameter. Parameter can't be used with location parameter. |
lon | string | No | Parameter defines a GPS longitude for the search origin. Parameter is required when using lat parameter. Parameter can't be used with location parameter. |
country | string | No | Parameter defines the country to use for the Brave AI search. It's a two-letter country code. (e.g., us for the United States, uk for United Kingdom, or fr for France). Head to the Brave countries page for a full list of supported Bra |
language | string | No | Parameter defines the language to use for the Brave AI search. It's a two-letter language code. (e.g., en for English, es for Spanish, or fr for French). Head to the Brave languages page for a full list of supported Brave AI Mode lang |
safeSearch | string | No | Parameter defines the level of filtering for adult content. It can be set to: off - Off moderate - Moderate strict - Strict |
units_of_measurement | string | No | Parameter defines the units of measurement to use. It can be set to: metric - Metric us - Imperial (US) |
subsequent_request_token | string | No | Parameter defines the token used to continue a Brave AI Mode conversation. Pass this token to send a follow-up question that includes the prior exchange as context (multi-turn). The token is returned by the API from your previous request us |
json_restrictor | string | No | Parameter defines the fields you want to include in the output, reducing payload size for faster response. See the JSON Restrictor documentation for more details. |
Pricing
$0.010 per successful call. Failed calls are not charged.
Start building
Send your first request
Platform API endpoint with unified authentication and usage tracking.
# The quoted heredoc keeps Unicode and shell metacharacters unchanged.
result=$(curl --fail-with-body --silent \
-X POST "https://api.sandbase.ai/v1/api/brave/ai-mode" \
-H "Authorization: Bearer $SANDBASE_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @- <<'SANDBASE_JSON'
{
"q": "How does a heat pump work?"
}
SANDBASE_JSON
)
printf '%s\n' "$result"2. Authentication
Set your SandBase API key in your server environment. Requests use Bearer authentication.
export SANDBASE_API_KEY="YOUR_API_KEY"Keep your key on the server. Do not expose it in browser code.
3. Parameters
locationstring
Parameter defines from where you want the search to originate. If several locations match the location requested, we'll pick the most popular one. Head to the /locations.json API if you need more precise control. It is recommended to specify `location` at the city level in order to simulate a real user’s search. If `location` is omitted, the search may take on the location of the proxy. Parameter can't be used with `lat` or `lon` parameters.
latstring
Parameter defines a GPS latitude for the search origin. Parameter is required when using `lon` parameter. Parameter can't be used with `location` parameter.
lonstring
Parameter defines a GPS longitude for the search origin. Parameter is required when using `lat` parameter. Parameter can't be used with `location` parameter.
countrystring
Parameter defines the country to use for the Brave AI search. It's a two-letter country code. (e.g., `us` for the United States, `uk` for United Kingdom, or `fr` for France). Head to the Brave countries page for a full list of supported Brave AI Mode countries.
languagestring
Parameter defines the language to use for the Brave AI search. It's a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to the Brave languages page for a full list of supported Brave AI Mode languages.
safeSearchstring
Parameter defines the level of filtering for adult content. It can be set to: `off` - Off `moderate` - Moderate `strict` - Strict
units_of_measurementstring
Parameter defines the units of measurement to use. It can be set to: `metric` - Metric `us` - Imperial (US)
subsequent_request_tokenstring
Parameter defines the token used to continue a Brave AI Mode conversation. Pass this token to send a follow-up question that includes the prior exchange as context (multi-turn). The token is returned by the API from your previous request using our Brave AI Mode API. When using this token, include a new `q` for your follow-up prompt. For consistent behavior, reuse the same localization settings (`gl`, `hl`, and location) you used to obtain the token.
json_restrictorstring
Parameter defines the fields you want to include in the output, reducing payload size for faster response. See the JSON Restrictor documentation for more details.
4. Response
Saved example response for this API; no live request is made when viewing it.
No saved response has been published. Run the API in Playground to inspect its response.
Explore more
Related APIs
| API | Price | Response |
|---|---|---|
Brave AI ModeThis API Brave | $0.01 per call | JSON |
Brave | $0.005 per call | JSON |
Brave | $0.005 per call | JSON |
Brave | $0.005 per call | JSON |
Brave | $0.005 per call | JSON |
Brave | $0.005 per call | JSON |
Questions
FAQ
How do I use the Brave AI Mode API?
Send a POST request to https://api.sandbase.ai/v1/api/brave/ai-mode 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 AI Mode API cost?
$0.01 per call, billed from your SandBase balance. You are only charged for calls you make; there is no subscription.
What parameters does the Brave AI Mode API accept?
Required: q (string). Optional: location (string), lat (string), lon (string), country (string), language (string) and safeSearch (string) and 3 more. The Parameters table and the Playground on this page list every field.
What does the Brave AI Mode API return?
A JSON response returned in the same HTTP request (synchronous).
Do I need a Brave developer account or API key?
No. Brave AI Mode 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.