> ## 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.

# pipellm-websearch (npm)

> Install PipeLLM WebSearch from npm as an OpenClaw plugin

`pipellm-websearch` is the npm distribution for PipeLLM WebSearch as an
OpenClaw plugin. It adds search, page-reading, and news tools to OpenClaw while
using your PipeLLM API key for authentication and billing.

## Package

| Item         | Value                                                    |
| ------------ | -------------------------------------------------------- |
| Package name | `pipellm-websearch`                                      |
| Distribution | npm                                                      |
| Primary use  | OpenClaw plugin                                          |
| Repository   | `https://github.com/PipeLlm-AI/pipellm-websearch-plugin` |

## Install

```bash theme={null}
npm install pipellm-websearch
```

## What the Plugin Adds

| Tool                    | Description                                                   | Public route                  |
| ----------------------- | ------------------------------------------------------------- | ----------------------------- |
| `pipellm_web_search`    | Deep web search with content extraction and relevance ranking | `/v1/websearch/search`        |
| `pipellm_simple_search` | Faster search returning search snippets                       | `/v1/websearch/simple-search` |
| `pipellm_web_reader`    | Read a web page and return clean text                         | `/v1/websearch/reader`        |
| `pipellm_news_search`   | Search recent news with retrieval support                     | `/v1/websearch/search-news`   |

## OpenClaw Plugin Config

Add the package to your `openclaw.json`:

```json theme={null}
{
  "plugins": {
    "load": {
      "paths": ["./node_modules/pipellm-websearch"]
    },
    "entries": {
      "pipellm-websearch": {
        "enabled": true,
        "config": {
          "apiKey": "pipe-your-api-key-here"
        }
      }
    }
  }
}
```

## Agent Tool Allowlist

Enable the tools for your agent:

```json theme={null}
{
  "agents": {
    "list": [
      {
        "name": "my-agent",
        "tools": {
          "allow": [
            "pipellm_web_search",
            "pipellm_simple_search",
            "pipellm_web_reader",
            "pipellm_news_search"
          ]
        }
      }
    ]
  }
}
```

## Plugin Configuration

| Field         | Required | Default                  | Description                               |
| ------------- | -------- | ------------------------ | ----------------------------------------- |
| `apiKey`      | Yes      | —                        | PipeLLM API key                           |
| `apiEndpoint` | No       | `https://api.pipellm.ai` | Override only for self-hosted deployments |

## Notes

* This package is currently documented as an OpenClaw plugin, not a generic SDK.
* Use your PipeLLM API key from the Console.
* Search requests made through the plugin use PipeLLM WebSearch billing.

## Related Docs

<Columns cols={3}>
  <Card title="OpenClaw" icon="terminal" href="/integrations/openclaw">
    Configure OpenClaw to use PipeLLM
  </Card>

  <Card title="Deep Search" icon="magnifying-glass" href="/websearch/search-api">
    Use the full retrieval route over HTTP
  </Card>

  <Card title="npm Package" icon="box" href="https://www.npmjs.com/package/pipellm-websearch">
    View the package on npm
  </Card>
</Columns>