> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.beatapi.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.beatapi.io/_mcp/server.

# Web Search指南

> 用 Search 和 Read 核对官方公告，用 Map 整理帮助中心的文档清单。

为迁移计划核对一条官方公告，用 `POST /v1/web/search` 找到公告，再用 `POST /v1/web/read` 核对原文。要整理一个帮助中心的主题清单，用 `POST /v1/web/map` 列出帮助中心的链接，再用 `POST /v1/web/read` 读选中的页面。

## 从官网找公告，核对日期与适用范围

1. **只搜官网。** 向 `POST https://api.beatapi.io/v1/web/search` 发送下面的 JSON，使用 BeatAPI Bearer 鉴权。把示例域名换成产品官网的域名。

```json
{"query":"API retirement date and affected versions","type":"web","include_domains":["example.com"],"max_results":5}
```

2. **读公告原文。** 从结果里选真正谈到旧版停用的公告，把公告的完整链接交给 `POST /v1/web/read`，只要停用日期和影响范围的段落：

```json
{"urls":["https://example.com/changelog/announcement"],"query":"retirement date and affected versions","format":"text"}
```

3. **记录证据。** 在 `results[].content` 里找原句。表里记 URL、公告日期、适用版本和支持结论的原句。公告只写「明年」时，用公告的发文日期推出具体年份。
4. **处理失败。** 某页读取失败时，记下 `failed` 里的 URL 和原因，再找另一条公开来源。

## 从帮助中心首页整理文档清单

1. 向 `POST /v1/web/map` 发送 `{"url":"https://example.com/help","limit":20,"max_depth":2}`。
2. 按主题整理返回的 URL，再挑几篇用 `POST /v1/web/read` 核对内容。
3. 文档清单的表头记起始页和发现深度。想补漏时，对照站点公开目录或 sitemap。

[网页搜索 API](/zh/web-search) · [网页搜索问题解答](/zh/faq/web) · [BeatAPI 价格页](https://beatapi.io/zh/pricing)