{
"openapi": "3.0.1",
"info": {
"title": "Website Image Downloader & Bulk Image Scraper",
"description": "Download all images from any website or extract image URLs (srcset, lazy-loaded, picture, CSS) with width, height, format and alt text. Filters icons and tracking pixels, removes duplicates, ZIP output. REST API and MCP for AI agents.",
"version": "0.2",
"x-build-id": "mz9wLiOTS28NUkAzh"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/sste~website-image-downloader/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-sste-website-image-downloader",
"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/sste~website-image-downloader/runs": {
"post": {
"operationId": "runs-sync-sste-website-image-downloader",
"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/sste~website-image-downloader/run-sync": {
"post": {
"operationId": "run-sync-sste-website-image-downloader",
"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": "Page or image URLs",
"type": "array",
"description": "Web pages to extract images from, and/or direct image URLs to download. Up to 10,000 per run.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"mode": {
"title": "Mode",
"enum": [
"download",
"inspect",
"list"
],
"type": "string",
"description": "download: save the image files (plus a ZIP) and their details. inspect: download to measure width, height, format and size, but do not store files. list: only list the image URLs found on the pages (fastest; no download, so size filters do not apply).",
"default": "download"
},
"minWidth": {
"title": "Minimum width (px)",
"minimum": 0,
"maximum": 20000,
"type": "integer",
"description": "Skip images narrower than this. The default of 100 removes icons, sprites and tracking pixels. Set 0 to keep everything.",
"default": 100
},
"minHeight": {
"title": "Minimum height (px)",
"minimum": 0,
"maximum": 20000,
"type": "integer",
"description": "Skip images shorter than this. Set 0 to keep everything.",
"default": 100
},
"formats": {
"title": "Image formats",
"type": "array",
"description": "Keep only these formats. The format is detected from the file contents, not from the URL.",
"items": {
"type": "string",
"enum": [
"jpg",
"png",
"gif",
"webp",
"avif",
"svg",
"ico",
"bmp",
"tiff",
"heic"
],
"enumTitles": [
"JPEG",
"PNG",
"GIF",
"WebP",
"AVIF",
"SVG",
"ICO",
"BMP",
"TIFF",
"HEIC"
]
},
"default": [
"jpg",
"png",
"gif",
"webp",
"avif",
"svg",
"ico",
"bmp",
"tiff",
"heic"
]
},
"minFileSizeKB": {
"title": "Minimum file size (KB)",
"minimum": 0,
"maximum": 100000,
"type": "integer",
"description": "Skip files smaller than this.",
"default": 0
},
"maxFileSizeMB": {
"title": "Maximum file size (MB)",
"minimum": 1,
"maximum": 50,
"type": "integer",
"description": "Skip files larger than this (maximum 50 MB).",
"default": 25
},
"dedupe": {
"title": "Remove duplicates",
"type": "boolean",
"description": "Skip repeated image URLs, and identical files served under different URLs (compared by SHA-256 of the content).",
"default": true
},
"urlMustContain": {
"title": "Image URL must contain",
"type": "array",
"description": "Keep only images whose URL contains at least one of these texts (case-insensitive), for example /products/ or cdn.shopify.com.",
"items": {
"type": "string"
}
},
"urlMustNotContain": {
"title": "Image URL must not contain",
"type": "array",
"description": "Skip images whose URL contains any of these texts (case-insensitive), for example logo, avatar or sprite.",
"items": {
"type": "string"
}
},
"crawlDepth": {
"title": "Follow links (depth)",
"minimum": 0,
"maximum": 3,
"type": "integer",
"description": "0 = only the given pages. 1 = also the pages they link to on the same website. Maximum 3.",
"default": 0
},
"maxPagesPerStartUrl": {
"title": "Max pages per start URL",
"minimum": 1,
"maximum": 1000,
"type": "integer",
"description": "Upper limit of pages visited for each start URL when following links.",
"default": 20
},
"maxImages": {
"title": "Max images per run",
"minimum": 1,
"maximum": 100000,
"type": "integer",
"description": "The run stops after this many images. You are charged only for images delivered.",
"default": 1000
},
"maxImagesPerPage": {
"title": "Max images per page",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "Process at most this many image candidates from a single page.",
"default": 500
},
"createZip": {
"title": "Create ZIP archive",
"type": "boolean",
"description": "In download mode, pack all images into images.zip (split into 500 MB parts when larger).",
"default": true
},
"saveIndividualFiles": {
"title": "Also save each image as a separate file",
"type": "boolean",
"description": "Store every image as its own record in the key-value store, with a direct downloadUrl in the results. Useful for integrations that process images one by one.",
"default": false
},
"includeCssBackgrounds": {
"title": "Include inline CSS background images",
"type": "boolean",
"description": "Images set with an inline background-image style or data-bg attributes.",
"default": true
},
"includeMetaImages": {
"title": "Include social preview images",
"type": "boolean",
"description": "The og:image and twitter:image of each page.",
"default": true
},
"includeLinkedImages": {
"title": "Include linked image files",
"type": "boolean",
"description": "Links that point directly to image files, such as full-size gallery images.",
"default": true
},
"includeIcons": {
"title": "Include favicons",
"type": "boolean",
"description": "Favicons and apple-touch-icons declared in the page head.",
"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
},
"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
}
}
}
}
}
}
}
}
}
}