# RAG Corpus Provenance Packager (`flintglade/rag-corpus-provenance-packager`) Actor Package rights-declared HTML, Markdown, text, and born-digital PDFs into deterministic RAG pages, traceable chunks, and verified manifests. - **URL**: https://apify.com/flintglade/rag-corpus-provenance-packager.md - **Developed by:** [Flintglade](https://apify.com/flintglade) (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 from $20.00 / 1,000 packaged pages 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/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.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/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 ## RAG Corpus Provenance Packager Turn explicit, rights-declared HTML, Markdown, text, and born-digital PDF sources into deterministic, deduplicated corpus pages, traceable chunks, and a portable evidence package. ### What this does not do - No open-web crawling or link following. - No paywall or authentication bypass. - No OCR in version 1. - No vector embedding generation. - No legal conclusion about reuse rights. - No LLM summaries or synthetic citations. - No billing by both page and chunk. ### Sources and authorization Every source must be one explicit HTTPS URL or one record from an Apify key-value store you can read. Every source also requires a `rightsBasis` declaration with evidence text or an evidence URL. The declaration and any detected indicators are preserved as provenance; they are not legal advice and do not establish permission. A `metadata_only` declaration is refused because this Actor's output contains source text. HTML uses direct HTTP responses only. Markdown and plain text must be UTF-8 or UTF-16. PDFs must contain extractable text; image-only pages return an uncharged `ocr_required` result. HTML selectors are explicit and bounded. The Actor never follows links discovered in a source. ### Input example ```json { "sources": [ { "url": "https://flintglade-tools.github.io/apify-fixtures/rag/sample.html", "rightsBasis": { "type": "user_owned", "evidence": "Flintglade-controlled public fixture" }, "formatHint": "html", "excludeSelectors": ["footer"] } ], "chunking": {"strategy": "character", "size": 1000, "overlap": 150}, "dedupe": {"mode": "exact"}, "retainRaw": false, "concurrency": 1 } ```` ### Outputs The default dataset contains one result per page plus one uncharged run summary. Admitted pages include stable document/page IDs, canonical and raw hashes, rights evidence, extraction indicators, chunk IDs, and invalidation links. Exact duplicates and refusals remain visible but uncharged. Child chunks are written to a run-specific named dataset and are included in the page price. Every chunk carries its page and document IDs, source and page locators, character range, text hash, rights declaration, and chunker version. The default key-value store receives: - `CORPUS_MANIFEST.json` - `EXTRACTED_DOCUMENT.jsonl` - `CORPUS_PACKAGE.zip` - `VERIFICATION.json` - `ARTIFACT_MANIFEST.json` - generated `RAW_SOURCE_*` records only when `retainRaw` is explicitly enabled Example admitted page fields: ```json { "status": "ok", "charge": {"event": "packaged-page", "chargeable": true}, "data": { "pageId": "page_...", "canonicalHash": "sha256:...", "chunkCount": 2, "duplicateOfPageId": null, "rightsBasis": {"type": "user_owned", "evidence": "Flintglade-controlled public fixture"} } } ``` ### Pricing `packaged-page` costs **$0.02 per admitted source page**. Generated chunks are included and are never charged separately. For example, three admitted pages cost $0.06 in Actor events, plus Apify platform usage. Blocked URLs, source outages, unsupported media, oversized sources, parse failures, rights refusals, OCR-required pages, exact duplicates after the first page, and charge-limit rows are uncharged. ### Baseline behavior Without `baselineStoreId`, each run is stateless. With an existing authorized KVS, admitted pages compare their canonical hash to the prior page record and report `baseline_created`, `unchanged`, or `changed`. Changed pages list the superseded hash and prior chunk IDs. Baseline state is committed only after Apify confirms the paid page event, and a concurrent baseline change is preserved rather than overwritten. ### Limits At most 100 sources, 50 MB per source, 2,000 PDF pages per run, and 250,000 chunks per run. Configured source concurrency is bounded to four; the runtime may reduce it to one so the next source is not scheduled after the paid-event budget is exhausted. The run timeout is 900 seconds, with 2 GB default memory. ### Support See [SUPPORT.md](SUPPORT.md) for reproducible issue-report details. Never include private source content, signed URLs, storage tokens, or credentials in a support request. # Actor input Schema ## `inputSchemaVersion` (type: `integer`): Versioned runtime input contract. ## `sources` (type: `array`): Each source selects one HTTPS URL or one user-authorized Apify KVS record and includes an explicit rights declaration. This declaration is recorded, not legally validated. ## `chunking` (type: `object`): Character chunking with a stable version, size, and overlap. ## `dedupe` (type: `object`): Version 1 performs exact canonical-content deduplication only. ## `baselineStoreId` (type: `string`): Optional existing KVS for page invalidation history. State commits only after a paid event is accepted. ## `retainRaw` (type: `boolean`): Store user-authorized raw bytes in KVS and the ZIP. Off by default. ## `maxBytesPerSource` (type: `integer`): Reject a source before parsing when its response exceeds this byte limit. ## `concurrency` (type: `integer`): Maximum simultaneous source reads, reduced automatically by the remaining event budget. ## Actor input object example ```json { "inputSchemaVersion": 1, "sources": [ { "url": "https://flintglade-tools.github.io/apify-fixtures/rag/sample.html", "rightsBasis": { "type": "user_owned", "evidence": "Flintglade-controlled public fixture" }, "formatHint": "html" } ], "chunking": { "strategy": "character", "size": 1000, "overlap": 150 }, "dedupe": { "mode": "exact" }, "retainRaw": false, "maxBytesPerSource": 20000000, "concurrency": 2 } ``` # Actor output Schema ## `defaultDataset` (type: `string`): No description ## `corpusManifest` (type: `string`): No description ## `corpusPackage` (type: `string`): No description ## `extractedDocument` (type: `string`): No description # 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 = { "sources": [ { "url": "https://flintglade-tools.github.io/apify-fixtures/rag/sample.html", "rightsBasis": { "type": "user_owned", "evidence": "Flintglade-controlled public fixture" }, "formatHint": "html" } ] }; // Run the Actor and wait for it to finish const run = await client.actor("flintglade/rag-corpus-provenance-packager").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 = { "sources": [{ "url": "https://flintglade-tools.github.io/apify-fixtures/rag/sample.html", "rightsBasis": { "type": "user_owned", "evidence": "Flintglade-controlled public fixture", }, "formatHint": "html", }] } # Run the Actor and wait for it to finish run = client.actor("flintglade/rag-corpus-provenance-packager").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 '{ "sources": [ { "url": "https://flintglade-tools.github.io/apify-fixtures/rag/sample.html", "rightsBasis": { "type": "user_owned", "evidence": "Flintglade-controlled public fixture" }, "formatHint": "html" } ] }' | apify call flintglade/rag-corpus-provenance-packager --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=flintglade/rag-corpus-provenance-packager", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "RAG Corpus Provenance Packager", "description": "Package rights-declared HTML, Markdown, text, and born-digital PDFs into deterministic RAG pages, traceable chunks, and verified manifests.", "version": "0.1", "x-build-id": "DAygFK4VN9vNtr5KY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/flintglade~rag-corpus-provenance-packager/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-flintglade-rag-corpus-provenance-packager", "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/flintglade~rag-corpus-provenance-packager/runs": { "post": { "operationId": "runs-sync-flintglade-rag-corpus-provenance-packager", "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/flintglade~rag-corpus-provenance-packager/run-sync": { "post": { "operationId": "run-sync-flintglade-rag-corpus-provenance-packager", "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": [ "sources" ], "properties": { "inputSchemaVersion": { "title": "Input schema version", "minimum": 1, "maximum": 1, "type": "integer", "description": "Versioned runtime input contract.", "default": 1 }, "sources": { "title": "Explicit source documents", "minItems": 1, "maxItems": 100, "type": "array", "description": "Each source selects one HTTPS URL or one user-authorized Apify KVS record and includes an explicit rights declaration. This declaration is recorded, not legally validated.", "items": { "type": "object", "additionalProperties": false, "properties": { "url": { "title": "Explicit HTTPS URL", "type": "string", "maxLength": 2048, "description": "One public or user-authorized source; links are not followed." }, "keyValueStoreId": { "title": "Key-value store ID", "type": "string", "maxLength": 128, "description": "A user-authorized Apify KVS selected instead of URL." }, "recordKey": { "title": "Record key", "type": "string", "maxLength": 256, "description": "Exact record key in the selected KVS." }, "rightsBasis": { "title": "Required rights declaration", "description": "Your declaration and evidence. This Actor does not provide legal advice or conclude that reuse is permitted.", "type": "object", "additionalProperties": false, "properties": { "type": { "title": "Basis", "description": "The user's declared basis for processing this source; metadata_only is recorded but cannot admit source text.", "type": "string", "enum": [ "user_owned", "licensed", "public_domain", "open_license", "metadata_only" ] }, "evidence": { "title": "Evidence text", "description": "Short non-secret evidence supporting the declaration.", "type": "string", "maxLength": 2000 }, "evidenceUrl": { "title": "Evidence URL", "description": "Optional HTTPS locator for evidence supporting the declaration.", "type": "string", "maxLength": 2048 } }, "required": [ "type" ] }, "formatHint": { "title": "Format hint", "description": "Optional parser selection when source metadata or file extension is insufficient.", "type": "string", "enum": [ "html", "markdown", "text", "pdf" ] }, "includeSelectors": { "title": "HTML include selectors", "description": "Optional bounded CSS selectors identifying HTML regions to include.", "type": "array", "editor": "stringList", "maxItems": 20, "items": { "type": "string", "maxLength": 200 } }, "excludeSelectors": { "title": "HTML exclude selectors", "description": "Optional bounded CSS selectors identifying HTML regions to remove.", "type": "array", "editor": "stringList", "maxItems": 20, "items": { "type": "string", "maxLength": 200 } } }, "required": [ "rightsBasis" ] } }, "chunking": { "title": "Deterministic chunking", "type": "object", "description": "Character chunking with a stable version, size, and overlap.", "properties": { "strategy": { "title": "Strategy", "description": "Version 1 supports deterministic character chunking only.", "type": "string", "enum": [ "character" ], "default": "character" }, "size": { "title": "Chunk size", "description": "Maximum characters per chunk.", "type": "integer", "minimum": 200, "maximum": 5000, "default": 1000 }, "overlap": { "title": "Chunk overlap", "description": "Characters repeated between adjacent chunks; runtime requires less than size.", "type": "integer", "minimum": 0, "maximum": 4999, "default": 150 } }, "default": { "strategy": "character", "size": 1000, "overlap": 150 }, "additionalProperties": false }, "dedupe": { "title": "Deduplication", "type": "object", "description": "Version 1 performs exact canonical-content deduplication only.", "properties": { "mode": { "title": "Mode", "description": "Exact hashing preserves similar-but-distinct documents.", "type": "string", "enum": [ "exact" ], "default": "exact" } }, "default": { "mode": "exact" }, "additionalProperties": false }, "baselineStoreId": { "title": "Baseline KVS", "type": "string", "description": "Optional existing KVS for page invalidation history. State commits only after a paid event is accepted." }, "retainRaw": { "title": "Retain raw source bytes", "type": "boolean", "description": "Store user-authorized raw bytes in KVS and the ZIP. Off by default.", "default": false }, "maxBytesPerSource": { "title": "Maximum bytes per source", "minimum": 1, "maximum": 50000000, "type": "integer", "description": "Reject a source before parsing when its response exceeds this byte limit.", "default": 20000000 }, "concurrency": { "title": "Source-read concurrency", "minimum": 1, "maximum": 4, "type": "integer", "description": "Maximum simultaneous source reads, reduced automatically by the remaining event budget.", "default": 2 } } }, "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 } } } } } } } } } } ```