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 Description
type "videos" The type of search API result. The value is always video.
query Query Video search query string.
results list [ VideoResult ] The list of video results for the given query.

# Query

A model representing information gathered around the requested query.

Field Type Description
original string The original query that was requested.
altered string The altered query by the spellchecker. This is the query that is used to search if any.
cleaned string The cleaned noramlized query by the spellchecker. This is the query that is used to search if any.
spellcheck_off bool Whether the spell checker is enabled or disabled.
show_strict_warning string 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 Description
type video_result The type of video search API result. The value is always video_result.
url string The source url of the video.
title string The title of the video.
description string The description for the video.
age string A human readable representation of the page age.
page_age string The page age found from the source web page.
page_fetched string The iso date time when the page was last fetched. The format is YYYY-MM-DDTHH:MM:SSZ
thumbnail Thumbnail The thumbnail for the video.
video VideoData Metadata for the video.
meta_url MetaUrl Aggregated information on the url associated with the video search result.

# Thumbnail

Aggregated details representing the video thumbnail

Field Type Description
src string The served url of the thumbnail associated with the video.
original string The original url of the thumbnail associated with the video.

# VideoData

A model representing metadata gathered for a video.

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

# Profile

A profile of an entity associated with the video.

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

# MetaUrl

Aggregated information about a url.

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