> 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 guides

> Verify an official announcement with Search and Read, and inventory a help center with Map.

To verify an official announcement for a migration plan, find the announcement with `POST /v1/web/search` and check the passage with `POST /v1/web/read`. To inventory a help center, list the help center's links with `POST /v1/web/map`, then read the selected pages with `POST /v1/web/read`.

## Find the announcement and check which versions the announcement covers

1. **Search the official site.** Send the JSON below to `POST https://api.beatapi.io/v1/web/search` with BeatAPI Bearer authentication. Replace the example domain with the official site's domain.

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

2. **Read the notice.** Pick the notice that concerns the old version and pass the notice's full URL to `POST /v1/web/read`. Ask for the passages about the retirement date and scope:

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

3. **Record the evidence.** Find the supporting passage in `results[].content`. Record the URL, the publication date, the affected versions and the excerpt. If the notice says “next year,” use the notice's publication date to work out the year.
4. **Handle failures.** If a page fails, record the URL and the reason from `failed`, and look for another public source.

## Build a document list from the help center

1. Send `{"url":"https://example.com/help","limit":20,"max_depth":2}` to `POST /v1/web/map`.
2. Group the returned links by topic, and check selected pages with `POST /v1/web/read`.
3. Record the starting URL and the discovery depth in the document list. To look for omissions, compare the list with the site's public index or sitemap.

[Web Search API](/web-search) · [Web Search answers](/faq/web) · [BeatAPI pricing](https://beatapi.io/pricing)