chore: deprecate SearchApiWebSearch + update docs

[julian-risch]

Related Issues

• part of https://github.com/deepset-ai/haystack-private/issues/370

Proposed Changes:

• deprecate SearchApiWebSearch with a FutureWarning pointing users to the new searchapi-haystack package (feat: add searchapi integration (moved from Haystack core) haystack-core-integrations#3437)
• update the docs page (current and version-2.30) to show the new package name, install command, and import path
• fix the docstring usage example, which wrongly referenced SERPERDEV_API_KEY instead of SEARCHAPI_API_KEY
• make the live-API integration test assertions robust: when SearchApi returns an answer box or knowledge graph, documents and links (organic results only) differ in length, so the old len(documents) == len(links) == 10 assertion fails on main today (same fix as for SerperDev in chore: deprecate SerperDevWebSearch + update docs #11577)

How did you test it?

• hatch run test:integration test/components/websearch/test_searchapi.py with a real SEARCHAPI_API_KEY locally (we don't have one set in the CI in haystack. only in haystack-core-integrations): 2 passed (failed before the assertion fix)

Notes for the reviewer

• Merge order: the Vercel docs build will fail with broken links to /reference/integrations-searchapi until the API reference page is added by the Docusaurus sync workflow when integrations/searchapi-v0.1.0 is tagged in haystack-core-integrations. Once that sync PR lands on main, rebasing this branch turns the docs build green — same process as the SerperDev (chore: deprecate SerperDevWebSearch + update docs #11577) and HuggingFace API (chore: deprecate HF API components + update docs #11513) migrations.

Checklist

• I have read the contributors guidelines and the code of conduct.
• I have updated the related issue with new insights and changes.
• I have added unit tests and updated the docstrings.
• I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
• I have documented my code.
• I have added a release note file, following the contributors guidelines.
• I have run pre-commit hooks and fixed any issue.

🤖 Generated with Claude Code

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
haystack-docs	Error		Jun 12, 2026 2:44pm