Skip to content

Intelligent Search API

General Information

Parameter Description Example
basePath Base path for search calls https://genaiapi.cloudsway.net/
endpointPath Randomly generated endpoint path for search calls LPUqHEAjfonOmohV
AccessKey Access key for search calls RWxxxxxxxx0Gd

Based on the example above, the final request path for the IntelliSearch API is:

https://genaiapi.cloudsway.net/LPUqHEAjfonOmohV/bing/v7.0/search

or

https://genaiapi.cloudsway.net/v7.0/search

IntelliSearch

Request Method

GET

Request Path

  • With endpointPath:
  • {basePath}/{endpointPath}/bing/v7.0/search

  • Can precisely locate the unique endpoint

  • Without endpointPath:

  • {basePath}/v7.0/search
  • Automatically selects the endpoint; if there are multiple, it selects the first one

Request Headers

Parameter Required Description
Authorization Yes AccessKey
Bearer ${AccessKey}

Query Parameters

Parameter Required Type Description
q Yes String The user's search query term. This term cannot be empty. Advanced operators are not supported.
searchType Yes String Fixed value SIMPLE_AI_SUMMARY
count No Short The number of search results to include in the response. The default is 10, and the maximum is 50. The actual returned number may be less than the requested number.
mkt No String The market where the results come from. Typically, the mkt is the country where the user made the request. However, if the user is not in a country where Bing provides results, it may be a different country. The market must be in the form -. For example, en-US. This string is case-insensitive.
offset No Short The zero-based offset that indicates the number of search results to skip before returning results. The default is 0. Use this parameter with the count parameter to page results. For example, if your user interface displays 10 search results per page, set count to 10 and offset to 0 to get the first page of results. For each subsequent page, increase the offset by 10 (for example, 0, 10, 20). Multiple pages may contain some overlapping results.

Response Body

QueryContext

Defines the query string that Bing used for the request.

Name Value Type
originalQuery The query string specified in the request. String

SearchResponse

The top-level object that the search API returns for a successful request.

By default, the search API includes all relevant answers unless:

  • The query specifies the responseFilter query parameter to limit the answers returned.
  • One or more search components do not return results (for example, the query has no relevant news results).
  • The subscription key does not have access to the search component.
  • If the service suspects a denial-of-service attack, the request succeeds (HTTP status code 200 OK), but the response body is empty.
Name Value Type
_type Type hint, set to SearchResponse. String
queryContext The query string that Bing used for the request. QueryContext
webPages A list of webpages relevant to the search query. WebAnswer

WebAnswer

Defines a list of relevant webpage links.

Name Value Type
value A list of webpages relevant to the query. WebPage[]
webSearchUrl The URL to the Bing search results for the query. String

WebPage

Defines a webpage relevant to the query.

Name Value Type
about For internal use only. Object[]
dateLastCrawled The date and time when Bing last crawled the webpage. The date is in the format YYYY-MM-DDTHH:MM:SS. For example, 2015-04-13T05:23:39. String
datePublished The date and time when the webpage was published. The date is in the format YYYY-MM-DDTHH:MM:SS. For example, 2015-04-13T05:23:39. String
datePublishedDisplayText A display version of the datePublished. String
contractualRules A list of rules that you must follow when displaying the answer. For information about displaying contractual rules, see Data Attribution. Object[]
deepLinks A list of links to related content found on the website that contains this webpage. In this context, the WebPage object only includes the name and url fields, and optionally the snippet field. WebPage[]
displayUrl The display URL of the webpage. This URL is for display purposes only and is not well-formed. String
id A unique identifier of the webpage in the list of webpage results. Only included if the Ranking answer specifies that you should mix the webpage with other search results. Each webpage includes an ID that matches the ID in the Ranking answer. For more information, see Ranking Results. String
isFamilyFriendly A Boolean value that indicates whether the webpage contains adult content. If the webpage does not contain adult content, isFamilyFriendly is set to true. Boolean
isNavigational A Boolean value that indicates whether the user’s query is frequently used to navigate to different parts of the webpage’s domain. If users navigate to other parts of the site from this page, the value is true. Boolean
language The two-letter language code of the webpage. For example, en indicates English. String
malware If Bing believes the webpage might present a potential issue when the user clicks the URL link, you should display a high-visibility notification next to the webpage link. Malware
name The name of the webpage. Use this name and the url to create a hyperlink that, when clicked, takes the user to the webpage. String
mentions For internal use only. Object
searchTags A list of search tags specified by the webpage owner on the webpage. The API only returns indexed search tags. The MetaTag object’s name field contains the indexed search tag. Search tags begin with search.* (for example, search.assetId). The content field contains the tag’s value. MetaTag[]
snippet A snippet of text that describes the webpage content. String
url The URL of the webpage. Use this URL and the name to create a hyperlink that, when clicked, takes the user to the webpage. String
aiSummary AI-generated summary of the webpage content. String

Request Example

curl --request GET \
  --url 'https://genaiapi.cloudsway.net/LPUqHEAjfonOmohV/bing/v7.0/search?q=spacex&count=3&searchType=SIMPLE_AI_SUMMARY' \
  --header 'Authorization: Bearer RWxxxxxxxx0Gd'

Response Example

{
    "_type": "SearchResponse",
    "queryContext": {
        "originalQuery": "spacex"
    },
    "webPages": {
        "webSearchUrl": "https://www.bing.com/search?q=spacex",
        "value": [
            {
                "id": "https://api.bing.microsoft.com/api/v7/#WebPages.0",
                "name": "SpaceX因侵占破坏土地被起诉：马斯克被索赔1500万美元",
                "url": "https://xueqiu.com/9919963656/305469175",
                "isFamilyFriendly": true,
                "displayUrl": "https://xueqiu.com/9919963656/305469175",
                "snippet": "马斯克还向美国共和党国会委员会以及支持特朗普的美国政治行动委员会贡献了越来越多的资金，而且他一直在为后者提供资金。2024年7月，马斯克正式公开支持特朗普，他在社交媒体平台X上采访了特朗普数小时，称他为“通往繁荣的道路”。",
                "dateLastCrawled": "2024-09-24T11:31:00.0000000Z",
                "cachedPageUrl": "http://cc.bingj.com/cache.aspx?q=%E9%A9%AC%E6%96%AF%EF%BC%9F&d=2556298162967&mkt=zh-CN&setlang=zh-CN&w=IV3emKn3TClmyKJ86-UxbBI39d4JUdVi",
                "language": "zh_chs",
                "isNavigational": false,
                "noCache": false,
                "aiSummary": "美国游戏厂商Plaintiff Cards Against Humanity（CAH）正在起诉埃隆·马斯克的私人航天公司SpaceX，并向其索赔1500万美元。CAH声称SpaceX破坏了他们购买的位于美国德克萨斯州卡梅伦县的土地，包括堆放建筑材料、使用碎石和拖拉机等。CAH从未许可SpaceX进行这些活动，SpaceX也从未与CAH联系或道歉。CAH还推出了一个名为“elonowesyou100dollars.com”的网站，鼓励人们向马斯克施压。此前，CAH曾以独特的方式参与社会活动，如在黑色星期五销售牛粪对抗饥饿问题，制作防毒面具的“逃亡”背包等。同时，马斯克持续为政治选举提供经济支持，SpaceX也在该地区创造了大量就业机会。然而，CAH的诉讼反映了SpaceX扩张过程中可能存在的负面影响，即破坏当地环境和土地。"
            },
            {
                "id": "https://api.bing.microsoft.com/api/v7/#WebPages.1",
                "name": "SpaceX三部曲第二部《Reentry(再入)》新书发布，埃里克·伯 ...",
                "url": "https://www.bilibili.com/video/BV1kBsheyEpr/",
                "isFamilyFriendly": true,
                "displayUrl": "https://www.bilibili.com/video/BV1kBsheyEpr",
                "snippet": "【访谈/中英】当马云 遇见马斯克：人工智能、火星、就业、人口与可持续性 SpaceX小工 5353 25 【访谈/中英】马斯克2011年接受WSJ《Big Interview》采访，展望特斯拉与SpaceX未来发展 ...",
                "dateLastCrawled": "2024-09-24T21:27:00.0000000Z",
                "cachedPageUrl": "http://cc.bingj.com/cache.aspx?q=%E9%A9%AC%E4%BA%91%E8%BA%AB%E9%AB%98%EF%BC%9F&d=2693867175959&mkt=zh-CN&setlang=zh-CN&w=qIKhsttrW6mTnPSG4vSI_8PqFfaSqmqh",
                "language": "zh_chs",
                "isNavigational": false,
                "noCache": false,
                "aiSummary": "SpaceX三部曲第二部《Reentry(再入)》新书发布，作者埃里克·伯格接受采访时透露了SpaceX的发展历程和重要事件。书中详细记录了SpaceX如何克服重重困难，从初期的艰难起步到如今的成功，包括猎鹰重型火箭、猎鹰9号火箭回收、星链项目、星舰计划等。埃里克·伯格还分享了SpaceX的重要时刻和关键人物的故事，展现了SpaceX从小公司成长为全球领先的航天企业的历程。"
            },
            {
                "id": "https://api.bing.microsoft.com/api/v7/#WebPages.2",
                "name": "SpaceX 从海中打捞出星舰超级重型助推器残骸 - IT之家",
                "url": "https://www.ithome.com/0/798/045.htm",
                "isFamilyFriendly": true,
                "displayUrl": "https://www.ithome.com/0/798/045.htm",
                "snippet": "SpaceX 从海中打捞出了部分星舰巨型火箭的残骸。SpaceX 创始人兼首席执行官埃隆・马斯克上周日在 X 上发布了一张照片，展示了正在从海洋中打捞出的火箭残骸。马斯克表示，这是最近一次星舰测试飞行中使用的第一级助推器的一部分。",
                "dateLastCrawled": "2024-09-24T08:35:00.0000000Z",
                "cachedPageUrl": "http://cc.bingj.com/cache.aspx?q=%E9%A9%AC%E6%96%AF%EF%BC%9F&d=1319530267211&mkt=zh-CN&setlang=zh-CN&w=-5AXyoAy5PFCxTGT2INzRSokLfwu3C5R",
                "language": "zh_chs",
                "isNavigational": false,
                "noCache": false,
                "aiSummary": "SpaceX 从海中打捞出了星舰巨型火箭的残骸，这残骸来自最近一次星舰测试飞行中使用的第一级助推器。星舰由两个不锈钢部分组成，分别是超级重型助推器和星舰航天器，两者都由猛禽发动机提供动力。星舰在进行多次测试飞行后，达到了轨道速度，飞船和助推器在穿过大气层后幸存，并落入水中。这些残骸可能用于研究或确保不落入竞争对手手中。SpaceX 计划进行第五次测试飞行，但需要等待 FAA 的批准。"
            }
        ]
    }
}

MarketCode

Country/Region Language Market code
Argentina Spanish es-AR
Australia English en-AU
Austria German de-AT
Belgium Dutch nl-BE
Belgium French fr-BE
Brazil Portuguese pt-BR
Canada English en-CA
Canada French fr-CA
Chile Spanish es-CL
Denmark Danish da-DK
Finland Finnish fi-FI
France French fr-FR
Germany German de-DE
Hong Kong SAR Traditional Chinese zh-HK
India English en-IN
Indonesia English en-ID
Italy Italian it-IT
Japan Japanese ja-JP
Korea Korean ko-KR
Malaysia English en-MY
Mexico Spanish es-MX
Netherlands Dutch nl-NL
New Zealand English en-NZ
Norway Norwegian no-NO
People's republic of China Chinese zh-CN
Poland Polish pl-PL
Republic of the Philippines English en-PH
Russia Russian ru-RU
South Africa English en-ZA
Spain Spanish es-ES
Sweden Swedish sv-SE
Switzerland French fr-CH
Switzerland German de-CH
Taiwan Traditional Chinese zh-TW
Türkiye Turkish tr-TR
United Kingdom English en-GB
United States English en-US
United States Spanish es-US