> ## Documentation Index > Fetch the complete documentation index at: https://aisa.one/docs/llms.txt > Use this file to discover all available pages before exploring further. # News Search ## OpenAPI ````yaml openapi/zh/brave-search.json GET /apis/v1/brave/news/search openapi: 3.1.0 info: description: '' title: Brave Search version: '1' x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote x-aisa-configured-paths: - /apis/v1/brave/images/search - /apis/v1/brave/llm/context - /apis/v1/brave/local/descriptions - /apis/v1/brave/local/place_search - /apis/v1/brave/local/pois - /apis/v1/brave/news/search - /apis/v1/brave/spellcheck/search - /apis/v1/brave/suggest/search - /apis/v1/brave/videos/search - /apis/v1/brave/web/rich - /apis/v1/brave/web/search x-aisa-document: facts_hash: bfca7fbdc322363be69051cbb659ceb6830c024f0f2f839d53c6ac80f1ac360c generator_version: '2' protocol_version: '1' schema_version: '1' composer_version: '13' response_pending: [] document_hash: sha256:43ac90d547b4acdf6817aa626a8b8339da83b049b076535c100777fdabb2bbe9 x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-provider: brave-search x-aisa-catalogs: brave-search: title: Brave Search description: '' x-aisa-document: facts_hash: bfca7fbdc322363be69051cbb659ceb6830c024f0f2f839d53c6ac80f1ac360c generator_version: '2' protocol_version: '1' schema_version: '1' x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote servers: - url: https://api.aisa.one security: - bearerAuth: [] paths: /apis/v1/brave/news/search: get: tags: - default summary: News Search operationId: get_any_brave_search_apis_v1_brave_news_search parameters: - name: accept in: header required: false description: The default supported media type is application/json. schema: allOf: - type: string enum: - application/json - '*/*' title: Accept - default: application/json title: Media type description: The default supported media type is application/json. examples: - application/json deprecated: false examples: '0': value: application/json - name: api-version in: header required: false description: >- The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning. 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. Read more about API versioning. deprecated: false - name: cache-control in: header required: false 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. schema: anyOf: - type: string enum: - no-cache const: no-cache title: 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. deprecated: false - name: user-agent in: header required: false 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. 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. deprecated: false examples: Android: value: >- Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36 description: Android iOS: value: >- 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 description: iOS macOS: value: >- Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36 description: macOS Windows: value: >- Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36 description: Windows - name: count in: query required: false 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. schema: type: integer maximum: 50 minimum: 1 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. default: 20 deprecated: false - name: country in: query required: false description: >- The search query country, where the results come from. The country string is limited to 2 character country codes of supported countries or ALL for worldwide. schema: allOf: - 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 - 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 or ALL for worldwide. deprecated: false - name: extra_snippets in: query required: false description: >- A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts. schema: anyOf: - type: boolean - type: 'null' title: Extra Snippets description: >- A snippet is an excerpt from a page you get as a result of the query, and extra_snippets allow you to get up to 5 additional, alternative excerpts. deprecated: false examples: '': value: '' Include extra snippets: value: true Exclude extra snippets: value: false - name: freshness in: query required: false description: >-

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

schema: type: string title: Freshness description: >-

Filters search results by page age. The age of a page is determined by the most relevant date reported by the content, such as its published or last modified date. The following values are supported:

default: '' examples: - '' - pm - 2022-04-01to2022-07-30 deprecated: false examples: '0': value: '' '1': value: pm '2': value: 2022-04-01to2022-07-30 - name: goggles in: query required: false description: >- Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles. schema: anyOf: - type: string - items: type: string type: array - type: 'null' title: Goggles description: >- Goggles act as a custom re-ranking on top of Brave’s search index. The parameter supports both a url where the Goggle is hosted or the definition of the Goggle. For more details, see the Goggles documentation. The parameter can be a single Goggle or a list of up to 3 Goggles. deprecated: false examples: '': value: '' Prioritizes domains popular with the Hacker News: value: >- https://raw.githubusercontent.com/brave/goggles-quickstart/main/goggles/hacker_news.goggle Social media blocker: value: |- ! name: Social Networks ! description: Removes social networks ! public: true ! author: Average Joe ! avatar: #de0320 $discard,site=facebook.com $discard,site=x.com $discard,site=instagram.com - name: include_fetch_metadata in: query required: false description: Include fetch metadata. schema: type: boolean title: Include Fetch Metadata description: Include fetch metadata. default: false examples: - '' - true - false deprecated: false examples: '0': value: '' '1': value: true '2': value: false - name: offset in: query required: false 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. schema: type: integer maximum: 9 minimum: 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. default: 0 deprecated: false - name: operators in: query required: false description: Whether to apply search operators. schema: type: boolean title: Operators description: Whether to apply search operators. default: true examples: - '' - true - false deprecated: false examples: '0': value: '' '1': value: true '2': value: false - name: q in: query required: true description: >- The user’s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query. schema: type: string maxLength: 400 minLength: 1 title: The user's search query term. description: >- The user’s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query. deprecated: false - name: safesearch in: query required: false description: >-

Filters search results for adult content. The following values are supported:

schema: allOf: - type: string enum: - 'off' - moderate - strict title: SafeSearch - default: strict title: Safe search description: >-

Filters search results for adult content. The following values are supported:

examples: - '' - 'off' - moderate - strict deprecated: false examples: '0': value: '' '1': value: 'off' '2': value: moderate '3': value: strict - name: search_lang in: query required: false description: >- The search language preference. The 2 or more character language code for which the search results are provided. schema: allOf: - 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 - ja - 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 - default: en description: >- The search language preference. The 2 or more character language code for which the search results are provided. deprecated: false - name: spellcheck in: query required: false description: >- Whether to spell check the 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. schema: type: boolean title: Spellcheck description: >- Whether to spell check the 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 examples: - '' - true - false deprecated: false examples: '0': value: '' '1': value: true '2': value: false - name: ui_lang in: query required: false description: >- User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110. schema: allOf: - 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 - default: en-US description: >- User interface language preferred in response. Usually of the format <language_code>-<country_code>. For more, see RFC 9110. deprecated: false responses: '200': description: Successful Response content: application/json: schema: $ref: >- #/components/schemas/ResponseE3Baaa015480_NewsSearchApiResponse default: content: application/json: schema: {} description: >- Error response; upstream passthrough responses may use provider formats components: schemas: ResponseE3Baaa015480_NewsSearchApiResponse: properties: type: type: string enum: - news const: news title: Type default: news query: $ref: >- #/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__news__Query description: News search query string. results: items: $ref: >- #/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__news__NewsResult type: array title: Results description: The list of news results for the given query. default: [] type: object required: - query title: NewsSearchApiResponse ResponseE3Baaa015480_app__models__products__search__v1__news__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/ResponseE3Baaa015480_SearchOperators' - type: 'null' description: Search operators applied to the query. type: object required: - original title: Query ResponseE3Baaa015480_app__models__products__search__v1__news__NewsResult: properties: type: type: string enum: - news_result const: news_result title: Type description: >- The type of news search API result. The value is always news_result. default: news_result title: type: string title: Title description: 新闻文章的标题。 url: type: string title: Url description: The source URL of the news article. description: anyOf: - type: string - type: 'null' title: Description description: The description for the news article. age: anyOf: - type: string - type: 'null' title: Age description: >- A human-readable representation of the news article’s age. For example, 2 days ago. page_age: anyOf: - type: string - type: 'null' title: Page Age description: The page’s date, based on its published or last modified date. 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. profile: anyOf: - $ref: >- #/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__shared__Profile - type: 'null' description: A profile associated with the web page. fetched_content_timestamp: anyOf: - type: integer - type: 'null' title: Fetched Content Timestamp description: The timestamp when the content was fetched. meta_url: anyOf: - $ref: >- #/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__news__MetaUrl - type: 'null' description: >- Aggregated information on the URL associated with the news search result. breaking: anyOf: - type: boolean - type: 'null' title: Breaking description: Whether the result includes breaking news. thumbnail: anyOf: - $ref: >- #/components/schemas/ResponseE3Baaa015480_app__models__products__search__v1__news__Thumbnail - type: 'null' description: The thumbnail for the news article. extra_snippets: anyOf: - items: type: string type: array - type: 'null' title: Extra Snippets description: A list of extra alternate snippets for the news search result. icons: anyOf: - items: $ref: '#/components/schemas/ResponseE3Baaa015480_PostprocessedIcon' type: array - type: 'null' title: Icons description: Icons associated with the news result. type: object required: - title - url title: NewsResult ResponseE3Baaa015480_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 ResponseE3Baaa015480_app__models__products__search__v1__shared__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 description: A profile of an entity. ResponseE3Baaa015480_app__models__products__search__v1__news__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 ResponseE3Baaa015480_app__models__products__search__v1__news__Thumbnail: properties: src: type: string title: Src description: The served URL of the thumbnail associated with the news article. original: anyOf: - type: string - type: 'null' title: Original description: The original URL of the thumbnail associated with the news article. type: object required: - src title: Thumbnail ResponseE3Baaa015480_PostprocessedIcon: properties: href: type: string title: Href sizes: anyOf: - type: string - type: 'null' title: Sizes rel: anyOf: - type: string - type: 'null' title: Rel type: anyOf: - type: string - type: 'null' title: Type ext: anyOf: - type: string - type: 'null' title: Ext type: object required: - href - sizes - rel - type - ext title: PostprocessedIcon securitySchemes: bearerAuth: scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.