Brave Search

Brave Web Search API

Response Objects

# WebSearchApiResponse

Top level response model for successful Web Search API requests. The response will include the relevant keys based on the plan subscribed, query relevance or applied result_filter as a query parameter. The API can also respond back with an error response based on invalid subscription keys and rate limit events.

Field	Type	Required	Description
type	"search"	true	The type of web search API result. The value is always search.
discussions	Discussions	false	Discussions clusters aggregated from forum posts that are relevant to the query.
faq	FAQ	false	Frequently asked questions that are relevant to the search query.
infobox	GraphInfobox	false	Aggregated information on an entity showable as an infobox.
locations	Locations	false	Places of interest (POIs) relevant to location sensitive queries.
mixed	MixedResponse	false	Preferred ranked order of search results.
news	News	false	News results relevant to the query.
query	Query	false	Search query string and its modifications that are used for search.
videos	Videos	false	Videos relevant to the query.
web	Search	false	Web search results relevant to the query.
summarizer	Summarizer	false	Summary key to get summary results for the query.

# LocalPoiSearchApiResponse

Top level response model for successful Local Search API request to get extra information for locations. The response will include a list of location results corresponding to the ids in the request. The API can also respond back with an error response in cases like too many ids being requested, invalid subscription keys, and rate limit events. Access to Local Search API requires a subscription to a Pro plan.

Field	Type	Required	Description
type	"local_pois"	true	The type of local POI search API result. The value is always local_pois.
results	list [ LocationResult ]	false	Location results matching the ids in the request.

# LocalDescriptionsSearchApiResponse

Top level response model for successful Local Search API request to get AI generated description for locations. The response includes a list of generated descriptions corresponding to the ids in the request. The API can also respond back with an error response in cases like too many ids being requested, invalid subscription keys, and rate limit events. Access to Local Search API requires a subscription to a Pro plan.

Field	Type	Required	Description
type	"local_descriptions"	true	The type of local description search API result. The value is always local_descriptions.
results	list [ LocationDescription ]	false	Location descriptions matching the ids in the request.

# Query

A model representing information gathered around the requested query.

Field	Type	Required	Description
original	string	true	The original query that was requested.
show_strict_warning	bool	false	Whether there is more content available for query, but the response was restricted due to safesearch.
altered	string	false	The altered query for which the search was performed.
safesearch	bool	false	Whether safesearch was enabled.
is_navigational	bool	false	Whether the query is a navigational query to a domain.
is_geolocal	bool	false	Whether the query has location relevance.
local_decision	string	false	Whether the query was decided to be location sensitive.
local_locations_idx	int	false	The index of the location.
is_trending	bool	false	Whether the query is trending.
is_news_breaking	bool	false	Whether the query has news breaking articles relevant to it.
ask_for_location	bool	false	Whether the query requires location information for better results.
language	Language	false	The language information gathered from the query.
spellcheck_off	bool	false	Whether the spellchecker was off.
country	string	false	The country that was used.
bad_results	bool	false	Whether there are bad results for the query.
should_fallback	bool	false	Whether the query should use a fallback.
lat	string	false	The gathered location latitutde associated with the query.
long	string	false	The gathered location longitude associated with the query.
postal_code	string	false	The gathered postal code associated with the query.
city	string	false	The gathered city associated with the query.
state	string	false	The gathered state associated with the query.
header_country	string	false	The country for the request origination.
more_results_available	bool	false	Whether more results are available for the given query.
custom_location_label	string	false	Any custom location labels attached to the query.
reddit_cluster	string	false	Any reddit cluster associated with the query.

# Discussions

A model representing a discussion cluster relevant to the query.

Field	Type	Required	Description
type	"search"	true	The type identifying a discussion cluster. Currently the value is always search.
results	list [ DiscussionResult ]	true	A list of discussion results.
mutated_by_goggles	bool	true	Whether the discussion results are changed by a Goggle. False by default.

# DiscussionResult (SearchResult)

A discussion result. These are forum posts and discussions that are relevant to the search query.

Field	Type	Required	Description
type	"discussion"	true	The discussion result type identifier. The value is always discussion.
data	ForumData	false	The enriched aggregated data for the relevant forum post.

# ForumData

Defines a result from a discussion forum.

Field	Type	Required	Description
forum_name	string	true	The name of the forum.
num_answers	int	false	The number of answers to the post.
score	string	false	The score of the post on the forum.
title	string	false	The title of the post on the forum.
question	string	false	The question asked in the forum post.
top_comment	string	false	The top-rated comment under the forum post.

# FAQ

Frequently asked questions relevant to the search query term.

Field	Type	Required	Description
type	"faq"	true	The FAQ result type identifier. The value is always faq.
results	list [ QA ]	true	A list of aggregated question answer results relevant to the query.

# QA

A question answer result.

Field	Type	Required	Description
question	string	true	The question being asked.
answer	string	true	The answer to the question.
title	string	true	The title of the post.
url	string	true	The url pointing to the post.
meta_url	MetaUrl	false	Aggregated information about the url.

# MetaUrl

Aggregated information about a url.

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

# Search

A model representing a collection of web search results.

Field	Type	Required	Description
type	"search"	true	A type identifying web search results. The value is always search.
results	list [ SearchResult ]	true	A list of search results.
family_friendly	bool	true	Whether the results are family friendly.

# SearchResult (Result)

Aggregated information on a web search result, relevant to the query.

Field	Type	Required	Description
type	"search_result"	true	A type identifying a web search result. The value is always search_result.
subtype	"generic"	true	A sub type identifying the web search result type.
is_live	bool	true	Whether the web search result is currently live. Default value is False.
deep_results	DeepResult	false	Gathered information on a web search result.
schemas	list [ list ]	false	A list of schemas (structured data) extracted from the page. The schemas try to follow schema.org and will return anything we can extract from the HTML that can fit into these models.
meta_url	MetaUrl	false	Aggregated information on the url associated with the web search result.
thumbnail	Thumbnail	false	The thumbnail of the web search result.
age	string	false	A string representing the age of the web search result.
language	string	true	The main language on the web search result.
location	LocationResult	false	The location details if the query relates to a restaurant.
video	VideoData	false	The video associated with the web search result.
movie	MovieData	false	The movie associated with the web search result.
faq	FAQ	false	Any frequently asked questions associated with the web search result.
qa	QAPage	false	Any question answer information associated with the web search result page.
book	Book	false	Any book information associated with the web search result page.
rating	Rating	false	Rating found for the web search result page.
article	Article	false	An article found for the web search result page.
product	Product Review	false	The main product and a review that is found on the web search result page.
product_cluster	list [ Product Review ]	false	A list of products and reviews that are found on the web search result page.
cluster_type	string	false	A type representing a cluster. The value can be product_cluster.
cluster	list [ Result ]	false	A list of web search results.
creative_work	CreativeWork	false	Aggregated information on the creative work found on the web search result.
music_recording	MusicRecording	false	Aggregated information on music recording found on the web search result.
review	Review	false	Aggregated information on the review found on the web search result.
software	Software	false	Aggregated information on a software product found on the web search result page.
recipe	Recipe	false	Aggregated information on a recipe found on the web search result page.
organization	Organization	false	Aggregated information on a organization found on the web search result page.
content_type	string	false	The content type associated with the search result page.
extra_snippets	list [ string ]	false	A list of extra alternate snippets for the web search result.

# Result

A model representing a web search result.

Field	Type	Required	Description
title	string	true	The title of the web page.
url	string	true	The url where the page is served.
is_source_local	bool	true
is_source_both	bool	true
description	string	false	A description for the web page.
page_age	string	false	A date representing the age of the web page.
page_fetched	string	false	A date representing when the web page was last fetched.
profile	Profile	false	A profile associated with the web page.
language	string	false	A language classification for the web page.
family_friendly	bool	true	Whether the web page is family friendly.

# AbstractGraphInfobox (Result)

Shared aggregated information on an entity from a knowledge graph.

Field	Type	Required	Description
type	"infobox"	true	The infobox result type identifier. The value is always infobox.
position	int	true	The position on a search result page.
label	string	false	Any label associated with the entity.
category	string	false	Category classification for the entity.
long_desc	string	false	A longer description for the entity.
thumbnail	Thumbnail	false	The thumbnail associated with the entity.
attributes	list [ list [ string ] ]	false	A list of attributes about the entity.
profiles	list [ Profile ] \| list [ DataProvider ]	false	The profiles associated with the entity.
website_url	string	false	The official website pertaining to the entity.
ratings	list [ Rating ]	false	Any ratings given to the entity.
providers	list [ DataProvider ]	false	A list of data sources for the entity.
distance	Unit	false	A unit representing quantity relevant to the entity.
images	list [ Thumbnail ]	false	A list of images relevant to the entity.
movie	MovieData	false	Any movie data relevant to the entity. Appears only when the result is a movie.

# GenericInfobox (AbstractGraphInfobox)

Aggregated information on a generic entity from a knowledge graph.

Field	Type	Required	Description
subtype	"generic"	true	The infobox subtype identifier. The value is always generic.
found_in_urls	list [ string ]	false	List of urls where the entity was found.

# EntityInfobox (AbstractGraphInfobox)

Aggregated information on an entity from a knowledge graph.

Field	Type	Required	Description
subtype	"entity"	true	The infobox subtype identifier. The value is always entity.

# QAInfobox (AbstractGraphInfobox)

A question answer infobox.

Field	Type	Required	Description
subtype	"code"	true	The infobox subtype identifier. The value is always code.
data	QAPage	true	The question and relevant answer.
meta_url	MetaUrl	false	Detailed information on the page containing the question and relevant answer.

# InfoboxWithLocation (AbstractGraphInfobox)

An infobox with location.

Field	Type	Required	Description
subtype	"location"	true	The infobox subtype identifier. The value is always location.
is_location	bool	true	Whether the entity a location.
coordinates	list [ float ]	false	The coordinates of the location.
zoom_level	int	true	The map zoom level.
location	LocationResult	false	The location result.

# InfoboxPlace (AbstractGraphInfobox)

An infobox for a place, such as a business.

Field	Type	Required	Description
subtype	"place"	true	The infobox subtype identifier. The value is always place.
location	LocationResult	true	The location result.

# GraphInfobox

Aggregated information on an entity shown as an infobox.

Field	Type	Required	Description
type	"graph"	true	The type identifier for infoboxes. The value is always graph.
results	GenericInfobox QAInfobox InfoboxPlace InfoboxWithLocation EntityInfobox	true	A list of infoboxes associated with the query.

# QAPage

Aggreated result from a question answer page.

Field	Type	Required	Description
question	string	true	The question that is being asked.
answer	Answer	true	An answer to the question.

# Answer

A response representing an answer to a question on a forum.

Field	Type	Required	Description
text	string	true	The main content of the answer.
author	string	false	The name of the author of the answer.
upvoteCount	int	false	Number of upvotes on the answer.
downvoteCount	int	false	The number of downvotes on the answer.

# Thumbnail

Aggregated details representing a picture thumbnail.

Field	Type	Required	Description
src	string	true	The served url of the picture thumbnail.
original	string	false	The original url of the image.

# LocationWebResult (Result)

A model representing a web result related to a location.

Field	Type	Required	Description
meta_url	MetaUrl	true	Aggregated information about the url.

# LocationResult (Result)

A result that is location relevant.

Field	Type	Required	Description
type	"location_result"	true	Location result type identifier. The value is always location_result.
id	string	false	A Temporary id associated with this result, which can be used to retrieve extra information about the location. It remains valid for 8 hours…
provider_url	string	true	The complete url of the provider.
coordinates	list [ float ]	false	A list of coordinates associated with the location. This is a lat long represented as a floating point.
zoom_level	int	true	The zoom level on the map.
thumbnail	Thumbnail	false	The thumbnail associated with the location.
postal_address	PostalAddress	false	The postal address associated with the location.
opening_hours	OpeningHours	false	The opening hours, if it is a business, associated with the location .
contact	Contact	false	The contact of the business associated with the location.
price_range	string	false	A display string used to show the price classification for the business.
rating	Rating	false	The ratings of the business.
distance	Unit	false	The distance of the location from the client.
profiles	list [ DataProvider ]	false	Profiles associated with the business.
reviews	Reviews	false	Aggregated reviews from various sources relevant to the business.
pictures	PictureResults	false	A bunch of pictures associated with the business.
action	Action	false	An action to be taken.
serves_cuisine	list [ string ]	false	A list of cuisine categories served.
categories	list [ string ]	false	A list of categories.
icon_category	string	false	An icon category.
results	LocationWebResult	false	Web results related to this location.
timezone	string	false	IANA timezone identifier.
timezone_offset	string	false	The utc offset of the timezone.

# LocationDescription

AI generated description of a location result.

Field	Type	Required	Description
type	"local_description"	true	The type of a location description. The value is always local_description.
id	string	true	A Temporary id of the location with this description.
description	string	false	AI generated description of the location with the given id.

# Locations

A model representing location results.

Field	Type	Required	Description
type	"locations"	true	Location type identifier. The value is always locations.
results	list [ LocationResult ]	true	An aggregated list of location sensitive results.

# MixedResponse

The ranking order of results on a search result page.

Field	Type	Required	Description
type	"mixed"	true	The type representing the model mixed. The value is always mixed.
main	list [ ResultReference ]	false	The ranking order for the main section of the search result page.
top	list [ ResultReference ]	false	The ranking order for the top section of the search result page.
side	list [ ResultReference ]	false	The ranking order for the side section of the search result page.

# ResultReference

The ranking order of results on a search result page.

Field	Type	Required	Description
type	string	true	The type of the result.
index	int	false	The 0th based index where the result should be placed.
all	bool	true	Whether to put all the results from the type at specific position.

# Videos

A model representing video results.

Field	Type	Required	Description
type	videos	true	The type representing the videos. The value is always videos.
results	list [ VideoResult ]	true	A list of video results.
mutated_by_goggles	bool	false	Whether the video results are changed by a Goggle. False by default.

# News

A model representing news results.

Field	Type	Required	Description
type	news	true	The type representing the news. The value is always news.
results	list [ NewsResult ]	true	A list of news results.
mutated_by_goggles	bool	false	Whether the news results are changed by a Goggle. False by default.

# NewsResult (Result)

A model representing news results.

Field	Type	Required	Description
meta_url	MetaUrl	false	The aggregated information on the url representing a news result
source	string	false	The source of the news.
breaking	bool	true	Whether the news result is currently a breaking news.
is_live	bool	true	Whether the news result is currently live.
thumbnail	Thumbnail	false	The thumbnail associated with the news result.
age	string	false	A string representing the age of the news article.
extra_snippets	list [ string ]	false	A list of extra alternate snippets for the news search result.

# PictureResults

A model representing a list of pictures.

Field	Type	Required	Description
viewMoreUrl	string	false	A url to view more pictures.
results	list [ Thumbnail ]	true	A list of thumbnail results.

# Action

A model representing an action to be taken.

Field	Type	Required	Description
type	string	true	The type representing the action.
url	string	true	A url representing the action to be taken.

# PostalAddress

A model representing a postal address of a location

Field	Type	Required	Description
type	"PostalAddress"	true	The type identifying a postal address. The value is always PostalAddress.
country	string	false	The country associated with the location.
postalCode	string	false	The postal code associated with the location.
streetAddress	string	false	The street address associated with the location.
addressRegion	string	false	The region associated with the location. This is usually a state.
addressLocality	string	false	The address locality or subregion associated with the location.
displayAddress	string	true	The displayed address string.

# OpeningHours

Opening hours of a bussiness at a particular location.

Field	Type	Required	Description
current_day	list [ DayOpeningHours ]	false	The current day opening hours. Can have two sets of opening hours.
days	list [ list [ DayOpeningHours ] ]	false	The opening hours for the whole week.

# DayOpeningHours

A model representing the opening hours for a particular day for a business at a particular location.

Field	Type	Required	Description
abbr_name	string	true	A short string representing the day of the week.
full_name	string	true	A full string representing the day of the week.
opens	string	true	A 24 hr clock time string for the opening time of the business on a particular day.
closes	string	true	A 24 hr clock time string for the closing time of the business on a particular day.

# Contact

A model representing contact information for an entity.

Field	Type	Required	Description
email	string	false	The email address.
telephone	string	false	The telephone number.

# DataProvider

A model representing the data provider associated with the entity.

Field	Type	Required	Description
type	"external"	true	The type representing the source of data. This is usually external.
name	string	true	The name of the data provider. This can be a domain.
url	string	true	The url where the information is coming from.
long_name	string	false	The long name for the data provider.
img	string	false	The served url for the image data.

# Profile

A profile of an entity.

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

# Unit

A model representing a unit of measurement.

Field	Type	Required	Description
value	float	true	The quantity of the unit.
units	string	true	The name of the unit associated with the quantity.

# MovieData

Aggregated data for a movie result.

Field	Type	Required	Description
name	string	false	Name of the movie.
description	string	false	A short plot summary for the movie.
url	string	false	A url serving a movie profile page.
thumbnail	Thumbnail	false	A thumbnail for a movie poster.
release	string	false	The release date for the movie.
directors	list [ Person ]	false	A list of people responsible for directing the movie.
actors	list [ Person ]	false	A list of actors in the movie.
rating	Rating	false	Rating provided to the movie from various sources.
duration	string	false	The runtime of the movie. The format is HH:MM:SS.
genre	list [ string ]	false	List of genres in which the movie can be classified.
query	string	false	The query that resulted in the movie result.

# Thing

A model describing a generic thing.

Field	Type	Required	Description
type	"thing"	true	A type identifying a thing. The value is always thing.
name	string	true	The name of the thing.
url	string	false	A url for the thing.
thumbnail	Thumbnail	false	Thumbnail associated with the thing.

# Person (Thing)

A model describing a person entity.

Field	Type	Required	Description
type	"person"	true	A type identifying a person. The value is always person.

# Rating

The rating associated with an entity.

Field	Type	Required	Description
ratingValue	float	true	The current value of the rating.
bestRating	float	true	Best rating received.
reviewCount	int	false	The number of reviews associated with the rating.
profile	Profile	false	The profile associated with the rating.
is_tripadvisor	bool	true	Whether the rating is coming from Tripadvisor.

# Book

A model representing a book result.

Field	Type	Required	Description
title	string	true	The title of the book.
author	list [ Person ]	true	The author of the book.
date	string	false	The publishing date of the book.
price	Price	false	The price of the book.
pages	int	false	The number of pages in the book.
publisher	Person	false	The publisher of the book.
rating	Rating	false	A gathered rating from different sources associated with the book.

# Price

A model representing the price for an entity.

Field	Type	Required	Description
price	string	true	The price value in a given currency.
price_currency	string	true	The current of the price value.

# Article

A model representing an article.

Field	Type	Required	Description
author	list [ Person ]	false	The author of the article.
date	string	false	The date when the article was published.
publisher	Organization	false	The name of the publisher for the article.
thumbnail	Thumbnail	false	A thumbnail associated with the article.
isAccessibleForFree	bool	false	Whether the article is free to read or is behind a paywall.

# ContactPoint (Thing)

A way to contact an entity.

Field	Type	Required	Description
type	"contact_point"	true	A type string identifying a contact point. The value is always contact_point.
telephone	string	false	The telephone number of the entity.
email	string	false	The email address of the entity.

# Organization (Thing)

An entity responsible for another entity.

Field	Type	Required	Description
type	"organization"	true	A type string identifying an organization. The value is always organization.
contact_points	list [ ContactPoint ]	false	A list of contact points for the organization.

# HowTo

Aggregated information on a how to.

Field	Type	Required	Description
text	string	true	The how to text.
name	string	false	A name for the how to.
url	string	false	A url associated with the how to.
image	list [ string ]	false	A list of image urls associated with the how to.

# Recipe

Aggregated information on a recipe.

Field	Type	Required	Description
title	string	true	The title of the recipe.
description	string	true	The description of the recipe.
thumbnail	Thumbnail	true	A thumbnail associated with the recipe.
url	string	true	The url of the web page where the recipe was found.
domain	string	true	The domain of the web page where the recipe was found.
favicon	string	true	The url for the favicon of the web page where the recipe was found.
time	string	false	The total time required to cook the recipe.
prep_time	string	false	The preparation time for the recipe.
cook_time	string	false	The cooking time for the recipe.
ingredients	string	false	Ingredients required for the recipe.
instructions	list [ HowTo ]	false	List of instructions for the recipe.
servings	int	false	How many people the recipe serves.
calories	int	false	Calorie count for the recipe.
rating	Rating	false	Aggregated information on the ratings associated with the recipe.
recipeCategory	string	false	The category of the recipe.
recipeCuisine	string	false	The cuisine classification for the recipe.
video	VideoData	false	Aggregated information on the cooking video associated with the recipe.

# Product

A model representing a product.

Field	Type	Required	Description
type	"Product"	true	A string representing a product type. The value is always product.
name	string	true	The name of the product.
category	string	false	The category of the product.
price	string	true	The price of the product.
thumbnail	Thumbnail	true	A thumbnail associated with the product.
description	string	false	The description of the product.
offers	list [ Offer ]	false	A list of offers available on the product.
rating	Rating	false	A rating associated with the product.

# Offer

An offer associated with a product.

Field	Type	Required	Description
url	string	true	The url where the offer can be found.
priceCurrency	string	true	The currency in which the offer is made.
price	string	true	The price of the product currently on offer.

# Review

A model representing a review for an entity.

Field	Type	Required	Description
type	"review"	true	A string representing review type. This is always review.
name	string	true	The review title for the review.
thumbnail	Thumbnail	true	The thumbnail associated with the reviewer.
description	string	true	A description of the review (the text of the review itself).
rating	Rating	true	The ratings associated with the review.

# Reviews

The reviews associated with an entity.

Field	Type	Required	Description
results	list [ TripAdvisorReview ]	true	A list of trip advisor reviews for the entity.
viewMoreUrl	string	true	A url to a web page where more information on the result can be seen.
reviews_in_foreign_language	bool	true	Any reviews available in a foreign language.

# TripAdvisorReview

A model representing a Tripadvisor review.

Field	Type	Required	Description
title	string	true	The title of the review.
description	string	true	A description seen in the review.
date	string	true	The date when the review was published.
rating	Rating	true	A rating given by the reviewer.
author	Person	true	The author of the review.
review_url	string	true	A url link to the page where the review can be found.
language	string	true	The language of the review.

# CreativeWork

A creative work relevant to the query. An example can be enriched metadata for an app.

Field	Type	Required	Description
name	string	true	The name of the creative work.
thumbnail	Thumbnail	true	A thumbnail associated with the creative work.
rating	Rating	false	A rating that is given to the creative work.

# MusicRecording

Result classified as a music label or a song.

Field	Type	Required	Description
name	string	true	The name of the song or album.
thumbnail	Thumbnail	false	A thumbnail associated with the music.
rating	Rating	false	The rating of the music.

# Software

A model representing a software entity.

Field	Type	Required	Description
name	string	false	The name of the software product.
author	string	false	The author of software product.
version	string	false	The latest version of the software product.
codeRepository	string	false	The code repository where the software product is currently available or maintained.
homepage	string	false	The home page of the software product.
datePublisher	string	false	The date when the software product was published.
is_npm	bool	false	Whether the software product is available on npm.
is_pypi	bool	false	Whether the software product is available on pypi.
stars	int	false	The number of stars on the repository.
forks	int	false	The numbers of forks of the repository.
ProgrammingLanguage	string	false	The programming language spread on the software product.

# DeepResult

Aggregated deep results from news, social, videos and images.

Field	Type	Required	Description
news	list [ NewsResult ]	false	A list of news results associated with the result.
buttons	list [ ButtonResult ]	false	A list of buttoned results associated with the result.
videos	list [ VideoResult ]	false	Videos associated with the result.
images	list [ Image ]	false	Images associated with the result.

# VideoResult (Result)

A model representing a video result.

Field	Type	Required	Description
type	"video_result"	true	The type identifying the video result. The value is always video_result.
video	VideoData	true	Meta data for the video.
meta_url	MetaUrl	false	Aggregated information on the URL
thumbnail	Thumbnail	false	The thumbnail of the video.
age	string	false	A string representing the age of 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. The format can be HH:MM:SS or MM:SS.
views	string	false	The number of views of the video.
creator	string	false	The creator of the video.
publisher	string	false	The publisher of the video.
thumbnail	Thumbnail	false	A thumbnail associated with the video.
tags	list [ string ]	false	A list of tags associated with the video.
author	Profile	false	Author of the video.
requires_subscription	bool	false	Whether the video requires a subscription to watch.

# ButtonResult

A result which can be used as a button.

Field	Type	Required	Description
type	"button_result"	true	A type identifying button result. The value is always button_result.
title	string	true	The title of the result.
url	string	true	The url for the button result.

# Image

A model describing an image

Field	Type	Required	Description
thumbnail	Thumbnail	true	The thumbnail associated with the image.
url	string	false	The url of the image.
properties	ImageProperties	false	Metadata on the image.

# Language

A model representing a language.

Field	Type	Required	Description
main	string	true	The main language seen in the string.

# ImageProperties

Metadata on an image.

Field	Type	Required	Description
url	string	true	The original image URL.
resized	string	true	The url for a better quality resized image.
placeholder	string	true	The placeholder image url.
height	int	false	The image height.
width	int	false	The image width.
format	string	false	The image format.
content_size	string	false	The image size.

# Summarizer

Details on getting the summary.

Field	Type	Required	Description
type	"summarizer"	true	The value is always summarizer.
key	string	true	The key for the summarizer API.