{
  "openapi": "3.0.1",
  "info": {
    "title": "Picpail — Bulk Image Downloader: All Images from URLs to ZIP",
    "description": "Download all images from web pages or image URLs into one ZIP, full-size originals instead of thumbnails: img, srcset, lazy-load, CSS, og:image. Real format and pixel size, duplicate removal, size/format filters, monitor mode. $0.0005 per image; duplicates and skips free.",
    "version": "0.1",
    "x-build-id": "sa9cxK1NgAMMp8KXI"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/cybermax~bulk-image-downloader/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-cybermax-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/cybermax~bulk-image-downloader/runs": {
      "post": {
        "operationId": "runs-sync-cybermax-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/cybermax~bulk-image-downloader/run-sync": {
      "post": {
        "operationId": "run-sync-cybermax-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": "Page or image URLs",
            "type": "array",
            "description": "Web pages to take every image from (product pages, galleries, blog posts, listings) and/or direct image URLs (…/photo.jpg). Mix freely; bare domains get https://. Each image is downloaded, checked to be a real image and measured.",
            "items": {
              "type": "string"
            }
          },
          "output": {
            "title": "Deliver images as",
            "enum": [
              "zip",
              "zipPerPage",
              "files",
              "list"
            ],
            "type": "string",
            "description": "How to get the images. ZIPs are split into parts at 'ZIP part size'. Every mode also returns one dataset row per image (URL, format, width, height, bytes, SHA-256, alt text, where it was found).",
            "default": "zip"
          },
          "minWidth": {
            "title": "Minimum width (px)",
            "minimum": 0,
            "type": "integer",
            "description": "Skip images narrower than this (measured from the file, not the HTML). 100 skips icons and thumbnails. Skipped images are free.",
            "default": 0
          },
          "minHeight": {
            "title": "Minimum height (px)",
            "minimum": 0,
            "type": "integer",
            "description": "Skip images shorter than this.",
            "default": 0
          },
          "formats": {
            "title": "Only these formats",
            "type": "array",
            "description": "Keep only these real formats (detected from the file bytes). Empty = all formats.",
            "items": {
              "type": "string",
              "enum": [
                "jpeg",
                "png",
                "webp",
                "gif",
                "avif",
                "svg",
                "ico",
                "bmp",
                "tiff",
                "heic"
              ],
              "enumTitles": [
                "JPEG",
                "PNG",
                "WebP",
                "GIF",
                "AVIF",
                "SVG",
                "ICO",
                "BMP",
                "TIFF",
                "HEIC"
              ]
            }
          },
          "minFileSizeKb": {
            "title": "Minimum file size (KB)",
            "minimum": 0,
            "type": "integer",
            "description": "Skip files smaller than this.",
            "default": 0
          },
          "maxFileSizeMb": {
            "title": "Maximum file size (MB)",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Larger files are skipped (not downloaded).",
            "default": 25
          },
          "urlPattern": {
            "title": "Image URL must match (regex)",
            "type": "string",
            "description": "Optional regular expression, case-insensitive, e.g. /products/|cdn\\.shopify\\.com"
          },
          "excludeUrlPattern": {
            "title": "Skip image URLs matching (regex)",
            "type": "string",
            "description": "Optional, e.g. logo|icon|sprite|avatar"
          },
          "sameDomainOnly": {
            "title": "Only images from the page's own site",
            "type": "boolean",
            "description": "Skip images hosted on other domains (ads, trackers, embeds). The site's own CDN subdomains (cdn.example.com) count as the same site.",
            "default": false
          },
          "dedupe": {
            "title": "Remove duplicates",
            "type": "boolean",
            "description": "Download each image URL once and drop byte-identical files (SHA-256) across all pages. Duplicates are free.",
            "default": true
          },
          "skipTrackingPixels": {
            "title": "Skip tracking pixels",
            "type": "boolean",
            "description": "Skip 1×1 and 2×2 images.",
            "default": true
          },
          "upgradeToOriginals": {
            "title": "Full-size originals instead of thumbnails",
            "type": "boolean",
            "description": "Pages usually show resized copies. For Shopify, WordPress (media library + Jetpack), Wikimedia, Cloudinary, Wix, Squarespace, Contentful and imgix URLs, download the full-size original instead (falls back to the page's copy if the original can't be fetched). The row keeps both URLs.",
            "default": true
          },
          "srcset": {
            "title": "Responsive images (srcset)",
            "enum": [
              "largest",
              "all",
              "none"
            ],
            "type": "string",
            "description": "Pages often offer several sizes of the same picture. 'Largest' gets the best quality once.",
            "default": "largest"
          },
          "includeLinkedImages": {
            "title": "Linked originals (<a href=…jpg>)",
            "type": "boolean",
            "description": "Gallery thumbnails often link to the full-size original. Links that turn out to be HTML pages are skipped for free.",
            "default": true
          },
          "includeCssBackgrounds": {
            "title": "CSS background images",
            "type": "boolean",
            "description": "Inline style and <style> backgrounds (hero banners, sliders). External CSS files are not fetched.",
            "default": true
          },
          "includeMetaImages": {
            "title": "Social/SEO images",
            "type": "boolean",
            "description": "og:image, twitter:image, JSON-LD product/article images and video posters.",
            "default": true
          },
          "includeIcons": {
            "title": "Favicons and touch icons",
            "type": "boolean",
            "description": "Include <link rel=icon> and apple-touch-icon files.",
            "default": false
          },
          "includeDataUris": {
            "title": "Inline data: images",
            "type": "boolean",
            "description": "Include images embedded in the HTML as data: URIs (placeholders are always skipped).",
            "default": false
          },
          "preferOriginalFormat": {
            "title": "Prefer original file format",
            "type": "boolean",
            "description": "Ask servers for the original JPEG/PNG/GIF instead of the WebP/AVIF copies many CDNs create on the fly. Turn off to get the (usually smaller) modern formats a browser would get.",
            "default": true
          },
          "fileNaming": {
            "title": "File names",
            "enum": [
              "original",
              "alt",
              "index",
              "hash"
            ],
            "type": "string",
            "description": "Names inside the ZIP / key-value store. Extensions always match the real format.",
            "default": "original"
          },
          "zipPartSizeMb": {
            "title": "ZIP part size (MB)",
            "minimum": 10,
            "maximum": 3900,
            "type": "integer",
            "description": "Big jobs are split into images.zip, images-part-2.zip, …",
            "default": 1000
          },
          "maxImagesPerPage": {
            "title": "Max images per page",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Safety cap per input URL.",
            "default": 500
          },
          "maxImagesTotal": {
            "title": "Max images per run",
            "minimum": 1,
            "type": "integer",
            "description": "Stop after this many delivered images (you can also set a maximum charge per run in Apify).",
            "default": 100000
          },
          "pageConcurrency": {
            "title": "Pages in parallel",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "How many input URLs are processed at the same time.",
            "default": 4
          },
          "imageConcurrency": {
            "title": "Downloads in parallel per page",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "How many images of one page download at the same time. Lower it for small sites.",
            "default": 12
          },
          "timeoutSecs": {
            "title": "Timeout per request (s)",
            "minimum": 3,
            "maximum": 120,
            "type": "integer",
            "description": "Per page or image download.",
            "default": 30
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Optional. By default requests go direct and blocked ones (403/429/503) are retried once through Apify Proxy. Use residential proxies for strict sites."
          },
          "retryWithProxy": {
            "title": "Retry blocked requests through Apify Proxy",
            "type": "boolean",
            "description": "Only used when no proxy is set above.",
            "default": true
          },
          "monitor": {
            "title": "Monitor mode: new images only",
            "type": "boolean",
            "description": "For scheduled runs. Remembers every image delivered for this list of URLs (by content hash) and returns only images that are new since the last monitor run: new products, new gallery photos, a changed banner. Images you already got are skipped and not charged. The first run returns everything.",
            "default": false
          },
          "monitorKey": {
            "title": "Watchlist name",
            "type": "string",
            "description": "Optional name for the monitor memory, so you can change the URL list and keep history. Default: derived from the URL list."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}