{ "openapi": "3.0.1", "info": { "title": "Bulk File & Image Downloader", "description": "Download a list of file or image URLs straight into Apify storage, streamed in chunks so memory stays flat even for multi-GB files. Hard caps on file size and count, robots.txt respected, private and internal addresses blocked.", "version": "1.0", "x-build-id": "y2rcerF5JosNm9ATE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brimfold~bulk-file-downloader/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brimfold-bulk-file-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/brimfold~bulk-file-downloader/runs": { "post": { "operationId": "runs-sync-brimfold-bulk-file-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/brimfold~bulk-file-downloader/run-sync": { "post": { "operationId": "run-sync-brimfold-bulk-file-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": "File URLs", "type": "array", "description": "Direct links to the files to download (http or https). Only download files you have the right to download and store.", "default": [ "https://upload.wikimedia.org/wikipedia/commons/1/1b/Apollo_11_1998_scan.jpg", "https://upload.wikimedia.org/wikipedia/commons/1/19/Apollo_11_2004_scan_cropped.jpg", "https://upload.wikimedia.org/wikipedia/commons/0/0c/Apollo_11_Commemorative_Coin.jpg" ], "items": { "type": "string" } }, "maxFiles": { "title": "Maximum files", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on how many files are downloaded in this run. Extra URLs are listed as skipped and not charged.", "default": 100 }, "maxFileSizeMb": { "title": "Maximum file size (MB)", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap per file, in MB (1 MB = 1,048,576 bytes). Bigger files are skipped before download when the server states the size, or stopped and discarded as soon as they pass the cap. Skipped files are not charged.", "default": 100 }, "allowedContentTypes": { "title": "Allowed content types", "type": "array", "description": "Optional. Only keep files whose Content-Type starts with one of these, for example \"image/\" or \"application/pdf\". Empty = any type except HTML pages.", "default": [], "items": { "type": "string" } }, "allowHtmlPages": { "title": "Allow HTML pages", "type": "boolean", "description": "By default links that return an HTML web page are skipped (uncharged), because they are usually a viewer page rather than the file itself.", "default": false }, "maxConcurrency": { "title": "Parallel downloads", "minimum": 1, "maximum": 16, "type": "integer", "description": "Files downloaded at once. At most 2 at a time go to the same host, with a pause between requests.", "default": 4 }, "requestTimeoutSecs": { "title": "Timeout per file (seconds)", "minimum": 10, "maximum": 3600, "type": "integer", "description": "A file that takes longer than this to download is abandoned and not charged.", "default": 600 }, "keyPrefix": { "title": "Storage key prefix", "type": "string", "description": "Optional text put at the start of every stored file key, to tell runs apart. Letters, numbers and - _ . only.", "default": "" } } }, "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 } } } } } } } } } }