{ "openapi": "3.0.1", "info": { "title": "RAG Chunker: split web content for vector databases", "description": "Split the output of rag-web-browser, web-fetch or website-content-crawler into clean, overlapping chunks with heading paths, token estimates and hashes. Ready for LangChain, LlamaIndex, Pinecone and more. $0.20 per 1,000 chunks.", "version": "0.1", "x-build-id": "3zhE8iIQdJbGbFxZe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ucchiii~rag-chunker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ucchiii-rag-chunker", "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/ucchiii~rag-chunker/runs": { "post": { "operationId": "runs-sync-ucchiii-rag-chunker", "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/ucchiii~rag-chunker/run-sync": { "post": { "operationId": "run-sync-ucchiii-rag-chunker", "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", "properties": { "datasetIds": { "title": "Web content datasets", "type": "array", "description": "Dataset IDs (the 'defaultDatasetId' of a finished run of the source Actor, e.g. 'WkzbQMuFYuamGv3YF'). Datasets from your runs of apify/rag-web-browser, apify/web-fetch or apify/website-content-crawler. Leave empty for a free demo on sample pages." }, "textField": { "title": "Text field", "type": "string", "description": "Name of the field that holds the page body. Falls back to 'markdown' and then 'text' if the field is missing.", "default": "markdown" }, "chunkSize": { "title": "Chunk size (characters)", "minimum": 100, "maximum": 20000, "type": "integer", "description": "Target maximum length of one chunk in characters. A code block is kept whole where possible.", "default": 1500 }, "chunkOverlap": { "title": "Chunk overlap (characters)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "How many characters of the previous chunk are repeated at the start of the next one (capped at half the chunk size).", "default": 200 }, "splitBy": { "title": "Split strategy", "enum": [ "markdown-headings", "paragraphs", "characters" ], "type": "string", "description": "How to split: 'markdown-headings' (default) splits at headings, then by paragraphs, and records the heading path. 'paragraphs' ignores headings. 'characters' is a fixed-size sliding window.", "default": "markdown-headings" }, "minChunkChars": { "title": "Minimum chunk length", "minimum": 0, "type": "integer", "description": "Fragments shorter than this are merged into the previous chunk (or the next one if first), as long as the merged chunk still fits the chunk size.", "default": 100 }, "removeBoilerplate": { "title": "Remove boilerplate", "type": "boolean", "description": "Drop repeated blank lines, image-only lines, link-only navigation lines and short lines repeated 3+ times on a page.", "default": true }, "dedupe": { "title": "Remove duplicate chunks", "type": "boolean", "description": "Skip chunks whose text is identical to one already written (across all pages and datasets).", "default": true } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }