Docs Markdown Rag Ready Crawler
Pricing
from $5.00 / 1,000 results
Go to Apify Store
Docs Markdown Rag Ready Crawler
Turn any documentation site or website into clean, structured markdown—ready for RAG, embeddings, and AI agents.
Pricing
from $5.00 / 1,000 results
Turn any documentation site or website into clean, structured markdown—ready for RAG, embeddings, and AI agents.
You can access the Docs Markdown Rag Ready Crawler programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "0.0", "x-build-id": "zKyos1p5Dyqr1hQ2Z" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devwithbobby~docs-markdown-rag-ready-crawler/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devwithbobby-docs-markdown-rag-ready-crawler", "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/devwithbobby~docs-markdown-rag-ready-crawler/runs": { "post": { "operationId": "runs-sync-devwithbobby-docs-markdown-rag-ready-crawler", "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/devwithbobby~docs-markdown-rag-ready-crawler/run-sync": { "post": { "operationId": "run-sync-devwithbobby-docs-markdown-rag-ready-crawler", "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": [ "domain" ], "properties": { "domain": { "title": "Domain", "type": "string", "description": "Domain to crawl (e.g., https://docs.example.com)" }, "startUrls": { "title": "Start URLs", "type": "array", "description": "URLs to start with (optional override for domain)", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxPages": { "title": "Max Pages", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of pages to crawl", "default": 200 }, "maxDepth": { "title": "Max Depth", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum crawl depth from start URLs", "default": 4 }, "makeRagReady": { "title": "Make RAG Ready", "type": "boolean", "description": "Generate RAG-ready chunks with stable IDs and hashes", "default": true }, "mode": { "title": "Crawl Mode", "enum": [ "docs", "article", "generic" ], "type": "string", "description": "Extraction strategy optimized for different site types", "default": "docs" }, "output": { "title": "Output Datasets", "enum": [ "all", "pagesOnly", "chunksOnly", "edgesOnly" ], "type": "string", "description": "Which datasets to generate", "default": "all" }, "includeSubdomains": { "title": "Include Subdomains", "type": "boolean", "description": "Also crawl subdomains of the main domain", "default": false }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Follow robots.txt rules for crawling", "default": true }, "crawlerType": { "title": "Crawler Type", "enum": [ "playwright", "cheerio" ], "type": "string", "description": "Crawling engine to use. Use 'playwright' for SPAs/JavaScript-heavy sites, 'cheerio' for static HTML sites (faster)", "default": "playwright" }, "removeSelectors": { "title": "Remove Selectors", "type": "array", "description": "CSS selectors to remove from content", "default": [ "nav", "aside", "header", "footer", ".toc", "#TableOfContents", ".table-of-contents" ], "items": { "type": "string" } }, "allowPatterns": { "title": "Allow URL Patterns", "type": "array", "description": "Regex patterns for URLs to include", "default": [], "items": { "type": "string" } }, "denyPatterns": { "title": "Deny URL Patterns", "type": "array", "description": "Regex patterns for URLs to exclude", "default": [ ".*(\\?|&)utm_.*", ".*(\\?|&)(ref|source|campaign)=.*" ], "items": { "type": "string" } }, "stripQueryParams": { "title": "Strip Query Params", "type": "boolean", "description": "Remove query parameters from URLs", "default": true }, "chunkTargetChars": { "title": "Chunk Target Characters", "minimum": 500, "maximum": 10000, "type": "integer", "description": "Target number of characters per chunk", "default": 2500 }, "chunkMaxChars": { "title": "Chunk Max Characters", "minimum": 1000, "maximum": 20000, "type": "integer", "description": "Maximum number of characters per chunk", "default": 4500 }, "minChunkChars": { "title": "Min Chunk Characters", "minimum": 100, "maximum": 2000, "type": "integer", "description": "Minimum number of characters per chunk", "default": 400 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for crawling" } } }, "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 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Docs Markdown Rag Ready Crawler from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: