# Website to RAG Knowledge Dataset (`ghostgrid/website-to-rag-knowledge-dataset`) Actor

Convert a website sitemap into clean text and markdown rows for RAG, AI search, chatbots, and knowledge base workflows.

- **URL**: https://apify.com/ghostgrid/website-to-rag-knowledge-dataset.md
- **Developed by:** [GhostGrid](https://apify.com/ghostgrid) (community)
- **Categories:** AI, Developer tools, SEO tools
- **Stats:** 2 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.80 / 1,000 page extracteds

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Website to RAG Knowledge Dataset

Convert a public website sitemap into clean text and markdown rows for RAG, AI search, chatbot, and knowledge base workflows.

This actor is built for teams that need website content in a predictable dataset format instead of a pile of noisy HTML.

### What It Does

- Finds URLs from a sitemap or homepage
- Supports sitemap indexes, gzipped sitemaps, and robots.txt sitemap discovery
- Crawls each page and removes common navigation, footer, sidebar, comment, ad, and cookie banner content
- Extracts clean plain text and markdown
- Captures metadata such as title, description, keywords, canonical URL, and Open Graph image
- Detects page language with lightweight page signals
- Counts words for filtering and chunking decisions
- Optionally adds same-domain pages linked from sitemap pages

### Common Use Cases

- Prepare public documentation for a RAG pipeline
- Build a website knowledge base for a support chatbot
- Export clean website content for AI search
- Audit page titles, metadata, and content coverage
- Create a repeatable dataset for scheduled website content refreshes

### Input

| Parameter | Type | Default | Description |
|---|---|---|---|
| `sitemap_url` | string | Required | URL to a sitemap.xml file or a website homepage |
| `max_pages` | integer | 100 | Maximum number of pages to crawl |
| `include_linked_pages` | boolean | false | Also add same-domain pages linked from sitemap pages, up to `max_pages` |

### Output

Each successful page creates one dataset item.

| Field | Type | Description |
|---|---|---|
| `url` | string | Page URL |
| `title` | string | Page title |
| `text` | string | Clean main content as plain text |
| `markdown` | string | Clean main content as markdown |
| `metadata` | object | Description, keywords, Open Graph image, and canonical URL |
| `crawled_at` | string | ISO timestamp |
| `word_count` | integer | Number of extracted words |
| `language` | string | Detected language code |

### Example Input

```json
{
  "sitemap_url": "https://docs.apify.com/sitemap.xml",
  "max_pages": 25,
  "include_linked_pages": false
}
```

### Recommended Pricing

Use pay per event pricing.

Suggested launch price:

- Actor start: free or near free
- Dataset item: `$0.0015` to `$0.0025` per extracted page

Start at `$0.002` per extracted page if Apify allows that exact value. This keeps small tests cheap and makes scheduled knowledge base refreshes a natural recurring use case.

### Notes

This actor extracts content from public pages. It does not bypass logins, paywalls, or access controls.

# Actor input Schema

## `sitemap_url` (type: `string`):

URL to a sitemap.xml file or a website homepage (we will auto-detect the sitemap).

## `max_pages` (type: `integer`):

Maximum number of pages to crawl from the sitemap.

## `include_linked_pages` (type: `boolean`):

Also crawl same-domain pages linked from sitemap pages, up to Max Pages.

## Actor input object example

```json
{
  "sitemap_url": "https://apify.com/sitemap.xml",
  "max_pages": 100,
  "include_linked_pages": false
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "sitemap_url": "https://apify.com/sitemap.xml"
};

// Run the Actor and wait for it to finish
const run = await client.actor("ghostgrid/website-to-rag-knowledge-dataset").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "sitemap_url": "https://apify.com/sitemap.xml" }

# Run the Actor and wait for it to finish
run = client.actor("ghostgrid/website-to-rag-knowledge-dataset").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "sitemap_url": "https://apify.com/sitemap.xml"
}' |
apify call ghostgrid/website-to-rag-knowledge-dataset --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=ghostgrid/website-to-rag-knowledge-dataset",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/acts/hjJdbPbZaGSWte1mj/builds/Q2mbDHrmuYKSYXjkK/openapi.json