> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pipellm.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> PipeLLM WebSearch is a standalone search and retrieval product surface for developers and agents

PipeLLM WebSearch is a standalone product surface for real-time search,
retrieval, and page reading. It can be used directly through PipeLLM's public
API or installed as the `pipellm-websearch` npm package for OpenClaw.

## What WebSearch Includes

| Surface     | What it is for                                            |
| ----------- | --------------------------------------------------------- |
| Search API  | Call PipeLLM WebSearch over HTTP from your app or backend |
| npm package | Install PipeLLM WebSearch as an OpenClaw plugin from npm  |

## Core Capabilities

* real-time web search through PipeLLM-managed retrieval
* optional rich page context in search results
* page reading and news-search tools through the OpenClaw plugin
* per-request billing with the same PipeLLM API key used across your account

## Authentication

Use the same PipeLLM API key you use for the rest of the platform:

```text theme={null}
Authorization: Bearer $PIPELLM_API_KEY
```

## Public Routes

PipeLLM Gateway currently exposes four public WebSearch routes:

| Route                             | Purpose                                     | Query parameter |
| --------------------------------- | ------------------------------------------- | --------------- |
| `GET /v1/websearch/search`        | Deep search with retrieval and reranking    | `q`             |
| `GET /v1/websearch/simple-search` | Fast search snippets without RAG enrichment | `q`             |
| `GET /v1/websearch/reader`        | Read a page and return clean text           | `url`           |
| `GET /v1/websearch/search-news`   | News search with retrieval and reranking    | `q`             |

These routes are proxy endpoints on the public gateway and map to the internal
WebSearch service allowlist.

## Pricing

Current WebSearch pricing is billed per successful request:

| Item              | Price  |
| ----------------- | ------ |
| WebSearch request | \$0.05 |

<Note>
  WebSearch requests share your account-level authentication and are billed as a
  separate product surface from model generation endpoints.
</Note>

## Route Matrix

| Public route                  | Internal service route | Notes                                     |
| ----------------------------- | ---------------------- | ----------------------------------------- |
| `/v1/websearch/search`        | `/api/search`          | Full search + content extraction + rerank |
| `/v1/websearch/simple-search` | `/api/simple-search`   | Serper search only                        |
| `/v1/websearch/reader`        | `/api/reader`          | Read one page by URL                      |
| `/v1/websearch/search-news`   | `/api/search-news`     | News search + content extraction + rerank |

## Start Here

<Columns cols={3}>
  <Card title="Deep Search" icon="magnifying-glass" href="/websearch/search-api">
    Full search with content extraction and reranking
  </Card>

  <Card title="Simple Search" icon="bolt" href="/websearch/simple-search">
    Fast search snippets without deep retrieval
  </Card>

  <Card title="Reader" icon="book" href="/websearch/reader">
    Read a page and convert it to clean text
  </Card>

  <Card title="News Search" icon="newspaper" href="/websearch/news-search">
    Search recent news with retrieval support
  </Card>

  <Card title="pipellm-websearch (npm)" icon="box" href="/websearch/npm-package">
    Install the OpenClaw plugin from npm
  </Card>

  <Card title="OpenClaw" icon="terminal" href="/integrations/openclaw">
    Connect coding agents to PipeLLM and WebSearch
  </Card>
</Columns>