# Docs Change Monitor for AI (`careybrown/docs-change-rag-ready-monitor`) Actor Monitor public docs, changelogs, help centers, status pages, and pricing pages for changes, then output clean Markdown and RAG-ready chunks for AI knowledge bases. - **URL**: https://apify.com/careybrown/docs-change-rag-ready-monitor.md - **Developed by:** [Carey Brown](https://apify.com/careybrown) (community) - **Categories:** AI, Developer tools, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## 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 ## Docs Change Monitor for AI Monitor public documentation, changelog, help-center, status, pricing, and product-update pages for changes, then emit stable Markdown and RAG-ready chunks for AI knowledge bases. ### Local MVP status This package is a fixture-first local MVP. It proves the input schema, dataset schema, state model, diffing, hashing, and chunking behavior without crawling live websites. The MVP intentionally does not perform network fetches. Live website crawling, Apify cloud runs, Store metadata, pricing, visibility, browser/proxy modes, credentials, webhooks, paid APIs, and source expansion require a separate approval packet. ### Output records - `page_snapshot`: cleaned page metadata, Markdown, hashes, and chunk count - `change_event`: baseline/changed/unchanged/error event with diff snippets and RAG chunks - `run_summary`: aggregate source-health and limit summary ### Local validation ```bash python3 scripts/readiness_check.py python3 scripts/run_actor_local.py examples/input_default.json ```` Both commands use local fixture HTML only. # Actor input Schema ## `startUrls` (type: `array`): Public pages to monitor. MVP local validation requires matching fixturePages entries and does not fetch the network. ## `fixturePages` (type: `object`): Local MVP fixture HTML keyed by URL. This exists for offline validation only; live fetching remains approval-gated. ## `previousSnapshots` (type: `object`): Optional prior snapshot state keyed by URL for local diff validation. ## `chunkSizeChars` (type: `integer`): Approximate character size for RAG chunks. ## `chunkOverlapChars` (type: `integer`): Character overlap between adjacent chunks. ## `changeThresholdRatio` (type: `number`): Minimum approximate text-change ratio for changed events. ## `emitUnchangedPages` (type: `boolean`): Include unchanged page events in output. ## `emitBaselinePages` (type: `boolean`): Include first-run baseline records in output. ## `respectRobotsTxt` (type: `boolean`): Recorded in output source metadata. MVP does not fetch robots.txt. ## `maxPages` (type: `integer`): Maximum pages to process from startUrls in this local MVP. ## `networkMode` (type: `string`): MVP supports fixture-only validation. Live network fetching requires a later approval packet. ## `maxRequests` (type: `integer`): Maximum HTTP requests for approved local live\_fetch validation. Includes robots.txt checks. ## `requestDelayMs` (type: `integer`): Delay between live\_fetch HTTP requests in milliseconds. ## `requestTimeoutSecs` (type: `integer`): Timeout for each live\_fetch HTTP request in seconds. ## Actor input object example ```json { "startUrls": [ { "url": "https://example.com/docs/overview", "label": "Example Docs", "pageType": "docs" } ], "fixturePages": {}, "previousSnapshots": {}, "chunkSizeChars": 1800, "chunkOverlapChars": 200, "changeThresholdRatio": 0.02, "emitUnchangedPages": false, "emitBaselinePages": true, "respectRobotsTxt": true, "maxPages": 25, "networkMode": "fixtures_only", "maxRequests": 12, "requestDelayMs": 1000, "requestTimeoutSecs": 20 } ``` # Actor output Schema ## `results` (type: `string`): Page snapshots, change events, and run summaries. ## `runSummary` (type: `string`): Machine-readable summary for the latest run. ## `state` (type: `string`): State blob that can be supplied as previousSnapshots on a later fixture run. # 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 = {}; // Run the Actor and wait for it to finish const run = await client.actor("careybrown/docs-change-rag-ready-monitor").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 = {} # Run the Actor and wait for it to finish run = client.actor("careybrown/docs-change-rag-ready-monitor").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 '{}' | apify call careybrown/docs-change-rag-ready-monitor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=careybrown/docs-change-rag-ready-monitor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Docs Change Monitor for AI", "description": "Monitor public docs, changelogs, help centers, status pages, and pricing pages for changes, then output clean Markdown and RAG-ready chunks for AI knowledge bases.", "version": "0.1", "x-build-id": "lxikhEKZkVhnrvPQ2" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/careybrown~docs-change-rag-ready-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-careybrown-docs-change-rag-ready-monitor", "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/careybrown~docs-change-rag-ready-monitor/runs": { "post": { "operationId": "runs-sync-careybrown-docs-change-rag-ready-monitor", "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/careybrown~docs-change-rag-ready-monitor/run-sync": { "post": { "operationId": "run-sync-careybrown-docs-change-rag-ready-monitor", "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": [ "startUrls" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Public pages to monitor. MVP local validation requires matching fixturePages entries and does not fetch the network.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "title": "URL", "type": "string", "description": "Public page URL to monitor." }, "label": { "title": "Label", "type": "string", "description": "Optional readable label for the page." }, "pageType": { "title": "Page Type", "type": "string", "description": "Optional page classification.", "enum": [ "docs", "changelog", "help_center", "status", "pricing", "policy", "product_update", "other" ] } } }, "default": [ { "url": "https://example.com/docs/overview", "label": "Example Docs", "pageType": "docs" } ] }, "fixturePages": { "title": "Fixture Pages", "type": "object", "description": "Local MVP fixture HTML keyed by URL. This exists for offline validation only; live fetching remains approval-gated.", "default": {} }, "previousSnapshots": { "title": "Previous Snapshots", "type": "object", "description": "Optional prior snapshot state keyed by URL for local diff validation.", "default": {} }, "chunkSizeChars": { "title": "Chunk Size", "minimum": 500, "maximum": 5000, "type": "integer", "description": "Approximate character size for RAG chunks.", "default": 1800 }, "chunkOverlapChars": { "title": "Chunk Overlap", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Character overlap between adjacent chunks.", "default": 200 }, "changeThresholdRatio": { "title": "Change Threshold Ratio", "minimum": 0, "maximum": 1, "type": "number", "description": "Minimum approximate text-change ratio for changed events.", "default": 0.02 }, "emitUnchangedPages": { "title": "Emit Unchanged Pages", "type": "boolean", "description": "Include unchanged page events in output.", "default": false }, "emitBaselinePages": { "title": "Emit Baseline Pages", "type": "boolean", "description": "Include first-run baseline records in output.", "default": true }, "respectRobotsTxt": { "title": "Respect Robots.txt", "type": "boolean", "description": "Recorded in output source metadata. MVP does not fetch robots.txt.", "default": true }, "maxPages": { "title": "Maximum Pages", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum pages to process from startUrls in this local MVP.", "default": 25 }, "networkMode": { "title": "Network Mode", "enum": [ "fixtures_only", "live_fetch" ], "type": "string", "description": "MVP supports fixture-only validation. Live network fetching requires a later approval packet.", "default": "fixtures_only" }, "maxRequests": { "title": "Maximum HTTP Requests", "minimum": 1, "maximum": 12, "type": "integer", "description": "Maximum HTTP requests for approved local live_fetch validation. Includes robots.txt checks.", "default": 12 }, "requestDelayMs": { "title": "Request Delay", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Delay between live_fetch HTTP requests in milliseconds.", "default": 1000 }, "requestTimeoutSecs": { "title": "Request Timeout", "minimum": 1, "maximum": 60, "type": "integer", "description": "Timeout for each live_fetch HTTP request in seconds.", "default": 20 } } }, "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 } } } } } } } } } } ```