{ "openapi": "3.0.1", "info": { "title": "Markdown Broken Links Checker", "description": "Check every hyperlink and anchor in your Markdown files for broken links. Point it at raw Markdown URLs or paste text directly — use it as a CI/CD gate before you deploy or publish.", "version": "1.0", "x-build-id": "hrDP8cyMs7MjmW8Oc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~markdown-broken-links-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-markdown-broken-links-checker", "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/parsebird~markdown-broken-links-checker/runs": { "post": { "operationId": "runs-sync-parsebird-markdown-broken-links-checker", "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/parsebird~markdown-broken-links-checker/run-sync": { "post": { "operationId": "run-sync-parsebird-markdown-broken-links-checker", "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": { "markdownUrls": { "title": "Markdown URLs", "type": "array", "description": "Raw Markdown file URLs to check (e.g. a GitHub raw README URL). Each file is checked separately and reported under its own URL.", "default": [ "https://raw.githubusercontent.com/tcort/markdown-link-check/master/README.md" ], "items": { "type": "string" } }, "markdownText": { "title": "Markdown Text", "type": "string", "description": "Paste Markdown content directly to check, instead of or in addition to Markdown URLs.", "default": "" }, "ignorePatterns": { "title": "Ignore Patterns", "type": "array", "description": "Regular expressions. Links matching any pattern are skipped and marked \"ignored\" (e.g. \"^http://localhost\", \"^mailto:\").", "default": [], "items": { "type": "string" } }, "additionalAliveStatusCodes": { "title": "Additional \"Alive\" Status Codes", "type": "array", "description": "Treat these HTTP status codes as alive in addition to 2xx. Useful for sites that block automated checks (e.g. 403 or 429) but are otherwise reachable.", "items": { "type": "string", "enum": [ "401", "403", "405", "429", "999" ], "enumTitles": [ "401 Unauthorized", "403 Forbidden", "405 Method Not Allowed", "429 Too Many Requests", "999 (LinkedIn-style bot block)" ] }, "default": [] }, "checkAnchors": { "title": "Check anchor links", "type": "boolean", "description": "Validate same-document links like \"#installation\" against the file's own headings.", "default": true }, "timeoutSeconds": { "title": "Timeout (seconds)", "minimum": 1, "maximum": 60, "type": "integer", "description": "Per-link request timeout.", "default": 10 }, "retries": { "title": "Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retry attempts for a link before marking it dead.", "default": 1 }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 30, "type": "integer", "description": "Maximum links checked in parallel. Lower this if a target site starts rate-limiting the check.", "default": 10 }, "userAgent": { "title": "User Agent", "type": "string", "description": "Sent with every link check. Some sites block default bot user agents.", "default": "Mozilla/5.0 (compatible; MarkdownBrokenLinksChecker/1.0; +https://apify.com/parsebird/markdown-broken-links-checker)" }, "failOnDeadLinks": { "title": "Fail run on dead links", "type": "boolean", "description": "When on, the Actor run fails (non-zero status) if any dead links are found — turn this on to gate a CI/CD pipeline on broken links.", "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 } } } } } } } } } }