{ "openapi": "3.0.1", "info": { "title": "Bulk Image Converter & Compressor", "description": "Convert, compress and resize images in bulk from URLs or uploaded files. Output WebP, AVIF, JPEG, PNG, GIF, TIFF or BMP, with HEIC input supported. Get public links and before/after file sizes for every image.", "version": "0.0", "x-build-id": "JDbBbIv2sX2f0YT3a" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bite-sized-insights~bulk-image-converter-compressor-and-resizer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bite-sized-insights-bulk-image-converter-compressor-and-resizer", "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/bite-sized-insights~bulk-image-converter-compressor-and-resizer/runs": { "post": { "operationId": "runs-sync-bite-sized-insights-bulk-image-converter-compressor-and-resizer", "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/bite-sized-insights~bulk-image-converter-compressor-and-resizer/run-sync": { "post": { "operationId": "run-sync-bite-sized-insights-bulk-image-converter-compressor-and-resizer", "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": "Image URLs", "maxItems": 1000, "type": "array", "description": "Public http(s) image URLs, up to 25 MB each. Replace the sample if you only use uploads.", "items": { "type": "string", "maxLength": 2048 }, "default": [ "https://www.python.org/static/img/python-logo.png" ] }, "uploadKeys": { "title": "Uploaded file keys", "maxItems": 1000, "type": "array", "description": "Keys of image files you uploaded to a key-value store. Converted like URLs.", "items": { "type": "string", "maxLength": 256 } }, "uploadStoreName": { "title": "Key-value store name for uploaded files", "maxLength": 63, "type": "string", "description": "Name of the key-value store with the uploaded files. Empty = the run's default store." }, "outputFormat": { "title": "Output format", "enum": [ "webp", "jpeg", "png", "avif", "original", "gif", "tiff", "bmp" ], "type": "string", "description": "Format of the converted files. Keep original format only compresses and resizes.", "default": "webp" }, "quality": { "title": "Quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1 = smallest file, 100 = best quality. For PNG, below 100 reduces the number of colors.", "default": 80 }, "maxWidth": { "title": "Maximum width (px)", "minimum": 0, "maximum": 16000, "type": "integer", "description": "Shrink images wider than this many pixels. 0 = no limit. Images are never enlarged.", "default": 0 }, "maxHeight": { "title": "Maximum height (px)", "minimum": 0, "maximum": 16000, "type": "integer", "description": "Shrink images taller than this many pixels. 0 = no limit. Images are never enlarged.", "default": 0 }, "keepAspectRatio": { "title": "Keep aspect ratio", "type": "boolean", "description": "Fit images inside the maximum size without distortion. Off: each limit applies per side.", "default": true }, "stripMetadata": { "title": "Strip metadata", "type": "boolean", "description": "Remove camera data and GPS location, convert colors to sRGB and rotate photos upright.", "default": true }, "backgroundColor": { "title": "Background color", "pattern": "^#[0-9a-fA-F]{6}$", "maxLength": 7, "type": "string", "description": "Hex color (e.g. #ffffff) that replaces transparency when the output has none (JPEG, BMP).", "default": "#ffffff" } } }, "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 } } } } } } } } } }