Web Search API
curl --request POST \
--url https://api.ppio.com/v3/web-search \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>' \
--data '
{
"query": "<string>",
"freshness": "<string>",
"summary": true,
"include": "<string>",
"exclude": "<string>",
"count": 123
}
'{
"SearchData": {
"_type": "<string>",
"queryContext": {},
"webPages": {},
"images": {},
"videos": {}
},
"WebSearchQueryContext": {
"originalQuery": "<string>"
},
"WebSearchWebPages": {
"webSearchUrl": "<string>",
"totalEstimatedMatches": 123,
"value": [
{}
],
"someResultsRemoved": true
},
"WebPageValue": {
"id": "<string>",
"name": "<string>",
"url": "<string>",
"displayUrl": "<string>",
"snippet": "<string>",
"summary": "<string>",
"siteName": "<string>",
"siteIcon": "<string>",
"datePublished": "<string>",
"dateLastCrawled": "<string>",
"cachedPageUrl": "<string>",
"language": "<string>",
"isFamilyFriendly": true,
"isNavigational": true
},
"WebSearchImages": {
"id": "<string>",
"readLink": "<string>",
"webSearchUrl": "<string>",
"isFamilyFriendly": true,
"value": [
{}
]
},
"WebSearchVideos": {
"id": "<string>",
"readLink": "<string>",
"webSearchUrl": "<string>",
"isFamilyFriendly": true,
"scenario": "<string>",
"value": [
{}
]
},
"ImageValue": {
"webSearchUrl": "<string>",
"name": "<string>",
"thumbnailUrl": "<string>",
"datePublished": "<string>",
"contentUrl": "<string>",
"hostPageUrl": "<string>",
"contentSize": "<string>",
"encodingFormat": "<string>",
"hostPageDisplayUrl": "<string>",
"width": 123,
"height": 123,
"thumbnail": {}
},
"VideoValue": {
"webSearchUrl": "<string>",
"name": "<string>",
"description": "<string>",
"thumbnailUrl": "<string>",
"publisher": [
{}
],
"creator": {},
"contentUrl": "<string>",
"hostPageUrl": "<string>",
"encodingFormat": "<string>",
"hostPageDisplayUrl": "<string>",
"width": 123,
"height": 123,
"duration": "<string>",
"motionThumbnailUrl": "<string>",
"embedHtml": "<string>",
"allowHttpsEmbed": true,
"viewCount": 123,
"thumbnail": {},
"allowMobileEmbed": true,
"isSuperfresh": true,
"datePublished": "<string>"
},
"Creator": {
"name": "<string>"
},
"Publisher": {
"name": "<string>"
},
"Thumbnail": {
"height": 123,
"width": 123
},
"RankingResponse": {
"mainline": {}
},
"Mainline": {
"items": [
{}
]
},
"MainlineItem": {
"answerType": "<string>",
"value": {}
},
"MainlineItemValue": {
"id": "<string>"
}
}联网搜索
Web Search API
POST
/
v3
/
web-search
Web Search API
curl --request POST \
--url https://api.ppio.com/v3/web-search \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>' \
--data '
{
"query": "<string>",
"freshness": "<string>",
"summary": true,
"include": "<string>",
"exclude": "<string>",
"count": 123
}
'{
"SearchData": {
"_type": "<string>",
"queryContext": {},
"webPages": {},
"images": {},
"videos": {}
},
"WebSearchQueryContext": {
"originalQuery": "<string>"
},
"WebSearchWebPages": {
"webSearchUrl": "<string>",
"totalEstimatedMatches": 123,
"value": [
{}
],
"someResultsRemoved": true
},
"WebPageValue": {
"id": "<string>",
"name": "<string>",
"url": "<string>",
"displayUrl": "<string>",
"snippet": "<string>",
"summary": "<string>",
"siteName": "<string>",
"siteIcon": "<string>",
"datePublished": "<string>",
"dateLastCrawled": "<string>",
"cachedPageUrl": "<string>",
"language": "<string>",
"isFamilyFriendly": true,
"isNavigational": true
},
"WebSearchImages": {
"id": "<string>",
"readLink": "<string>",
"webSearchUrl": "<string>",
"isFamilyFriendly": true,
"value": [
{}
]
},
"WebSearchVideos": {
"id": "<string>",
"readLink": "<string>",
"webSearchUrl": "<string>",
"isFamilyFriendly": true,
"scenario": "<string>",
"value": [
{}
]
},
"ImageValue": {
"webSearchUrl": "<string>",
"name": "<string>",
"thumbnailUrl": "<string>",
"datePublished": "<string>",
"contentUrl": "<string>",
"hostPageUrl": "<string>",
"contentSize": "<string>",
"encodingFormat": "<string>",
"hostPageDisplayUrl": "<string>",
"width": 123,
"height": 123,
"thumbnail": {}
},
"VideoValue": {
"webSearchUrl": "<string>",
"name": "<string>",
"description": "<string>",
"thumbnailUrl": "<string>",
"publisher": [
{}
],
"creator": {},
"contentUrl": "<string>",
"hostPageUrl": "<string>",
"encodingFormat": "<string>",
"hostPageDisplayUrl": "<string>",
"width": 123,
"height": 123,
"duration": "<string>",
"motionThumbnailUrl": "<string>",
"embedHtml": "<string>",
"allowHttpsEmbed": true,
"viewCount": 123,
"thumbnail": {},
"allowMobileEmbed": true,
"isSuperfresh": true,
"datePublished": "<string>"
},
"Creator": {
"name": "<string>"
},
"Publisher": {
"name": "<string>"
},
"Thumbnail": {
"height": 123,
"width": 123
},
"RankingResponse": {
"mainline": {}
},
"Mainline": {
"items": [
{}
]
},
"MainlineItem": {
"answerType": "<string>",
"value": {}
},
"MainlineItemValue": {
"id": "<string>"
}
}从全网搜索任何网页信息和网页链接,结果准确、摘要完整,更适合 AI 使用。
搜索结果包括网页、图片
- 网页包括 name、url、snippet、summary、siteName、siteIcon、datePublished 等信息
- 图片包括 contentUrl、hostPageUrl、width、height 等信息
可配置搜索时间范围、是否显示摘要,支持按分页获取更多结果。
请求头
枚举值:
application/jsonBearer 身份验证格式,例如:Bearer {{API 密钥}}。
请求体
用户的搜索词。
搜索指定时间范围内的网页。可填值:
noLimit,不限(默认)oneDay,一天内oneWeek,一周内oneMonth,一个月内oneYear,一年内YYYY-MM-DD..YYYY-MM-DD,搜索日期范围,例如:“2025-01-01..2025-04-06”YYYY-MM-DD,搜索指定日期,例如:“2025-04-06”
推荐使用
noLimit。搜索算法会自动进行时间范围的改写,效果更佳。如果指定时间范围,很有可能出现时间范围内没有相关网页的情况,导致找不到搜索结果。是否显示文本摘要。可填值:
true,显示false,不显示(默认)
指定搜索的网站范围。多个域名使用
| 或 , 分隔,最多不能超过20个可填值:- 根域名
- 子域名
排除搜索的网站范围。多个域名使用
| 或 , 分隔,最多不能超过20个可填值:- 根域名
- 子域名
返回结果的条数(实际返回结果数量可能会小于count指定的数量)。
- 可填范围:1-50,最大单次搜索返回50条
- 默认为10
响应
单个网页搜索结果的详细信息
显示 properties
显示 properties
网页的排序ID
网页的标题
网页的URL
网页的展示URL(url decode后的格式)
网页内容的简短描述
网页内容的文本摘要,当请求参数中 summary 为 true 时显示此属性
网页的网站名称
网页的网站图标
网页的发布时间(例如:2025-02-23T08:18:30+08:00),UTC+8时间
网页的发布时间(此处其实是发布时间,名字起为LastCrawled是兼容性适配)
接口中返回的
dateLastCrawled 值(例如:2025-02-23T08:18:30Z)实际上要表达的是 UTC+8 北京时间2025-02-23 08:18:30,并非UTC时间。实际应用中请使用 datePublished 字段,或将 “2025-02-23T08:18:30Z” 替换成 “2025-02-23T08:18:30+08:00”,即得到正确的UTC+8时间,可以使用 datetime 函数正确解析。网页的缓存页面URL
网页的语言
是否为家庭友好的页面
是否为导航性页面
单个图片搜索结果的详细信息
显示 properties
显示 properties
单个视频搜索结果的详细信息
显示 properties
显示 properties
视频的搜索URL
视频的名称
视频的描述
视频的缩略图URL
视频的发布者列表
视频的创建者信息
视频的内容URL
视频所在页面的URL
视频的编码格式
视频所在页面的展示URL
视频的宽度
视频的高度
视频的时长
视频的动态缩略图URL
视频的嵌入HTML代码
是否允许HTTPS嵌入
视频的观看次数
视频的缩略图信息
是否允许移动端嵌入
是否为超新鲜内容
视频的发布时间
⌘I