{
"openapi": "3.0.1",
"info": {
"title": "Broken Link Checker",
"description": "Find broken links and images on any website. Reads the site's pages, checks every link and image on them, and lists each broken one (404, server error, dead domain, timeout) with the pages it appears on. Also flags redirects and links that sites refuse to check.",
"version": "1.0",
"x-build-id": "YKpMslN5tbKUhxPng"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/cyber1nj3ct0r~broken-link-checker/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-cyber1nj3ct0r-broken-link-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/cyber1nj3ct0r~broken-link-checker/runs": {
"post": {
"operationId": "runs-sync-cyber1nj3ct0r-broken-link-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/cyber1nj3ct0r~broken-link-checker/run-sync": {
"post": {
"operationId": "run-sync-cyber1nj3ct0r-broken-link-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",
"required": [
"startUrls"
],
"properties": {
"startUrls": {
"title": "Websites",
"minItems": 1,
"type": "array",
"description": "The page to start from on each website, usually the home page, for example https://www.example.com. The tool follows the links from there to other pages of the same site.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"maxPages": {
"title": "Maximum pages to read per website",
"minimum": 1,
"maximum": 100000,
"type": "integer",
"description": "How many pages of each website to read for links. Reading pages is not charged; checking the links found is. Large sites need a higher number to have every page covered.",
"default": 200
},
"maxLinks": {
"title": "Maximum links to check",
"minimum": 1,
"maximum": 2000000,
"type": "integer",
"description": "Stop after checking this many different links. You pay per link checked, so this also caps the cost of the run.",
"default": 10000
},
"checkExternal": {
"title": "Check links to other websites",
"type": "boolean",
"description": "Also check links that lead to other websites. Turn off to check only the website's own pages and files.",
"default": true
},
"linkTypes": {
"title": "What to check",
"type": "array",
"description": "Which kinds of references on the pages to check. Links and images are checked by default.",
"items": {
"type": "string",
"enum": [
"link",
"image",
"stylesheet",
"script",
"media",
"frame"
],
"enumTitles": [
"Links",
"Images",
"Stylesheets",
"Scripts",
"Video and audio",
"Embedded frames"
]
},
"default": [
"link",
"image"
]
},
"includePatterns": {
"title": "Only read pages matching",
"type": "array",
"description": "Read a page for links only if its address matches at least one of these. Plain text matches anywhere in the address and * stands for any characters, for example /blog/. For a regular expression, wrap it in slashes. Links found on the pages read are all checked.",
"items": {
"type": "string"
}
},
"excludePatterns": {
"title": "Skip pages matching",
"type": "array",
"description": "Do not read pages whose address matches any of these, for example /tag/ or ?page=. Links to them are still checked.",
"items": {
"type": "string"
}
},
"requestTimeoutSecs": {
"title": "Time limit per request",
"minimum": 5,
"maximum": 120,
"type": "integer",
"description": "How long to wait for one page or link before counting it as not answering.",
"default": 20
},
"userAgent": {
"title": "User-Agent",
"type": "string",
"description": "The name the tool sends with each request. Leave empty to use the tool's own name, which tells site owners what is visiting. Set your own only for sites you run or have permission to test."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}