perplexity-webui-scraper
An advanced, high-performance Python client, MCP server, and REST API for reverse-engineering Perplexity AI's WebUI.
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Check it deeper on your machine
It has changed since its scan on 11 Nov 2026.
As a Claude Code plugin, install it and then ask Claude Code:
/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/henrique-coder/perplexity-webui-scraper with scanskillsafety
Or from a terminal, clone it and run it:
git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/henrique-coder/perplexity-webui-scraper'
It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.
Badge for your README
Markdown
[](/listings/henrique-coder--perplexity-webui-scraper)HTML
<a href="/listings/henrique-coder--perplexity-webui-scraper"><img src="/api/listings/henrique-coder--perplexity-webui-scraper/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
Install the package depending on your use case:
This project is distributed as a Python package on PyPI and as optional container images on GHCR. GitHub Releases contain the Python wheel and source distribution; native standalone executables are not published.
Core library
Install the core Python library without optional features.
uv add perplexity-webui-scraper
All optional features
Install the `cli`, `api`, and `mcp` extras together.
uv add "perplexity-webui-scraper[all]"
CLI tools
Install with terminal UX dependencies to use the interactive `chat` and `token` CLI commands.
uv add "perplexity-webui-scraper[cli]"
Servers
Install dependencies required for the MCP Server or the OpenAI-compatible REST API.
# MCP Server for AI agents uv add "perplexity-webui-scraper[mcp]" # OpenAI-compatible API server uv add "perplexity-webui-scraper[api]"
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
README.md · README · 280 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.
- <div align="center">
- <img src="https://raw.githubusercontent.com/henrique-coder/perplexity-webui-scraper/prod/docs/assets/icon.png" width="128" alt="Logo">
- # Perplexity WebUI Scraper
- Python scraper to extract AI responses from [Perplexity's](https://www.perplexity.ai) web interface.
- [](https://pypi.org/project/perplexity-webui-scraper)
- [](https://pypi.org/project/perplexity-webui-scraper)
- [](https://github.com/henrique-coder/perplexity-webui-scraper/blob/prod/LICENSE)
- </div>
- Documentation: [perplexity-webui-scraper.readthedocs.io](https://perplexity-webui-scraper.readthedocs.io)
- ## About
- This unofficial library uses undocumented Perplexity WebUI endpoints with a browser session token. It supports conversations, file uploads, and streaming; optional extras provide the MCP server and OpenAI-compatible REST API.
- A Perplexity account and its browser session token are required. Free accounts support text prompts; paid tiers are required for Pro/Max models and file uploads.
- Python 3.11 through 3.15 are supported. Python 3.15 is the primary runtime for direct end-user installations, API/MCP containers, and the local `.python-version` pin. CI quality, documentation, and package build jobs use Python 3.14. The unit-test matrix covers Python 3.11 through 3.15 across Linux, macOS, and Windows.
- ## Community
- - [Contributing guide](https://github.com/henrique-coder/perplexity-webui-scraper/blob/prod/CONTRIBUTING.md)
- - [Security policy](https://github.com/henrique-coder/perplexity-webui-scraper/blob/prod/SECURITY.md)
- - [Support guide](https://github.com/henrique-coder/perplexity-webui-scraper/blob/prod/SUPPORT.md)
- - [Code of conduct](https://github.com/henrique-coder/perplexity-webui-scraper/blob/prod/CODE_OF_CONDUCT.md)
- - [Discussions](https://github.com/henrique-coder/perplexity-webui-scraper/discussions)
- - [Sponsor the project](https://github.com/sponsors/henrique-coder)
- ## Installation
- The package is published to PyPI. API and MCP container images are published to GHCR. GitHub Releases include the wheel and source distribution; the project does not publish standalone executables.
- ### Core library
- Install the core Python library without optional features.
- ```bash
- uv add perplexity-webui-scraper
- ```
- ### CLI and server extras
- Install only the features you need. Use the `token`, `api`, and `mcp` extras individually or together.
- ```bash
- # Install from PyPI
- uv add 'perplexity-webui-scraper[token]' # Email token generator
- uv add 'perplexity-webui-scraper[api]' # REST API server
- uv add 'perplexity-webui-scraper[mcp]' # MCP server
- uv add 'perplexity-webui-scraper[all]' # All optional features
- ```
- ## Quick Start
- ### 1. Get your session token
- The base install does not include token-generation dependencies. Install the `token` extra first:
- ```bash
- uv add 'perplexity-webui-scraper[token]'
- uv run perplexity-webui-scraper token --email user@example.com
- ```
- The token command accepts an optional `--email` argument and prompts for an address when omitted. You can also retrieve `__Secure-next-auth.session-token` manually from your browser cookies on `perplexity.ai`.
- ### 2. Basic usage
- ```python
- from perplexity_webui_scraper import Perplexity
- client = Perplexity(session_token="YOUR_TOKEN")
- conversation = client.create_conversation()
- print(client.get_account_profile().account_tier)
- conversation.ask("What is quantum computing?")
- print(conversation.answer)
- # Follow-ups preserve context automatically
- conversation.ask("Explain it simpler")
- print(conversation.answer)
- ```
- Before each prompt, the library checks `/api/auth/session` and raises `ModelAccessError` if an `available` model requires a higher tier than the authenticated account. When the session payload does not expose enough subscription data, it falls back to `/rest/user/settings`. Models use one of three statuses: `available` (confirmed working normally), `unknown` (not yet verified, including custom identifiers), or `unavailable` (confirmed not working). `is_official` separately records whether a model is listed in Perplexity's official WebUI. `last_tested_at` records the last test in ISO 8601 UTC and is `null` for untested models. Any non-available status requires `allow_risky_model=True`; after acknowledgement, the backend makes the final entitlement decision. Free accounts can use text prompts, but file attachments raise `FileAccessError`.
- `perplexity/best` adapts to the account tier: free accounts use Perplexity's internal `turbo` preference, while Pro/Max accounts use `pplx_pro_upgraded`; both use `copilot` mode.
- ### 3. Streaming
- ```python
- printed = ""
- for response in conversation.ask("Explain AI", stream=True):
- current = response.answer or "".join(response.chunks)
- if current.startswith(printed):
- delta = current[len(printed) :]
- print(delta, end="", flush=True)
- printed = current
- elif current:
- printed = current
- print(f"\r{printed}", end="", flush=True)
- ```
- ### 4. Choose a model
- ```python
- from perplexity_webui_scraper import ConversationConfig
- conversation = client.create_conversation(ConversationConfig(model="perplexity/best"))
- conversation.ask("Solve this step by step: ...")
- print(conversation.answer)
- ```
- ### 5. List registered models
- ```python
- from perplexity_webui_scraper import MODELS
- for model in MODELS.list_all():
- print(f"{model.id:40} {model.name}")
- ```
- ## CLI commands
- Use `-h` or `--help` with the root command or any subcommand. The token command accepts `-e` or `--email`.
- | Command | Extra | Description |
- | ------------------------------------------------- | ------- | ---------------------------------------------------------------------- |
- | `perplexity-webui-scraper token -e/--email EMAIL` | `token` | Generate a session token through email authentication (including TOTP) |
- | `perplexity-webui-scraper api` | `api` | Start the OpenAI-compatible REST API server |
- | `perplexity-webui-scraper mcp` | `mcp` | Start the MCP server |
- ## OpenAI-compatible API
- Run a local server that accepts the supported subset of OpenAI Responses and legacy Chat Completions requests. Both routes use the same Perplexity conversation core. The Responses route accepts text and base64 data-URL images, supports streaming and process-local `previous_response_id` continuation, and rejects unsupported request fields. Tool execution, durable response retrieval, and remote image fetching are not implemented.
- ```bash
- # Start with clients supplying their Perplexity token per request
- perplexity-webui-scraper api
- # Optional server-default upstream token, protected by a separate gateway key
- PERPLEXITY_SESSION_TOKEN="$PPLX_TOKEN" PERPLEXITY_API_KEY="$GATEWAY_KEY" perplexity-webui-scraper api
- # Custom host and port
- perplexity-webui-scraper api --host 0.0.0.0 --port 8080
- # Development mode with auto-reload
- perplexity-webui-scraper api --reload
- ```
- ### Container deployment with Podman
- ```bash
- # Pull the published multi-arch API image
- podman pull ghcr.io/henrique-coder/perplexity-webui-scraper:latest
- # Run the server (exposing port 8000)
- podman run --rm -p 8000:8000 ghcr.io/henrique-coder/perplexity-webui-scraper:latest
- ```
- Optional MCP image for containerized stdio setups:
- ```bash
- # Pull the published multi-arch MCP image
- podman pull ghcr.io/henrique-coder/perplexity-webui-scraper:mcp
- # Run MCP server (requires token)
- podman run --rm -e PERPLEXITY_SESSION_TOKEN=your_token ghcr.io/henrique-coder/perplexity-webui-scraper:mcp
- ```
- For local development, you can still build the provided container files:
- ```bash
- # API image: installs the `api` extra, exposes port 8000, and starts the REST server.
- podman build -t perplexity-api -f Containerfile .
- podman run --rm -it -p 8000:8000 perplexity-api
- # MCP image: installs the `mcp` extra and starts the stdio MCP server. It does not expose an HTTP port.
- podman build -t perplexity-mcp -f Containerfile.mcp .
- podman run --rm -it -e PERPLEXITY_SESSION_TOKEN=your_token perplexity-mcp
- ```
- ### CLI options
- | Option | Short | Default | Description |
- | ------------- | ----- | ----------- | ------------------------------------- |
- | `--host` | `-H` | `127.0.0.1` | Bind address |
- | `--port` | `-p` | `8000` | Port to listen on |
- | `--reload` | | `False` | Enable auto-reload (development only) |
- | `--log-level` | | `info` | Uvicorn log level |
- ### Authentication
- Without a server-default token, send your Perplexity token as `Authorization: Bearer $PERPLEXITY_SESSION_TOKEN`. When `PERPLEXITY_SESSION_TOKEN` is configured on the server, requests may omit `Authorization` but must include the separate gateway key in `X-API-Key`. A caller Bearer token overrides the server default, but gateway authentication is still required.
- ```bash
- # curl
- export PERPLEXITY_SESSION_TOKEN='your_session_token'
- curl http://localhost:8000/v1/chat/completions \
- -H 'Authorization: Bearer $PERPLEXITY_SESSION_TOKEN' \
- -H 'Content-Type: application/json' \
- -d '{"model": "perplexity/best", "messages": [{"role": "user", "content": "Hello!"}]}'
- # Streaming
- curl -N http://localhost:8000/v1/chat/completions \
- -H 'Authorization: Bearer $PERPLEXITY_SESSION_TOKEN' \
- -H 'Content-Type: application/json' \
- -d '{"model": "perplexity/best", "messages": [{"role": "user", "content": "Hello!"}], "stream": true}'
- ```
- ```python
- from openai import OpenAI
- client = OpenAI(
- base_url="http://localhost:8000/v1",
- api_key="YOUR_SESSION_TOKEN", # sent as Authorization: Bearer automatically
- )
- response = client.chat.completions.create(
- model="perplexity/best",
- messages=[{"role": "user", "content": "Hello!"}],
- )
- print(response.choices[0].message.content)
- ```
- Responses API request with server-configured upstream credentials:
- ```bash
- curl http://localhost:8000/v1/responses \
- -H 'X-API-Key: $GATEWAY_KEY' \
- -H 'Content-Type: application/json' \
- -d '{"model":"perplexity/best","input":"Hello!"}'
- ```
- ### API endpoints
- | Method | Path | Description |
- | ------ | ---------------------- | ------------------------------------------------------------------- |
- | `GET` | `/v1/models` | List registered models |
- | `POST` | `/v1/responses` | Responses text and base64 image input (streaming and non-streaming) |
- | `POST` | `/v1/chat/completions` | Legacy Chat Completions (streaming and non-streaming) |
- | `GET` | `/docs` | Interactive Swagger UI |
- | `GET` | `/redoc` | ReDoc API documentation |
- > Chat Completions accepts and ignores some unsupported OpenAI fields. Responses rejects unknown request fields. Neither route implements the full OpenAI API.
- ### `POST /v1/responses`
- The Responses route accepts `model`, `input`, `instructions`, `stream`, `previous_response_id`, and the `perplexity` extension object. It accepts a string input or supported text and base64 image items. Unknown request fields and unsupported input item types return `422`. Tool execution, durable response retrieval, and token-usage accounting are not implemented. Continuation IDs map to an in-memory conversation thread and expire with the process-local cache.
- ## MCP server
- Expose every Perplexity model as a separate tool for AI agents (Claude Desktop, Antigravity, etc.):
- ```json
- {
- "mcpServers": {
- "perplexity-webui-scraper": {
- "command": "uvx",
- "args": [
- "--from",
- "perplexity-webui-scraper[mcp]",
- "perplexity-webui-scraper",
- "mcp"
- ],
- "env": { "PERPLEXITY_SESSION_TOKEN": "your_token_here" }
- }
- }
- }
- ```
- See the [MCP documentation](https://perplexity-webui-scraper.readthedocs.io/page/mcp-server/) for tools and configuration.
- ## Disclaimer
- This is an **unofficial** library. It uses internal APIs that may change without notice. Use at your own risk. By using this library, you agree to Perplexity AI's [Terms of Service](https://www.perplexity.ai/hub/legal/terms-of-service).
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.