Skip to main content

llama-index-readers-wellmarked

The official LlamaIndex reader for WellMarked — load any URL as clean Markdown Documents.

pip install llama-index-readers-wellmarked

Quick start

Set your API key (get one at wellmarked.io):

export WELLMARKED_API_KEY="wm_..."

Load a single page:

from llama_index.readers.wellmarked import WellMarkedReader

reader = WellMarkedReader()
docs = reader.load_data("https://example.com/article")

docs[0].text       # clean Markdown
docs[0].metadata   # {"source": ..., "title": ..., "author": ..., "retrieved_at": ...}

Or crawl a whole site BFS-style — one Document per successfully extracted page (Pro plan and above):

reader = WellMarkedReader(mode="crawl", depth=2)
docs = reader.load_data("https://docs.example.com")

docs[0].metadata["depth"]   # how far from the root URL this page sits

Drop the documents straight into an index:

from llama_index.core import VectorStoreIndex

index = VectorStoreIndex.from_documents(docs)

Options

All options are constructor arguments; load_data(url) takes only the URL.

Parameter Default Description
api_key env var WellMarked API key; falls back to WELLMARKED_API_KEY
mode "extract" "extract" (single page) or "crawl" (same-site BFS)
depth 1 Crawl depth (mode="crawl" only)
render_js False Render JS-heavy pages with a headless browser (Pro and above)
job_timeout 300.0 Seconds to wait for a crawl job; None waits forever

In crawl mode, pages that fail to extract (timeouts, robots-disallowed, no content) are skipped; only successful pages become Documents.

Related

Metadata

Release files for llama-index-readers-wellmarked 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for llama-index-readers-wellmarked 0.1.0
File Size Uploaded Provenance Actions
llama_index_readers_wellmarked-0.1.0.tar.gz 4.7 kB With provenance Details for llama_index_readers_wellmarked-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for llama-index-readers-wellmarked 0.1.0
File Interpreter ABI Platform Actions
llama_index_readers_wellmarked-0.1.0-py3-none-any.whl Python 3 none any Details for llama_index_readers_wellmarked-0.1.0-py3-none-any.whl

Total release size: 10.5 kB

Release files / llama_index_readers_wellmarked-0.1.0.tar.gz

Download URL llama_index_readers_wellmarked-0.1.0.tar.gz
Size 4.7 kB
Tags Source
SHA-256 checksum
How to use checksums
ea9739728ade4c4c113617ac06b5bb503b1b8a67d2b576a7f8b1ef69a185e7f4
BLAKE2b-256 checksum
How to use checksums
60adc3aa162fe361992cde4a8013c579b583ff864053bccc07d3328e410afd9f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 23, 2026.

Transparency log

Release files / llama_index_readers_wellmarked-0.1.0-py3-none-any.whl

Download URL llama_index_readers_wellmarked-0.1.0-py3-none-any.whl
Size 5.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a13fd8b7cb05a9ad857bbbed72c6a22e6353c4f0962bae1c0ab0e868e1fa917d
BLAKE2b-256 checksum
How to use checksums
8b9d30343d6ac4ac41f675db96dd32114695b0e1f93928251221a99f02bfa6dc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 23, 2026.

Transparency log

Security for llama-index-readers-wellmarked 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for llama_index_readers_wellmarked-0.1.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jul 23, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page