{ "openapi": "3.0.1", "info": { "title": "Image Toolkit — convert, resize, strip metadata, inspect", "description": "Batch image jobs without a design tool: convert between JPEG, PNG, WebP and AVIF, resize to a target width without upscaling, strip EXIF/GPS/XMP for privacy, or read image metadata. One dataset item per image, files in the key-value store, per-image pricing.", "version": "0.1", "x-build-id": "CFtKBohbTWzxtcRaa" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/praestat~image-toolkit/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-praestat-image-toolkit", "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/praestat~image-toolkit/runs": { "post": { "operationId": "runs-sync-praestat-image-toolkit", "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/praestat~image-toolkit/run-sync": { "post": { "operationId": "run-sync-praestat-image-toolkit", "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": [ "operation", "imageUrls" ], "properties": { "operation": { "title": "Operation", "enum": [ "convert", "resize", "strip_metadata", "info" ], "type": "string", "description": "convert changes the file format, resize scales to a target width, strip_metadata removes EXIF/GPS/XMP, info only reports metadata and writes no file.", "default": "convert" }, "imageUrls": { "title": "Image sources", "type": "array", "description": "Image URLs or local paths. One dataset item is produced per image; a broken file fails its own item and does not stop the batch.", "items": { "type": "string" } }, "targetFormat": { "title": "Target format (convert)", "enum": [ "jpg", "png", "webp", "avif" ], "type": "string", "description": "Output format for convert. jpg has no transparency, png is lossless, webp is small and keeps transparency, avif is smallest but needs AVIF support in the build (otherwise the run stops with a clear message).", "default": "jpg" }, "targetWidth": { "title": "Target width in pixels (resize)", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Desired width for resize. The height follows the aspect ratio. Images that are already narrower are left unchanged — never upscaled.", "default": 1200 }, "maxHeight": { "title": "Maximum height in pixels (resize)", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Optional ceiling for portrait images: if the height would exceed this value, the image is scaled down further and becomes narrower than targetWidth. 0 = no limit.", "default": 0 }, "jpegQuality": { "title": "JPEG/WebP/AVIF quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "Quality for lossy output (convert, resize, strip_metadata with jpg). 82 is a good default; 95 for archival, 60 for thumbnails. Ignored for PNG.", "default": 82 }, "stripFormat": { "title": "Output format (strip_metadata)", "enum": [ "png", "jpg" ], "type": "string", "description": "png (default) is lossless and cannot carry EXIF; jpg re-encodes with jpegQuality, which is smaller but lossy.", "default": "png" }, "background": { "title": "Background for transparency", "type": "string", "description": "Colour that replaces transparent areas when the target format has no alpha channel (JPEG). Accepts #rrggbb, #rgb or a CSS colour name. Default white — Pillow would otherwise flatten onto black.", "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 } } } } } } } } } }