{
"openapi": "3.0.1",
"info": {
"title": "Bulk Image Downloader: All Images from Web Pages to ZIP",
"description": "Download all images from web pages you list, or from direct image links, into your key-value store, optionally as a ZIP. One row per image: page, image URL, alt text, width, height, type, bytes, SHA-256. Duplicates saved once; icons and tracking pixels skipped.",
"version": "1.0",
"x-build-id": "9jkZ2WFbUbxw4bJSP"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/humble-echidna~bulk-image-downloader/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-humble-echidna-bulk-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/humble-echidna~bulk-image-downloader/runs": {
"post": {
"operationId": "runs-sync-humble-echidna-bulk-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/humble-echidna~bulk-image-downloader/run-sync": {
"post": {
"operationId": "run-sync-humble-echidna-bulk-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": [
"urls"
],
"properties": {
"urls": {
"title": "Web pages or image URLs",
"type": "array",
"description": "One per line. A web page (e.g. https://example.com/products/): every image on it is downloaded, from ![]()
tags (the largest size in srcset), sources and the page's og:image preview. Or a direct image link (e.g. https://example.com/photo.jpg): that image is downloaded. A missing https:// is added for you. Only public web addresses on ports 80 and 443; each site's robots.txt, including its opt-outs for AI crawlers, is honoured.",
"default": [
"https://upload.wikimedia.org/wikipedia/commons/thumb/9/97/The_Earth_seen_from_Apollo_17.jpg/500px-The_Earth_seen_from_Apollo_17.jpg",
"https://upload.wikimedia.org/wikipedia/commons/thumb/9/98/Aldrin_Apollo_11_original.jpg/500px-Aldrin_Apollo_11_original.jpg"
],
"items": {
"type": "string"
}
},
"minWidth": {
"title": "Minimum width (pixels)",
"minimum": 0,
"maximum": 100000,
"type": "integer",
"description": "Skip images narrower than this many pixels: icons, spacers and 1x1 tracking pixels. 0 to 100,000, default 100; 0 keeps every size. Skipped images are not charged.",
"default": 100
},
"minHeight": {
"title": "Minimum height (pixels)",
"minimum": 0,
"maximum": 100000,
"type": "integer",
"description": "Skip images shorter than this many pixels. 0 to 100,000, default 100; 0 keeps every size. Skipped images are not charged.",
"default": 100
},
"minFileSizeKb": {
"title": "Minimum file size (KB)",
"minimum": 0,
"maximum": 25600,
"type": "integer",
"description": "Skip image files smaller than this many kilobytes: 0 to 25,600 (25 MB), default 1; 0 keeps every size. When the site states the size up front, the file isn't even downloaded. Skipped images are not charged.",
"default": 1
},
"includePreviewImage": {
"title": "Include the page's preview image (og:image)",
"type": "boolean",
"description": "Default true: also download the image the page declares for link previews (og:image or twitter:image), which is often a large version of its main picture. Set false to skip it.",
"default": true
},
"maxImagesPerPage": {
"title": "Max images per page",
"minimum": 1,
"maximum": 1000,
"type": "integer",
"description": "Look at no more than this many images on each web page, in page order (the preview image first), e.g. 20. 1 to 1,000; leave empty (the default) for all of them, up to 1,000 per page."
},
"createZip": {
"title": "Also save a ZIP file",
"type": "boolean",
"description": "Default false. When true, also pack every saved image into ZIP files in the run's key-value store: images-001.zip, images-002.zip, ... (a new part starts at about 64 MB). The images are also saved one by one either way.",
"default": false
},
"maxResults": {
"title": "Max images per run",
"minimum": 1,
"type": "integer",
"description": "Stop after this many saved images in total, e.g. 20. Minimum 1; leave empty (the default) for no limit. Nothing past the limit is downloaded. The run also stops cleanly at the maximum cost per run you set in the run options, whichever comes first. Set it to keep a run small and quick."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}