{
  "openapi": "3.0.1",
  "info": {
    "title": "Bulk Image Downloader — Every Image on a Page, Plus a ZIP",
    "description": "Bulk image downloader: every image on the web pages you name (img, srcset, lazy-load, picture, og:image), image URLs, or a dataset's image fields. Each image stored with a public link, width, height, format, size and SHA-256, icons skipped, plus one ZIP. Export to JSON, CSV or Excel, or via API.",
    "version": "1.0",
    "x-build-id": "sgkpbWPI9DYlgMFuF"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/steadyscrape~bulk-image-downloader/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-steadyscrape-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/steadyscrape~bulk-image-downloader/runs": {
      "post": {
        "operationId": "runs-sync-steadyscrape-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/steadyscrape~bulk-image-downloader/run-sync": {
      "post": {
        "operationId": "run-sync-steadyscrape-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",
        "properties": {
          "urls": {
            "title": "Web pages or image links",
            "type": "array",
            "description": "One per line. A web page is scanned and every image on it is downloaded (img src, the largest srcset candidate, lazy-load attributes such as data-src, picture sources, og:image, inline background images, video posters). A direct image link is downloaded as it is.",
            "items": {
              "type": "string"
            }
          },
          "datasetId": {
            "title": "Or take the links from a dataset",
            "type": "string",
            "description": "Pick the dataset of another run (a scraper's results, an import) and this Actor downloads the images its items link to: product photos, listing pictures, thumbnails. Only the dataset you pick here can be read."
          },
          "datasetFields": {
            "title": "Dataset fields with the links",
            "type": "array",
            "description": "The fields of each dataset item that hold image links, or page links to scan, as dotted paths; arrays are walked through, so images.url takes the url of every element of images. Leave empty to take every link in a field named like a picture (image, photo, thumbnail, cover, avatar, logo…) or ending in an image extension.",
            "items": {
              "type": "string"
            }
          },
          "minWidth": {
            "title": "Smallest width (pixels)",
            "minimum": 0,
            "type": "integer",
            "description": "Images narrower than this, measured from their own bytes, are not stored and not charged: icons, buttons and tracking pixels. 0 keeps every size.",
            "default": 100
          },
          "minHeight": {
            "title": "Smallest height (pixels)",
            "minimum": 0,
            "type": "integer",
            "description": "Images shorter than this, measured from their own bytes, are not stored and not charged. 0 keeps every size.",
            "default": 100
          },
          "formats": {
            "title": "Formats to keep",
            "type": "array",
            "description": "Keep only these formats, told by the image's own bytes rather than its link. Empty keeps every format.",
            "items": {
              "type": "string",
              "enum": [
                "jpeg",
                "png",
                "gif",
                "webp",
                "avif",
                "svg",
                "bmp",
                "tiff",
                "heic",
                "ico",
                "other"
              ],
              "enumTitles": [
                "JPEG",
                "PNG",
                "GIF",
                "WebP",
                "AVIF",
                "SVG",
                "BMP",
                "TIFF",
                "HEIC / HEIF",
                "ICO",
                "Any other image format"
              ]
            },
            "default": []
          },
          "maxImages": {
            "title": "Most images",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "The run stops once this many images are stored, and does not scan another page while the images already found could fill it.",
            "default": 1000
          },
          "maxTotalMegabytes": {
            "title": "Most megabytes in total",
            "minimum": 1,
            "type": "integer",
            "description": "The run never stores more than this. An image that would pass it is not stored and not charged, and the run stops there.",
            "default": 5000
          },
          "maxImageMegabytes": {
            "title": "Most megabytes per image",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "A bigger image is a free too_large row.",
            "default": 50
          },
          "listSkippedImages": {
            "title": "List skipped images too",
            "type": "boolean",
            "description": "Off: images found on a page that were too small, of a format not chosen, or a copy of one already stored are only counted (in the SUMMARY). On: each gets its own free row with the reason. Links you typed always get a row.",
            "default": false
          },
          "respectRobotsTxt": {
            "title": "Respect robots.txt",
            "type": "boolean",
            "description": "On: a page or image a site's robots.txt disallows for this Actor (or for every robot) is a free row, and so is every link of a site whose robots.txt cannot be read. Off: you take responsibility for having the right to download those images.",
            "default": true
          },
          "skipDuplicates": {
            "title": "Skip duplicate images",
            "type": "boolean",
            "description": "An image with the same bytes (SHA-256) as one already stored in this run is not stored again and not charged.",
            "default": true
          },
          "maxConcurrency": {
            "title": "Downloads at once",
            "minimum": 1,
            "maximum": 16,
            "type": "integer",
            "description": "Pages and images fetched at the same time, never more than two from one host.",
            "default": 4
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}