# 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, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $2.00 / 1,000 results 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 a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. 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. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use 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://example.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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "sitemap_url": "https://example.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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "sitemap_url": "https://example.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://example.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 " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Website to RAG Knowledge Dataset", "description": "Convert a website sitemap into clean text and markdown rows for RAG, AI search, chatbots, and knowledge base workflows.", "version": "0.1", "x-build-id": "eWgHxfVIbVodjOnEq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ghostgrid~website-to-rag-knowledge-dataset/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ghostgrid-website-to-rag-knowledge-dataset", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/ghostgrid~website-to-rag-knowledge-dataset/runs": { "post": { "operationId": "runs-sync-ghostgrid-website-to-rag-knowledge-dataset", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/ghostgrid~website-to-rag-knowledge-dataset/run-sync": { "post": { "operationId": "run-sync-ghostgrid-website-to-rag-knowledge-dataset", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "sitemap_url" ], "properties": { "sitemap_url": { "title": "Sitemap URL", "type": "string", "description": "URL to a sitemap.xml file or a website homepage (we will auto-detect the sitemap)." }, "max_pages": { "title": "Max Pages", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of pages to crawl from the sitemap.", "default": 100 }, "include_linked_pages": { "title": "Include Linked Pages", "type": "boolean", "description": "Also crawl same-domain pages linked from sitemap pages, up to Max Pages.", "default": false } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```