> ## Documentation Index > Fetch the complete documentation index at: https://test-62a57ffd.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Video search ## OpenAPI ````yaml api-reference/openapi.json get /v1/videos/search openapi: 3.1.0 info: title: Brave Search Products API description: | Product APIs exposed by Brave Search. You will be able to: * **Web Search** termsOfService: http://localhost:10000/terms-of-use/ contact: name: Brave Search API url: http://localhost:10000/contact/ email: search-api@brave.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: 1.0.0 x-logo: url: >- https://cdn.search.brave.com/docs/681607ea86f83e9e04d242342a18f73f83f37137f5cd5246753f7a7a5beaca32-brave-logo-home-dark.svg servers: - url: /res description: Default server security: - ApiKeyAuth: [] tags: - name: web description: Get search results from the web x-displayName: Web Search x-mint: title: Web Search API description: Get search results from the web - name: news description: Get search results from the news x-displayName: News Search - name: videos description: Get search results from the videos x-displayName: Videos Search - name: images description: Get search results from the images x-displayName: Images Search - name: summarizer description: Get summarized search results x-displayName: AI Search - name: other description: Other API services x-displayName: Other paths: /v1/videos/search: get: tags: - videos summary: Video search operationId: search_videos_v1_videos_search_get parameters: - name: q in: query required: true schema: type: string maxLength: 400 minLength: 1 title: Q description: >- The user's search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query. description: >- The user's search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query. - name: search_lang in: query required: false schema: $ref: '#/components/schemas/Language-Input' description: >- The search language preference. The 2 or more character language code for which the search results are provided. default: en description: >- The search language preference. The 2 or more character language code for which the search results are provided. - name: ui_lang in: query required: false schema: $ref: '#/components/schemas/MarketCodes' description: >- User interface language preferred in response. Usually of the format -. For more, see [RFC 9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-accept-language). default: en-US description: >- User interface language preferred in response. Usually of the format -. For more, see [RFC 9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-accept-language). - name: country in: query required: false schema: $ref: '#/components/schemas/SearchCountry' description: >- The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries. default: US description: >- The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries. - name: safesearch in: query required: false schema: $ref: '#/components/schemas/app__models__general__SafeSearch' description: >- Filters search results for adult content. The following values are supported: off (No filtering), moderate (Filter out explicit content), strict (Filter out explicit and suggestive content). The default value is moderate default: 'off' description: >- Filters search results for adult content. The following values are supported: off (No filtering), moderate (Filter out explicit content), strict (Filter out explicit and suggestive content). The default value is moderate - name: count in: query required: false schema: type: integer maximum: 100 minimum: 1 description: >- The number of search results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results. default: 20 title: Count description: >- The number of search results returned in response. The maximum is 50. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results. - name: offset in: query required: false schema: type: integer maximum: 9 minimum: 0 description: >- The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is 9. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with count. For example, if your user interface displays 20 search results per page, set count to 20 and offset to 0 to show the first page of results. To get subsequent pages, increment offset by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages. default: 0 title: Offset description: >- The zero based offset that indicates number of search results per page (count) to skip before returning the result. The maximum is 9. The actual number delivered may be less than requested based on the query. In order to paginate results use this parameter together with count. For example, if your user interface displays 20 search results per page, set count to 20 and offset to 0 to show the first page of results. To get subsequent pages, increment offset by 1 (e.g. 0, 1, 2). The results may overlap across multiple pages. - name: spellcheck in: query required: false schema: type: boolean title: Spellcheck description: >- 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. default: true description: >- 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. - name: freshness in: query required: false schema: type: string description: >- Filters search results by when they were discovered. The following values are supported: pd (Discovered within the last 24 hours), pw (Discovered within the last 7 Days), pm (Discovered within the last 31 Days), py (Discovered within the last 365 Days), YYYY-MM-DDtoYYYY-MM-DD (timeframe is also supported by specifying the date range e.g. 2022-04-01to2022-07-30). default: '' title: Freshness description: >- Filters search results by when they were discovered. The following values are supported: pd (Discovered within the last 24 hours), pw (Discovered within the last 7 Days), pm (Discovered within the last 31 Days), py (Discovered within the last 365 Days), YYYY-MM-DDtoYYYY-MM-DD (timeframe is also supported by specifying the date range e.g. 2022-04-01to2022-07-30). examples: Time range: value: 2022-04-01to2022-07-30 Fixed time: value: pm - name: include_fetch_metadata in: query required: false schema: type: boolean description: Include fetch metadata default: false title: Include Fetch Metadata description: Include fetch metadata examples: Include fetch metadata: value: true Exclude fetch metadata: value: false - name: operators in: query required: false schema: type: boolean title: Operators description: Whether to apply search operators default: true description: Whether to apply search operators examples: Apply search operators: value: true Ignore search operators: value: false - name: x-subscription-token in: header required: true schema: type: string title: Subscription token description: The subscription token that was generated for the product. examples: - BSAgdIxiH0OLq6fnx6F-xp8Yplv4uOp description: The subscription token that was generated for the product. - name: api-version in: header required: false schema: anyOf: - type: string - type: 'null' title: API version description: >- The API version to use. This is denoted by the format `YYYY-MM-DD`. Default is the latest that is available. description: >- The API version to use. This is denoted by the format `YYYY-MM-DD`. Default is the latest that is available. - name: accept in: header required: false schema: $ref: '#/components/schemas/Accept' title: Media type description: The default supported media type is application/json. examples: - application/json default: application/json description: The default supported media type is application/json. - name: cache-control in: header required: false schema: anyOf: - $ref: '#/components/schemas/CacheControl' - type: 'null' title: Cache control description: >- 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. description: >- 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. - name: user-agent in: header required: false schema: anyOf: - type: string - type: 'null' title: User agent description: >- 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](https://www.rfc-editor.org/rfc/rfc9110.html#name-user-agent). examples: - >- **Android** Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36 - >- **iOS** Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1 - >- **macOS** Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36 - >- **Windows** Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36 description: >- 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](https://www.rfc-editor.org/rfc/rfc9110.html#name-user-agent). responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/VideoSearchApiResponse' '404': content: application/json: examples: SUBSCRIPTION_NOT_FOUND: summary: Missing subscription. value: type: ErrorResponse errors: - id: 5d832250-9396-4f6e-b84a-2a1fe524cd7d code: SUBSCRIPTION_NOT_FOUND detail: No subscription found. status: 404 meta: component: subscriptions time: 1663072993 schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found '422': content: application/json: examples: SUBSCRIPTION_TOKEN_INVALID: summary: Invalid subscription token. value: type: ErrorResponse errors: - id: 5d832250-9396-4f6e-b84a-2a1fe524cd7d code: SUBSCRIPTION_TOKEN_INVALID detail: The provided subscription token is invalid. status: 422 meta: component: authentication time: 1663072993 schema: $ref: '#/components/schemas/ErrorResponse' description: Unprocessable Entity '429': content: application/json: examples: RATE_LIMITED: summary: Rate limited. value: type: ErrorResponse errors: - id: 5d832250-9396-4f6e-b84a-2a1fe524cd7d code: RATE_LIMITED detail: Request rate limit exceeded for plan. status: 429 meta: component: rate_limiter time: 1663072993 QUOTA_LIMITED: summary: Quota limited. value: type: ErrorResponse errors: - id: 5d832250-9396-4f6e-b84a-2a1fe524cd7d code: QUOTA_LIMITED detail: Request quota limit exceeded for plan. status: 429 meta: component: rate_limiter time: 1663072993 schema: $ref: '#/components/schemas/ErrorResponse' description: Too Many Requests components: schemas: Language-Input: type: string enum: - 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 title: Language MarketCodes: type: string enum: - es-AR - en-AU - de-AT - nl-BE - fr-BE - pt-BR - en-CA - fr-CA - es-CL - da-DK - fi-FI - fr-FR - de-DE - el-GR - zh-HK - en-IN - en-ID - it-IT - ja-JP - ko-KR - en-MY - es-MX - nl-NL - en-NZ - no-NO - zh-CN - pl-PL - en-PH - ru-RU - en-ZA - es-ES - sv-SE - fr-CH - de-CH - zh-TW - tr-TR - en-GB - en-US - es-US title: MarketCodes SearchCountry: type: string enum: - 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 title: SearchCountry app__models__general__SafeSearch: type: string enum: - 'off' - moderate - strict title: SafeSearch Accept: type: string enum: - application/json - '*/*' title: Accept CacheControl: type: string enum: - no-cache const: no-cache title: CacheControl VideoSearchApiResponse: properties: type: type: string enum: - videos const: videos title: Type default: videos query: $ref: >- #/components/schemas/app__models__products__search__v1__videos__Query description: Video search query string. results: items: $ref: >- #/components/schemas/app__models__products__search__v1__videos__VideoResult type: array title: Results description: The list of video results for the given query. default: [] extra: $ref: >- #/components/schemas/app__models__products__search__v1__videos__Extra description: Additional information about the video search results. type: object required: - query - extra title: VideoSearchApiResponse ErrorResponse: properties: type: type: string title: Type default: ErrorResponse error: $ref: '#/components/schemas/ErrorModel' time: type: integer title: Time default: 0 type: object required: - error title: ErrorResponse app__models__products__search__v1__videos__Query: properties: original: type: string title: Original description: The original query that was requested. altered: anyOf: - type: string - type: 'null' title: Altered description: >- The altered query by the spellchecker. This is the query that is used to search if any. cleaned: anyOf: - type: string - type: 'null' title: Cleaned description: >- The cleaned normalized query by the spellchecker. This is the query that is used to search if any. spellcheck_off: anyOf: - type: boolean - type: 'null' title: Spellcheck Off description: Whether the spellchecker is enabled or disabled. show_strict_warning: anyOf: - type: boolean - type: 'null' title: Show Strict Warning description: >- 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. search_operators: anyOf: - $ref: '#/components/schemas/SearchOperators' - type: 'null' description: Search operators applied to the query. type: object required: - original title: Query app__models__products__search__v1__videos__VideoResult: properties: type: type: string title: Type description: >- The type of video search API result. The value is always `video_result`. default: video_result url: type: string title: Url description: The source URL of the video. title: type: string title: Title description: The title of the video. description: anyOf: - type: string - type: 'null' title: Description description: The description for the video. age: anyOf: - type: string - type: 'null' title: Age description: A human readable representation of the page age. page_age: anyOf: - type: string - type: 'null' title: Page Age description: The page age found from the source web page. page_fetched: anyOf: - type: string - type: 'null' title: Page Fetched description: >- The ISO date time when the page was last fetched. The format is `YYYY-MM-DDTHH:MM:SSZ`. fetched_content_timestamp: anyOf: - type: integer - type: 'null' title: Fetched Content Timestamp description: The timestamp when the content was fetched. video: anyOf: - $ref: >- #/components/schemas/app__models__products__search__v1__videos__VideoData - type: 'null' description: Metadata for the video. meta_url: anyOf: - $ref: >- #/components/schemas/app__models__products__search__v1__videos__MetaUrl - type: 'null' description: >- Aggregated information on the URL associated with the video search result. thumbnail: anyOf: - $ref: >- #/components/schemas/app__models__products__search__v1__videos__Thumbnail - type: 'null' description: The thumbnail for the video. type: object required: - url - title title: VideoResult app__models__products__search__v1__videos__Extra: properties: might_be_offensive: type: boolean title: Might Be Offensive description: >- Indicates whether the video search results might contain offensive content. default: false type: object title: Extra ErrorModel: properties: id: type: string title: Id status: type: integer title: Status code: $ref: '#/components/schemas/ErrorCode' detail: anyOf: - type: string - type: 'null' title: Detail meta: anyOf: - type: object - type: 'null' title: Meta type: object required: - id - status - code title: ErrorModel SearchOperators: properties: applied: type: boolean title: Applied description: Whether search operators were applied to the query. default: false cleaned_query: anyOf: - type: string - type: 'null' title: Cleaned Query description: The query after search operators have been processed. sites: anyOf: - items: type: string type: array - type: 'null' title: Sites description: 'List of site domains extracted from site: operators.' type: object title: SearchOperators app__models__products__search__v1__videos__VideoData: properties: duration: anyOf: - type: string - type: 'null' title: Duration description: A time string representing the duration of the video. views: anyOf: - type: integer - type: 'null' title: Views description: The number of views of the video. creator: anyOf: - type: string - type: 'null' title: Creator description: The creator of the video. publisher: anyOf: - type: string - type: 'null' title: Publisher description: The publisher of the video. requires_subscription: anyOf: - type: boolean - type: 'null' title: Requires Subscription description: Whether the video requires a subscription. tags: anyOf: - items: type: string type: array - type: 'null' title: Tags description: A list of tags relevant to the video. author: anyOf: - $ref: >- #/components/schemas/app__models__products__search__v1__videos__Profile - type: 'null' description: A profile associated with the video. type: object title: VideoData app__models__products__search__v1__videos__MetaUrl: properties: scheme: anyOf: - type: string - type: 'null' title: Scheme description: The protocol scheme extracted from the URL. netloc: anyOf: - type: string - type: 'null' title: Netloc description: The network location part extracted from the URL. hostname: anyOf: - type: string - type: 'null' title: Hostname description: The lowercased domain name extracted from the URL. favicon: anyOf: - type: string - type: 'null' title: Favicon description: The favicon used for the URL. path: anyOf: - type: string - type: 'null' title: Path description: The hierarchical path of the URL useful as a display string. type: object title: MetaUrl app__models__products__search__v1__videos__Thumbnail: properties: src: type: string title: Src description: The served URL of the thumbnail associated with the video. original: anyOf: - type: string - type: 'null' title: Original description: The original URL of the thumbnail associated with the video. type: object required: - src title: Thumbnail ErrorCode: type: string enum: - INTERNAL - INVALID_ID - UNAUTHORIZED - RESOURCE_NOT_ALLOWED - FORBIDDEN - VALIDATION - INVALID_PASSWORD - INVALID_EMAIL - INVALID_NAME - INVALID_COMPANY - INVALID_VAT_NUMBER - INVALID_DESCRIPTION - INVALID_USAGE - INVALID_INVOICE_NOTES - INVALID_PURCHASE_ORDER - PASSWORD_REUSED - PASSWORD_BREACHED - INVALID_TIME_RANGE - USER_ALREADY_EXISTS - USER_INACTIVE - RESET_PASSWORD_BAD_TOKEN - USER_NOT_FOUND - LOGIN_BAD_CREDENTIALS - LOGIN_USER_LOCKED_OUT - LOGIN_USER_NOT_VERIFIED - LOGIN_INVALID_MFA_CHALLENGE - VERIFY_USER_BAD_TOKEN - VERIFY_USER_ALREADY_VERIFIED - PLAN_NOT_FOUND - PLAN_ALREADY_EXISTS - PLAN_ALREADY_PUBLIC - PLAN_ALREADY_ALLOWED - STRIPE_CUSTOMER_NOT_EXISTS - STRIPE_SUBSCRIPTION_NOT_EXISTS - PRODUCT_NOT_FOUND - API_VERSION_NOT_FOUND - PRODUCT_ALREADY_EXISTS - OPTION_NOT_FOUND - OPTION_ALREADY_EXISTS - OPTION_NOT_IN_PLAN - SUBSCRIPTION_TOKEN_LIMIT - SUBSCRIPTION_TOKEN_INVALID - SUBSCRIPTION_TOKEN_INACTIVE - SUBSCRIPTION_TOKEN_DEACTIVATED - SUBSCRIPTION_TOKEN_NOT_FOUND - SUBSCRIPTION_ALREADY_EXISTS - SUBSCRIPTION_NOT_FOUND - ACTIVITY_SESSION_NOT_FOUND - ORGANIZATION_NOT_FOUND - ORGANIZATION_NOT_MEMBER - NO_PLANS_SUBSCRIBED - QUOTA_LIMITED - RATE_LIMITED - USAGE_LIMIT_EXCEEDED - USAGE_LIMIT_NOT_FOUND - USAGE_LIMIT_ALREADY_EXISTS - RESOURCE_NOT_SUBSCRIBED - CONTENT_TYPE_NOT_SUPPORTED - AGGREGATION_NOT_SUPPORTED - TIME_GRANULARITY_NOT_SUPPORTED - CURRENCY_NOT_FOUND - CURRENCY_ALREADY_EXISTS - CSRF_VERIFICATION - INVALID_GOGGLE_URL - INVALID_URL - INVALID_DOMAIN - INVALID_RESULT_FILTER - CONTENT_URL_LIMIT_EXCEEDED - TOS_NOT_FOUND - ADDENDUM_NOT_FOUND - REDACTION_NOT_FOUND - REDACTION_ALREADY_EXISTS - ADDENDUM_ALREADY_EXISTS - TOS_ALREADY_EXISTS - QUERY_NOT_FOUND - EMAIL_DOMAIN_IN_BLOCKLIST_NOT_FOUND - EMAIL_DOMAIN_IN_BLOCKLIST_ALREADY_EXISTS - EMAIL_DOMAIN_NOT_ALLOWED - INVALID_TOTP_TOKEN - EMAIL_MFA_SENT_EXCEEDED - EMAIL_MFA_NOT_SENT - AUTHENTICATOR_MFA_ALREADY_EXISTS - AUTHENTICATOR_MFA_NOT_FOUND - MFA_FAIL_TOO_MANY_ATTEMPTS - INVALID_RECOVERY_CODE - MFA_TOKEN_NOT_FOUND - PAYMENT_METHOD_NOT_FOUND - PAYMENT_METHOD_ALREADY_EXISTS - ROLE_NOT_FOUND - USER_ALREADY_MEMBER - ORGANIZATION_INVITATION_ALREADY_EXISTS - INVALID_ORGANIZATION_INVITATION - ORGANIZATION_INVITATION_NOT_FOUND - COMPLIANCE_NOT_FOUND - AWS_MARKETPLACE_TOKEN_INVALID - AWS_MARKETPLACE_TOKEN_EXPIRED - AWS_MARKETPLACE_CUSTOMER_RESOLUTION_FAILED - AWS_MARKETPLACE_PRODUCT_NOT_FOUND - AWS_MARKETPLACE_CREDENTIALS_MISSING - AWS_MARKETPLACE_API_ERROR - EMAIL_CHANGE_BAD_TOKEN - EMAIL_CHANGE_INVALID_MFA_CHALLENGE - EMAIL_CHANGE_MFA_FAIL_TOO_MANY_ATTEMPTS - EMAIL_CHANGE_RATE_LIMITED - EMAIL_CHANGE_INVALID_PASSWORD title: ErrorCode app__models__products__search__v1__videos__Profile: properties: name: type: string title: Name description: The name of the profile. url: type: string title: Url description: The original URL where the profile is available. long_name: anyOf: - type: string - type: 'null' title: Long Name description: The long name of the profile. img: anyOf: - type: string - type: 'null' title: Img description: The served image URL representing the profile. type: object required: - name - url title: Profile securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-subscription-token description: The subscription token that was generated for the product. ````