{ "openapi": "3.0.1", "info": { "title": "Bulk Image Downloader & Scraper: All Images from Web Pages, ZIP", "description": "Download all images from a list of web pages: img, srcset in the largest size, lazy-loaded, picture, linked full-size images, Open Graph, optional CSS backgrounds and icons. Filter by size and format, skip duplicates, convert to WebP/JPEG/PNG, get one ZIP.", "version": "0.1", "x-build-id": "kpLL1VkUpNMdt6cSN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tidelane~bulk-image-downloader/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tidelane-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/tidelane~bulk-image-downloader/runs": { "post": { "operationId": "runs-sync-tidelane-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/tidelane~bulk-image-downloader/run-sync": { "post": { "operationId": "run-sync-tidelane-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": [ "startUrls" ], "properties": { "startUrls": { "title": "Web pages", "type": "array", "description": "Pages to take the images from, one per line.", "items": { "type": "string" } }, "minWidth": { "title": "Min width (px)", "minimum": 0, "type": "integer", "description": "Skip smaller images such as icons and thumbnails. 0 keeps all.", "default": 0 }, "minHeight": { "title": "Min height (px)", "minimum": 0, "type": "integer", "description": "Skip images lower than this.", "default": 0 }, "formats": { "title": "Only these formats", "type": "array", "description": "Keep only images in these formats. Empty keeps all.", "items": { "type": "string", "enum": [ "jpeg", "png", "webp", "gif", "avif", "svg", "tiff" ], "enumTitles": [ "JPEG", "PNG", "WebP", "GIF", "AVIF", "SVG", "TIFF" ] } }, "includeLinked": { "title": "Linked full-size images", "type": "boolean", "description": "Also download images that the page links to (galleries often link thumbnails to the full-size file).", "default": true }, "includeBackgrounds": { "title": "CSS background images", "type": "boolean", "description": "Also images set as backgrounds in style attributes and style blocks of the page.", "default": false }, "includeIcons": { "title": "Icons", "type": "boolean", "description": "Also favicons and touch icons.", "default": false }, "convertTo": { "title": "Convert to", "enum": [ "original", "webp", "jpeg", "png", "avif" ], "type": "string", "description": "Keep the original files, or convert all to one format.", "default": "original" }, "quality": { "title": "Quality (when converting)", "minimum": 1, "maximum": 100, "type": "integer", "description": "1-100.", "default": 85 }, "maxWidth": { "title": "Max width (px)", "minimum": 1, "maximum": 16384, "type": "integer", "description": "Scale wider images down to this width (keeps the ratio)." }, "zip": { "title": "Also create one ZIP", "type": "boolean", "description": "Saves all-images.zip in the key-value store; its link is in OUTPUT.", "default": false }, "maxImagesPerPage": { "title": "Max images per page", "minimum": 1, "type": "integer", "description": "Stop collecting after this many image links per page.", "default": 200 }, "maxImages": { "title": "Max images in total", "minimum": 1, "type": "integer", "description": "Stop after this many images.", "default": 5000 }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip pages and images whose robots.txt forbids automated access. Turn off only for your own sites or with the owner's permission.", "default": true }, "maxConcurrency": { "title": "Parallel downloads", "minimum": 1, "maximum": 16, "type": "integer", "description": "Images downloaded at the same time.", "default": 6 } } }, "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 } } } } } } } } } }