Brave Search

Brave Image Search API

Response Objects

# ImageSearchApiResponse

Top level response model for successful Image Search API requests. The API can also respond back with an error response based on invalid subscription keys and rate limit events.

Field	Type	Required	Description
type	"images"	true	The type of search API result. The value is always `images`.
query	Query	true	Image search query string.
results	list [ ImageResult ]	true	The list of image results for the given query.
extra	Extra	true	Additional information about the image search results.

# Query

A model representing information gathered around the requested query.

Field	Type	Required	Description
original	string	true	The original query that was requested.
altered	string	false	The altered query by the spellchecker. This is the query that is used to search.
spellcheck_off	bool	false	Whether the spellchecker is enabled or disabled.
show_strict_warning	string	false	The value is `true` if the lack of results is due to a `strict` safesearch setting. Adult content relevant to the query was found, but was blocked by safesearch.

# ImageResult

A model representing an image result for the requested query.

Field	Type	Required	Description
type	image_result	true	The type of image search API result. The value is always `image_result`.
title	string	false	The title of the image.
url	string	false	The original page URL where the image was found.
source	string	false	The source domain where the image was found.
page_fetched	string	false	The ISO date time when the page was last fetched. The format is `YYYY-MM-DDTHH:MM:SSZ`.
thumbnail	Thumbnail	false	The thumbnail for the image.
properties	Properties	false	Metadata for the image.
meta_url	MetaUrl	false	Aggregated information on the URL associated with the image search result.
confidence	"low" \| "medium" \| "high"	false	The confidence level for the image result.

# Thumbnail

Aggregated details representing the image thumbnail.

Field	Type	Required	Description
src	string	false	The served URL of the image.
width	int	false	The width of the image.
height	int	false	The height of the image.

# Properties

Metadata on an image.

Field	Type	Required	Description
url	string	false	The image URL.
placeholder	string	false	The lower resolution placeholder image URL.
width	int	false	The width of the image.
height	int	false	The height of the image.

# MetaUrl

Aggregated information about a URL.

Field	Type	Required	Description
scheme	string	false	The protocol scheme extracted from the URL.
netloc	string	false	The network location part extracted from the URL.
hostname	string	false	The lowercased domain name extracted from the URL.
favicon	string	false	The favicon used for the URL.
path	string	false	The hierarchical path of the URL useful as a display string.

# Extra

Additional information about the image search results.

Field	Type	Required	Description
might_be_offensive	boolean	true	Indicates whether the image search results might contain offensive content.