Skip to main content
GET
/
v1
/
images
/
search
Error
A valid request URL is required to generate request examples
{
  "query": {
    "original": "<string>",
    "altered": "<string>",
    "spellcheck_off": true,
    "show_strict_warning": true
  },
  "results": [
    {
      "type": "image_result",
      "title": "<string>",
      "url": "<string>",
      "source": "<string>",
      "page_fetched": "<string>",
      "thumbnail": {
        "src": "<string>",
        "width": 123,
        "height": 123
      },
      "properties": {
        "url": "<string>",
        "placeholder": "<string>",
        "width": 123,
        "height": 123
      },
      "meta_url": {
        "scheme": "<string>",
        "netloc": "<string>",
        "hostname": "<string>",
        "favicon": "<string>",
        "path": "<string>"
      },
      "confidence": "low"
    }
  ],
  "extra": {
    "might_be_offensive": false
  },
  "type": "images"
}

Authorizations

​
x-subscription-token
string
header
required

The subscription token that was generated for the product.

Headers

​
x-subscription-token
string
required

The subscription token that was generated for the product.

Example:

"BSAgdIxiH0OLq6fnx6F-xp8Yplv4uOp"

​
api-version
string | null

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

​
accept
enum<string>
default:application/json

The default supported media type is application/json.

Available options:
application/json,
*/*
Example:

"application/json"

​
cache-control
enum<string> | null

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.

Available options:
no-cache
Allowed value: "no-cache"
​
user-agent
string | null

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.

Example:

"**Android** Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36"

Query Parameters

​
q
string
required

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

Required string length: 1 - 400
​
search_lang
enum<string>
default:en

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

Available options:
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,
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
​
country
enum<string>
default:US

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

Available options:
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
​
safesearch
enum<string>
default:strict

Filters search results for adult content. The following values are supported: off (No filtering is done), strict (Drops all adult content from search results). The default value is strict

Available options:
off,
strict
​
count
integer
default:50

The number of search results returned in response. The maximum is 200. The actual number delivered may be less than requested.

Required range: 1 <= x <= 200
​
spellcheck
boolean
default:true

Whether to spellcheck 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.

Response

Successful Response

​
query
Query · object
required

Image search query string.

​
results
ImageResult · object[]
required

The list of image results for the given query.

​
extra
Extra · object
required

Additional information about the image search results.

​
type
enum<string>
default:images
Available options:
images
Allowed value: "images"