Brave Search

Brave Video Search API

Response Objects

# VideoSearchApiResponse

Top level response model for successful Video 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	"videos"	true	The type of search API result. The value is always `video`.
query	Query	true	Video search query string.
results	list [ VideoResult ]	true	The list of video results for the given query.
extra	Extra	true	Additional information about the video 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 if any.
cleaned	string	false	The cleaned noramlized query by the spellchecker. This is the query that is used to search if any.
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.

# VideoResult

A model representing a video result for the requested query.

Field	Type	Required	Description
type	video_result	true	The type of video search API result. The value is always `video_result`.
url	string	true	The source URL of the video.
title	string	true	The title of the video.
description	string	false	The description for the video.
age	string	false	A human readable representation of the page age.
page_age	string	false	The page age found from the source web page.
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 video.
video	VideoData	false	Metadata for the video.
meta_url	MetaUrl	false	Aggregated information on the URL associated with the video search result.

# Thumbnail

Aggregated details representing the video thumbnail.

Field	Type	Required	Description
src	string	true	The served URL of the thumbnail associated with the video.
original	string	false	The original URL of the thumbnail associated with the video.

# VideoData

A model representing metadata gathered for a video.

Field	Type	Required	Description
duration	string	false	A time string representing the duration of the video.
views	int	false	The number of views of the video.
creator	string	false	The creator of the video.
publisher	string	false	The publisher of the video.
requires_subscription	bool	false	Whether the video requires a subscription.
tags	list [ string ]	false	A list of tags relevant to the video.
author	Profile	false	A list of profiles associated with the video.

# Profile

A profile of an entity associated with the video.

Field	Type	Required	Description
name	string	true	The name of the profile.
long_name	string	false	The long name of the profile.
url	string	true	The original URL where the profile is available.
img	string	false	The served image URL representing the profile.

# 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 video search results.

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