Reader

Use this route when you already know the page URL and want PipeLLM WebSearch to fetch and convert it into clean text.

Endpoint

Method	Endpoint
`GET`	`https://api.pipellm.ai/v1/websearch/reader`

Authentication

Authorization: Bearer $PIPELLM_API_KEY

Query Parameters

Parameter	Type	Required	Description
`url`	string	Yes	The page URL to read

Example Request

curl -X GET "https://api.pipellm.ai/v1/websearch/reader?url=https://go.dev" \
  -H "Authorization: Bearer $PIPELLM_API_KEY"

Response Shape

{
  "code": 200,
  "message": "ok",
  "content": "# The Go Programming Language\n\nGo is an open source programming language..."
}

Error Shape

{
  "code": 400,
  "message": "url parameter is required"
}

Notes

This route proxies to the internal /api/reader handler.
The response shape uses content instead of data.
The reader path is also the most direct HTTP equivalent of pipellm_web_reader.

pipellm-websearch (npm)

Enable page-reading as an OpenClaw tool

Deep Search

Use search first when you do not already know the target page

WebSearch Overview

Product overview and route matrix

Simple Search News Search

Overview

Reference

Packages

Endpoint

Authentication

Query Parameters

Example Request

Response Shape

Error Shape

Notes

pipellm-websearch (npm)

Deep Search

WebSearch Overview

​Endpoint

​Authentication

​Query Parameters

​Example Request

​Response Shape

​Error Shape

​Notes

​Related Docs

pipellm-websearch (npm)

Deep Search

WebSearch Overview

Endpoint

Authentication

Query Parameters

Example Request

Response Shape

Error Shape

Notes

Related Docs