Back to Details

web-search

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Web Search

网页搜索

Requires API Key: Get one at https://api.search.brave.com
Plan: Included in the Search plan. See https://api-dashboard.search.brave.com/app/subscriptions/subscribe
需要API Key：可在https://api.search.brave.com获取
套餐：包含在Search套餐中。详情见https://api-dashboard.search.brave.com/app/subscriptions/subscribe

Quick Start (cURL)

快速开始（cURL）

Basic Search

基础搜索

bash
curl -s "https://api.search.brave.com/res/v1/web/search?q=python+web+frameworks" \
  -H "Accept: application/json" \
  -H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}"
bash
curl -s "https://api.search.brave.com/res/v1/web/search?q=python+web+frameworks" \
  -H "Accept: application/json" \
  -H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}"

With Parameters

带参数搜索

bash
curl -s "https://api.search.brave.com/res/v1/web/search" \
  -H "Accept: application/json" \
  -H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}" \
  -G \
  --data-urlencode "q=rust programming tutorials" \
  --data-urlencode "country=US" \
  --data-urlencode "search_lang=en" \
  --data-urlencode "count=10" \
  --data-urlencode "safesearch=moderate" \
  --data-urlencode "freshness=pm"
bash
curl -s "https://api.search.brave.com/res/v1/web/search" \
  -H "Accept: application/json" \
  -H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}" \
  -G \
  --data-urlencode "q=rust programming tutorials" \
  --data-urlencode "country=US" \
   --data-urlencode "search_lang=en" \
  --data-urlencode "count=10" \
  --data-urlencode "safesearch=moderate" \
  --data-urlencode "freshness=pm"

Endpoint

端点

http
GET https://api.search.brave.com/res/v1/web/search
POST https://api.search.brave.com/res/v1/web/search
Note: Both GET and POST methods are supported. POST is useful for long queries or complex Goggles.
Authentication: 
X-Subscription-Token: <API_KEY>
header
Optional Headers:
  • Accept-Encoding: gzip
    — Enable gzip compression
http
GET https://api.search.brave.com/res/v1/web/search
POST https://api.search.brave.com/res/v1/web/search
注意：同时支持GET和POST方法。POST适用于长查询或复杂的Goggles配置。
身份验证：
X-Subscription-Token: <API_KEY>
请求头
可选请求头:
  • Accept-Encoding: gzip
    — 启用gzip压缩

When to Use Web Search

何时使用网页搜索

FeatureWeb Search (this)LLM Context (
llm-context
)		Answers (
answers
)
OutputStructured results (links, snippets, metadata)Pre-extracted page content for LLMsEnd-to-end AI answers with citations
Result typesWeb, news, videos, discussions, FAQ, infobox, locations, richExtracted text chunks, tables, codeSynthesized answer + source list
Unique featuresGoggles, structured data (
schemas
), rich callbacks		Token budget control, threshold modesMulti-iteration search, streaming, OpenAI SDK compatible
SpeedFast (~0.5-1s)Fast (<1s)Slower (~30-180s)
Best forSearch UIs, data extraction, custom rankingRAG pipelines, AI agents, groundingChat interfaces, thorough research
特性网页搜索（本端点）LLM上下文（
llm-context
）		问答（
answers
）
输出结构化结果（链接、摘要、元数据）为LLM预提取的页面内容带引用的端到端AI问答结果
结果类型网页、新闻、视频、讨论、FAQ、信息框、地点、富媒体提取的文本片段、表格、代码合成答案+来源列表
独有特性Goggles、结构化数据（
schemas
）、富媒体回调		Token预算控制、阈值模式多轮搜索、流式传输、兼容OpenAI SDK
速度快（约0.5-1秒）快（<1秒）较慢（约30-180秒）
最佳适用场景搜索UI、数据提取、自定义排序RAG流水线、AI Agent、事实校验聊天界面、深度研究

Parameters

参数

ParameterTypeRequiredDefaultDescription
q
stringYes-Search query (1-400 chars, max 50 words)
country
stringNo
US
Search country (2-letter country code or 
ALL
)
search_lang
stringNo
en
Language preference (2+ char language code)
ui_lang
stringNo
en-US
UI language (e.g., "en-US")
count
intNo
20
Max results per page (1-20)
offset
intNo
0
Page offset for pagination (0-9)
safesearch
stringNo
moderate
Adult content filter (
off
/
moderate
/
strict
)
freshness
stringNo-Time filter (
pd
/
pw
/
pm
/
py
or date range)
text_decorations
boolNo
true
Include highlight markers
spellcheck
boolNo
true
Auto-correct query
result_filter
stringNo-Filter result types (comma-separated)
goggles
stringNo-Custom ranking filter (URL or inline)
extra_snippets
boolNo-Get up to 5 extra snippets per result
operators
boolNo
true
Apply search operators
units
stringNo-Measurement units (
metric
/
imperial
)
enable_rich_callback
boolNo
false
Enable rich 3rd party data callback
include_fetch_metadata
boolNo
false
Include 
fetched_content_timestamp
on results
参数类型是否必填默认值描述
q
字符串是-搜索查询（1-400字符，最多50个单词）
country
字符串否
US
搜索国家（两位国家代码或
ALL
）
search_lang
字符串否
en
语言偏好（2+字符语言代码）
ui_lang
字符串否
en-US
UI语言（例如"en-US"）
count
整数否
20
每页最大结果数（1-20）
offset
整数否
0
分页偏移量（0-9）
safesearch
字符串否
moderate
成人内容过滤（
off
/
moderate
/
strict
）
freshness
字符串否-时效性筛选（
pd
/
pw
/
pm
/
py
或自定义日期范围）
text_decorations
布尔值否
true
包含高亮标记
spellcheck
布尔值否
true
自动纠正查询
result_filter
字符串否-结果类型筛选（逗号分隔）
goggles
字符串否-自定义排序筛选器（URL或内联规则）
extra_snippets
布尔值否-每个结果最多获取5个额外摘要
operators
布尔值否
true
应用搜索运算符
units
字符串否-测量单位（
metric
/
imperial
）
enable_rich_callback
布尔值-
false
启用第三方富媒体数据回调
include_fetch_metadata
布尔值否
false
在结果中包含
fetched_content_timestamp

Freshness Values

时效性筛选值

ValueDescription
pd
Past day (24 hours)
pw
Past week (7 days)
pm
Past month (31 days)
py
Past year (365 days)
YYYY-MM-DDtoYYYY-MM-DD
Custom date range
值描述
pd
过去一天（24小时）
pw
过去一周（7天）
pm
过去一个月（31天）
py
过去一年（365天）
YYYY-MM-DDtoYYYY-MM-DD
自定义日期范围

Result Filter Values

结果筛选值

Filter types: 
discussions
, 
faq
, 
infobox
, 
news
, 
query
, 
videos
, 
web
, 
locations
bash
undefined
可筛选类型：
discussions
（讨论）、
faq
（常见问题）、
infobox
（信息框）、
news
（新闻）、
query
（查询）、
videos
（视频）、
web
（网页）、
locations
（地点）
bash
undefined

Only web and video results

仅返回网页和视频结果

curl "...&result_filter=web,videos"
undefined
curl "...&result_filter=web,videos"
undefined

Location Headers (Optional)

位置请求头（可选）

For location-aware results, add these headers. Lat/Long is sufficient when coordinates are known — the other headers are only needed as a fallback when coordinates are unavailable.
HeaderTypeDescription
X-Loc-Lat
floatUser latitude (-90.0 to 90.0)
X-Loc-Long
floatUser longitude (-180.0 to 180.0)
X-Loc-Timezone
stringIANA timezone (e.g., "America/San_Francisco")
X-Loc-City
stringCity name
X-Loc-State
stringState/region code (ISO 3166-2)
X-Loc-State-Name
stringState/region full name (e.g., "California")
X-Loc-Country
string2-letter country code
X-Loc-Postal-Code
stringPostal code (e.g., "94105")
Priority: 
X-Loc-Lat
+ 
X-Loc-Long
take precedence. When provided, downstream services resolve the location directly from coordinates and the text-based headers (City, State, Country, Postal-Code) are not used for location resolution. Provide text-based headers only when you don't have coordinates. Sending both won't break anything — lat/long simply wins.
如需基于位置的结果，可添加以下请求头。当已知坐标时，仅需提供Lat/Long即可——其他请求头仅在无法获取坐标时作为备选。
请求头类型描述
X-Loc-Lat
浮点数用户纬度（-90.0至90.0）
X-Loc-Long
浮点数用户经度（-180.0至180.0）
X-Loc-Timezone
字符串IANA时区（例如"America/San_Francisco"）
X-Loc-City
字符串城市名称
X-Loc-State
字符串州/地区代码（ISO 3166-2）
X-Loc-State-Name
字符串州/地区全名（例如"California"）
X-Loc-Country
字符串两位国家代码
X-Loc-Postal-Code
字符串邮政编码（例如"94105"）
优先级：
X-Loc-Lat
+ 
X-Loc-Long
优先级最高。当提供这两个参数时，下游服务会直接通过坐标解析位置，而文本类请求头（城市、州、国家、邮政编码）不会被用于位置解析。仅在没有坐标时才提供文本类请求头。同时提供两者不会导致错误——坐标会优先生效。

Response Format

响应格式

Response Fields

响应字段

FieldTypeDescription
type
stringAlways 
"search"
query.original
stringThe original search query
query.altered
string?Spellcheck-corrected query (if changed)
query.cleaned
string?Cleaned/normalized query
query.spellcheck_off
bool?Whether spellcheck was disabled
query.more_results_available
boolWhether more pages exist
query.show_strict_warning
bool?True if strict safesearch blocked adult results
query.search_operators
object?Applied search operators (
applied
, 
cleaned_query
, 
sites
)
web.type
stringAlways 
"search"
web.results[].title
stringPage title
web.results[].url
stringPage URL
web.results[].description
string?Snippet/description text
web.results[].age
string?Human-readable age (e.g., "2 days ago")
web.results[].language
string?Content language code
web.results[].meta_url
objectURL components (
scheme
, 
netloc
, 
hostname
, 
path
)
web.results[].thumbnail
object?Thumbnail (
src
, 
original
)
web.results[].thumbnail.original
string?Original full-size image URL
web.results[].thumbnail.logo
bool?Whether the thumbnail is a logo
web.results[].profile
object?Publisher identity (
name
, 
url
, 
long_name
, 
img
)
web.results[].page_age
string?ISO datetime of publication (e.g., 
"2025-04-12T14:22:41"
)
web.results[].extra_snippets
list[str]?Up to 5 additional excerpts
web.results[].deep_results
object?Additional links (
buttons
, 
links
) from the page
web.results[].schemas
list?Raw schema.org structured data
web.results[].product
object?Product info and reviews
web.results[].recipe
object?Recipe details (ingredients, time, ratings)
web.results[].article
object?Article metadata (author, publisher, date)
web.results[].book
object?Book info (author, ISBN, rating)
web.results[].software
object?Software product info
web.results[].rating
object?Aggregate ratings
web.results[].faq
object?FAQ found on the page
web.results[].movie
object?Movie info (directors, actors, genre)
web.results[].video
object?Video metadata (duration, views, creator)
web.results[].location
object?Location/restaurant details
web.results[].qa
object?Question/answer info
web.results[].creative_work
object?Creative work data
web.results[].music_recording
object?Music/song data
web.results[].organization
object?Organization info
web.results[].review
object?Review data
web.results[].content_type
string?Content type classification
web.results[].fetched_content_timestamp
int?Fetch timestamp (with 
include_fetch_metadata=true
)
web.mutated_by_goggles
boolWhether results were re-ranked by Goggles
web.family_friendly
boolWhether results are family-friendly
mixed
object?Preferred display order (see Mixed Response below)
discussions.results[]
array?Forum discussion clusters
discussions.results[].data.forum_name
string?Forum/community name
discussions.results[].data.num_answers
int?Number of answers/replies
discussions.results[].data.question
string?Discussion question
discussions.results[].data.top_comment
string?Top-voted comment excerpt
faq.results[]
array?FAQ entries
news.results[]
array?News articles
videos.results[]
array?Video results
infobox.results[]
array?Knowledge graph entries
locations.results[]
array?Local POI results
rich.hint.vertical
string?Rich result type
rich.hint.callback_key
string?Callback key for rich data
字段类型描述
type
字符串始终为
"search"
query.original
字符串原始搜索查询
query.altered
字符串（可选）拼写纠正后的查询（如果有修改）
query.cleaned
字符串（可选）清理/标准化后的查询
query.spellcheck_off
-是否禁用了拼写检查
query.more_results_available
布尔值是否存在更多分页结果
query.show_strict_warning
布尔值（可选）当严格模式SafeSearch拦截了成人内容时为true
query.search_operators
对象（可选）已应用的搜索运算符（
applied
、
cleaned_query
、
sites
）
web.type
字符串始终为
"search"
web.results[].title
字符串页面标题
web.results[].url
字符串页面URL
web.results[].description
字符串（可选）摘要/描述文本
web.results[].age
字符串（可选）易读的时间标识（例如"2天前"）
web.results[].language
字符串（可选）内容语言代码
web.results[].meta_url
对象URL组件（
scheme
、
netloc
、
hostname
、
path
）
web.results[].thumbnail
对象（可选）缩略图（
src
、
original
）
web.results[].thumbnail.original
字符串（可选）原始全尺寸图片URL
web.results[].thumbnail.logo
布尔值（可选）缩略图是否为Logo
web.results[].profile
对象（可选）发布者身份（
name
、
url
、
long_name
、
img
）
web.results[].page_age
字符串（可选）发布时间的ISO格式（例如
"2025-04-12T14:22:41"
）
web.results[].extra_snippets
字符串列表（可选）最多5个额外摘要片段
web.results[].deep_results
对象（可选）页面中的额外链接（
buttons
、
links
）
web.results[].schemas
列表（可选）原始schema.org结构化数据
web.results[].product
对象（可选）产品信息和评论
web.results[].recipe
对象（可选）食谱详情（食材、时间、评分）
web.results[].article
对象（可选）文章元数据（作者、发布者、日期）
web.results[].book
对象（可选）书籍信息（作者、ISBN、评分）
web.results[].software
对象（可选）软件产品信息
web.results[].rating
对象（可选）综合评分
web.results[].faq
对象（可选）页面中的FAQ内容
web.results[].movie
对象（可选）电影信息（导演、演员、类型）
web.results[].video
对象（可选）视频元数据（时长、播放量、创作者）
web.results[].location
对象（可选）地点/餐厅详情
web.results[].qa
对象（可选）问答信息
web.results[].creative_work
对象（可选）创意作品数据
web.results[].music_recording
对象（可选）音乐/歌曲数据
web.results[].organization
对象（可选）组织信息
web.results[].review
对象（可选）评论数据
web.results[].content_type
字符串（可选）内容类型分类
web.results[].fetched_content_timestamp
整数（可选）抓取时间戳（当
include_fetch_metadata=true
时）
web.mutated_by_goggles
布尔值结果是否被Goggles重新排序
web.family_friendly
布尔值结果是否适合家庭观看
mixed
对象（可选）推荐的展示顺序（见下方混合响应说明）
discussions.results[]
数组（可选）论坛讨论集群
discussions.results[].data.forum_name
字符串（可选）论坛/社区名称
discussions.results[].data.num_answers
整数（可选）回答/回复数量
discussions.results[].data.question
字符串（可选）讨论问题
discussions.results[].data.top_comment
字符串（可选）获赞最高的评论摘要
faq.results[]
数组（可选）FAQ条目
news.results[]
数组（可选）新闻文章
videos.results[]
数组（可选）视频结果
infobox.results[]
数组（可选）知识图谱条目
locations.results[]
数组（可选）本地POI结果
rich.hint.vertical
字符串（可选）富媒体结果类型
rich.hint.callback_key
字符串（可选）富媒体数据的回调密钥

JSON Example

JSON示例

json
{
  "type": "search",
  "query": {
    "original": "python frameworks",
    "altered": "python web frameworks",
    "spellcheck_off": false,
    "more_results_available": true
  },
  "web": {
    "type": "search",
    "results": [
      {
        "title": "Top Python Web Frameworks",
        "url": "https://example.com/python-frameworks",
        "description": "A comprehensive guide to Python web frameworks...",
        "age": "2 days ago",
        "language": "en",
        "meta_url": {
          "scheme": "https",
          "netloc": "example.com",
          "hostname": "example.com",
          "path": "/python-frameworks"
        },
        "thumbnail": {
          "src": "https://...",
          "original": "https://original-image-url.com/img.jpg"
        },
        "extra_snippets": ["Additional excerpt 1...", "Additional excerpt 2..."]
      }
    ],
    "family_friendly": true
  },
  "mixed": {
    "type": "mixed",
    "main": [
      {"type": "web", "index": 0, "all": false},
      {"type": "web", "index": 1, "all": false},
      {"type": "videos", "all": true}
    ],
    "top": [],
    "side": []
  },
  "videos": { "...": "..." },
  "news": { "...": "..." },
  "rich": {
    "type": "rich",
    "hint": {
      "vertical": "weather",
      "callback_key": "<callback_key_hex>"
    }
  }
}
json
{
  "type": "search",
  "query": {
    "original": "python frameworks",
    "altered": "python web frameworks",
    "spellcheck_off": false,
    "more_results_available": true
  },
  "web": {
    "type": "search",
    "results": [
      {
        "title": "Top Python Web Frameworks",
        "url": "https://example.com/python-frameworks",
        "description": "A comprehensive guide to Python web frameworks...",
        "age": "2 days ago",
        "language": "en",
        "meta_url": {
          "scheme": "https",
          "netloc": "example.com",
          "hostname": "example.com",
          "path": "/python-frameworks"
        },
        "thumbnail": {
          "src": "https://...",
          "original": "https://original-image-url.com/img.jpg"
        },
        "extra_snippets": ["Additional excerpt 1...", "Additional excerpt 2..."]
      }
    ],
    "family_friendly": true
  },
  "mixed": {
    "type": "mixed",
    "main": [
      {"type": "web", "index": 0, "all": false},
      {"type": "web", "index": 1, "all": false},
      {"type": "videos", "all": true}
    ],
    "top": [],
    "side": []
  },
  "videos": { "...": "..." },
  "news": { "...": "..." },
  "rich": {
    "type": "rich",
    "hint": {
      "vertical": "weather",
      "callback_key": "<callback_key_hex>"
    }
  }
}

Mixed Response

混合响应

The 
mixed
object defines the preferred display order of results across types. It contains three arrays:
ArrayPurpose
main
Primary result list (ordered sequence of results to display)
top
Results to display above main results
side
Results to display alongside main results (e.g., infobox)
Each entry is a 
ResultReference
with 
type
(e.g., 
"web"
, 
"videos"
), 
index
(into the corresponding result array), and 
all
(
true
to include all results of that type at this position).
mixed
对象定义了跨类型结果的推荐展示顺序。它包含三个数组：
数组用途
main
主要结果列表（按顺序展示的结果序列）
top
展示在主要结果上方的结果
side
展示在主要结果旁边的结果（例如信息框）
每个条目是一个
ResultReference
对象，包含
type
（例如
"web"
、
"videos"
）、
index
（对应结果数组的索引）和
all
（
true
表示在此位置包含该类型的所有结果）。

Search Operators

搜索运算符

OperatorSyntaxDescription
Site
site:example.com
Limit results to a specific domain
File extension
ext:pdf
Results with a specific file extension
File type
filetype:pdf
Results created in a specific file type
In title
intitle:python
Pages with term in the title
In body
inbody:tutorial
Pages with term in the body
In page
inpage:guide
Pages with term in title or body
Language
lang:es
Pages in a specific language (ISO 639-1)
Location
loc:us
Pages from a specific country (ISO 3166-1 alpha-2)
Include
+term
Force inclusion of a term
Exclude
-term
Exclude pages containing the term
Exact match
"exact phrase"
Match the exact phrase in order
AND
term1 AND term2
Both terms required (uppercase)
OR / NOT
term1 OR term2
, 
NOT term
Logical operators (uppercase)
Set 
operators=false
to disable operator parsing.
运算符语法描述
站点限定
site:example.com
将结果限制在特定域名
文件扩展名
ext:pdf
包含特定文件扩展名的结果
文件类型
filetype:pdf
特定文件类型创建的结果
标题包含
intitle:python
标题中包含指定术语的页面
正文包含
inbody:tutorial
正文中包含指定术语的页面
页面包含
inpage:guide
标题或正文中包含指定术语的页面
语言限定
lang:es
特定语言的页面（ISO 639-1代码）
位置限定
loc:us
特定国家的页面（ISO 3166-1 alpha-2代码）
强制包含
+term
强制包含某个术语
排除
-term
排除包含某个术语的页面
精确匹配
"exact phrase"
精确匹配短语顺序
逻辑与
term1 AND term2
必须同时包含两个术语（大写AND）
逻辑或/非
term1 OR term2
, 
NOT term
逻辑运算符（大写）
设置
operators=false
可禁用运算符解析。

Goggles (Custom Ranking) — Unique to Brave

Goggles（自定义排序）——Brave独有

Goggles let you re-rank search results — boost trusted sources, suppress SEO spam, or build focused search scopes.
MethodExample
Hosted
--data-urlencode "goggles=https://raw.githubusercontent.com/brave/goggles-quickstart/main/goggles/rust_programming.goggle"
Inline
--data-urlencode 'goggles=$discard\n$site=example.com'
Hosted goggles must be on GitHub/GitLab, include 
! name:
, 
! description:
, 
! author:
headers, and be registered at https://search.brave.com/goggles/create. Inline rules need no registration.
Syntax: 
$boost=N
/ 
$downrank=N
(1–10), 
$discard
, 
$site=example.com
. Combine with commas: 
$site=example.com,boost=3
. Separate rules with 
\n
(
%0A
).
Allow list: 
$discard\n$site=docs.python.org\n$site=developer.mozilla.org
— Block list: 
$discard,site=pinterest.com\n$discard,site=quora.com
Resources: Discover · Syntax · Quickstart
Goggles允许你重新排序搜索结果——提升可信来源权重、抑制SEO垃圾信息，或构建聚焦的搜索范围。
方式示例
托管式
--data-urlencode "goggles=https://raw.githubusercontent.com/brave/goggles-quickstart/main/goggles/rust_programming.goggle"
内联式
--data-urlencode 'goggles=$discard\n$site=example.com'
托管式Goggles必须托管在GitHub/GitLab，包含
! name:
、
! description:
、
! author:
头信息，并在https://search.brave.com/goggles/create注册。**内联式**规则无需注册。
语法：
$boost=N
/ 
$downrank=N
（1–10）、
$discard
、
$site=example.com
。可通过逗号组合：
$site=example.com,boost=3
。规则之间用
\n
（
%0A
）分隔。
允许列表：
$discard\n$site=docs.python.org\n$site=developer.mozilla.org
— 阻止列表：
$discard,site=pinterest.com\n$discard,site=quora.com
资源：发现Goggles · 语法说明 · 快速入门

Rich Data Enrichments

富媒体数据增强

For queries about weather, stocks, sports, currency, etc., use the rich callback workflow:
bash
undefined
对于天气、股票、体育、货币等查询，可使用富媒体回调流程：
bash
undefined

1. Search with rich callback enabled

1. 启用富媒体回调进行搜索

curl -s "https://api.search.brave.com/res/v1/web/search?q=weather+san+francisco&enable_rich_callback=true"
-H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}"
curl -s "https://api.search.brave.com/res/v1/web/search?q=weather+san+francisco&enable_rich_callback=true"
-H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}"

Response includes: "rich": {"hint": {"callback_key": "abc123...", "vertical": "weather"}}

响应将包含："rich": {"hint": {"callback_key": "abc123...", "vertical": "weather"}}

2. Get rich data with the callback key

2. 使用回调密钥获取富媒体数据

curl -s "https://api.search.brave.com/res/v1/web/rich?callback_key=abc123..."
-H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}"

**Supported Rich Types**: Calculator, Definitions, Unit Conversion, Unix Timestamp, Package Tracker, Stock, Currency, Cryptocurrency, Weather, American Football, Baseball, Basketball, Cricket, Football/Soccer, Ice Hockey, Web3, Translator
curl -s "https://api.search.brave.com/res/v1/web/rich?callback_key=abc123..."
-H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}"

**支持的富媒体类型**：计算器、定义、单位转换、Unix时间戳、包裹追踪、股票、货币、加密货币、天气、美式橄榄球、棒球、篮球、板球、足球、冰球、Web3、翻译器

Rich Callback Endpoint

富媒体回调端点

http
GET https://api.search.brave.com/res/v1/web/rich
ParameterTypeRequiredDescription
callback_key
stringYesCallback key from the web search 
rich.hint.callback_key
field
http
GET https://api.search.brave.com/res/v1/web/rich
参数类型是否必填描述
callback_key
字符串是网页搜索结果中
rich.hint.callback_key
字段的回调密钥

Use Cases

使用场景

  • General-purpose search integration: Richest result set (web, news, videos, discussions, FAQ, infobox, locations) in one call. For RAG/LLM grounding, prefer 
    llm-context
    .
  • Structured data extraction: Products, recipes, ratings, articles via 
    schemas
    and typed fields on results.
  • Custom search with Goggles: Unique to Brave. Boost/discard sites with inline rules or hosted Goggles for fully customized ranking.
  • 通用搜索集成：一次调用即可获取最丰富的结果集（网页、新闻、视频、讨论、FAQ、信息框、地点）。对于RAG/LLM事实校验，优先使用
    llm-context
    端点。
  • 结构化数据提取：通过
    schemas
    和结果中的类型字段提取产品、食谱、评分、文章等数据。
  • 基于Goggles的自定义搜索：Brave独有特性。通过内联规则或托管式Goggles提升/屏蔽站点，实现完全自定义的排序。

Notes

注意事项

  • Pagination: Use 
    offset
    (0-9) with 
    count
    to page through results
  • Count: Max 20 for web search; actual results may be less than requested
  • 分页：使用
    offset
    （0-9）配合
    count
    参数翻页查看结果
  • 结果数量：网页搜索最多支持20条结果；实际返回结果可能少于请求数量