@tanstack/ai-perplexity weekly downloads statistics

@tanstack/ai-perplexity

Perplexity Search API for TanStack AI.

Wraps POST https://api.perplexity.ai/search as a tool (and a low-level HTTP client) so an agent can fetch ranked web results (title, url, snippet, date?, last_updated?) for grounding.

This package does not ship a TanStack text adapter. Pair the search tool with a function-calling adapter such as openaiText. For Sonar chat(), use openaiCompatible from @tanstack/ai-openai/compatible — Sonar already searches the web and does not accept custom tools.

Install

Set your API key (get one at ):

Search tool

The tool input schema accepts:

| field | type | notes |

| query | string (required) | The search query. | | max_results | integer (1–20) | Defaults to defaultMaxResults when set, otherwise the API default (10). | | search_domain_filter | string[] | Max 20. Allowlist ("nytimes.com") or denylist ("-pinterest.com") — never both. | | search_recency_filter | "hour" \| "day" \| "week" \| "month" \| "year" | Recency window. | | search_after_date_filter | string | m/d/yyyy — only results on/after this date. | | search_before_date_filter | string | m/d/yyyy — only results on/before this date. |

Output: { results: Array }.

Direct client usage

Chat (Sonar)

Use openaiCompatible from @tanstack/ai-openai/compatible. Do not pass perplexitySearchTool here. Pass getPerplexityIntegrationHeaders() if you want the same X-Pplx-Integration attribution header the Search client sends automatically.

Docs

• Search quickstart: • Search API reference: • Domain filters: • Date / recency filters:

Description from the npm listing.