{ "openapi": "3.0.1", "info": { "title": "Bulk Image Converter & Compressor (WebP, AVIF, JPG, PNG)", "description": "Convert and compress images in bulk to WebP, AVIF, JPEG or PNG: resize, strip EXIF/GPS metadata, get a per-image savings report and a download link for every file.", "version": "0.1", "x-build-id": "ifwJ2N9vdcsnbJZU4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/divinxxii~image-converter/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-divinxxii-image-converter", "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/divinxxii~image-converter/runs": { "post": { "operationId": "runs-sync-divinxxii-image-converter", "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/divinxxii~image-converter/run-sync": { "post": { "operationId": "run-sync-divinxxii-image-converter", "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": { "imageUrls": { "title": "Image URLs", "type": "array", "description": "Public http(s) URLs of images (JPEG, PNG, WebP, GIF, BMP, TIFF or AVIF, up to 25 MB each). robots.txt is honoured and requests to one host are spaced 1 s apart. Leave empty (with no store keys) to run a small built-in sample.", "items": { "type": "string" } }, "kvsKeys": { "title": "Key-value store keys", "type": "array", "description": "Keys of image files you uploaded to a key-value store (see 'Source key-value store'). Each key is read directly, no download involved.", "items": { "type": "string" } }, "sourceStore": { "title": "Source key-value store (name or ID)", "type": "string", "description": "Store that holds the files named in 'Key-value store keys'. Name or 17-character ID of one of your stores; empty means this run's own default store." }, "outputFormat": { "title": "Output format", "enum": [ "webp", "avif", "jpeg", "png" ], "type": "string", "description": "Format of the converted files. PNG is lossless, so 'Quality' does not apply to it.", "default": "webp" }, "quality": { "title": "Quality (1-100)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Lossy quality for WebP, AVIF and JPEG. 75-85 is a good balance; ignored for PNG.", "default": 80 }, "maxWidth": { "title": "Max width (px)", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Shrink images wider than this, keeping the aspect ratio. 0 means no limit. Images are never enlarged.", "default": 0 }, "maxHeight": { "title": "Max height (px)", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Shrink images taller than this, keeping the aspect ratio. 0 means no limit. Images are never enlarged.", "default": 0 }, "stripMetadata": { "title": "Strip metadata", "type": "boolean", "description": "Remove EXIF (camera, GPS location), XMP, comments and embedded colour profiles. Colours are first converted to sRGB so the picture looks the same. Turn off to keep EXIF, ICC profile and XMP.", "default": true }, "filenamePrefix": { "title": "Filename prefix", "type": "string", "description": "Optional text put in front of every output file name, e.g. 'web-'. Output files are named after the source file with the new extension." }, "outputStore": { "title": "Output key-value store (name or ID)", "type": "string", "description": "Optional. Save the converted files to this store instead of the run's default store, e.g. a named store that is kept beyond the default retention period. Existing files with the same key are overwritten." } } }, "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 } } } } } } } } } }