{ "openapi": "3.0.1", "info": { "title": "Image Compression & WebP AVIF Converter (Erdnal Media)", "description": "Bulk image compressor and image compression API: convert JPG/PNG to WebP or AVIF from image URLs, resize, set quality, strip metadata, without visible quality loss. Pay only for successful images.", "version": "1.0", "x-build-id": "IDTfUlTEWvCNxrvve" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/erdnal_api~erdnal-media-image-optimizer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-erdnal_api-erdnal-media-image-optimizer", "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/erdnal_api~erdnal-media-image-optimizer/runs": { "post": { "operationId": "runs-sync-erdnal_api-erdnal-media-image-optimizer", "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/erdnal_api~erdnal-media-image-optimizer/run-sync": { "post": { "operationId": "run-sync-erdnal_api-erdnal-media-image-optimizer", "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": [ "imageUrls" ], "properties": { "imageUrls": { "title": "Image URLs", "minItems": 1, "maxItems": 1000, "type": "array", "description": "Public https:// URLs of the JPEG or PNG images to compress, one per line (1 to 1,000 per run, 15 MB per image). Use the final image URL: redirects are not followed. Example: the image links exported from your store or collected by a scraper.", "items": { "type": "string" } }, "format": { "title": "Output format", "enum": [ "webp", "avif", "jpeg", "png" ], "type": "string", "description": "Output format. WebP (default): the best balance of file size, speed and browser support. AVIF: the smallest files, but slower to encode, so it costs 3 times more credits. JPEG: for email newsletters and old software. PNG: lossless, for logos and screenshots.", "default": "webp" }, "width": { "title": "Maximum width (px)", "minimum": 1, "maximum": 8000, "type": "integer", "description": "Maximum width in pixels. The image is scaled down to fit (aspect ratio kept) and never enlarged unless you allow it. Leave empty to keep the original size. Tip: use the width at which the image is displayed (e.g. 1600 for a full-width web image): smaller outputs are lighter and cost fewer credits." }, "height": { "title": "Maximum height (px)", "minimum": 1, "maximum": 8000, "type": "integer", "description": "Maximum height in pixels, used like width. Setting both width and height makes the image fit inside that box, and also caps the maximum price per image. Leave empty to keep the original size." }, "quality": { "title": "Quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "Compression quality from 1 to 100: lower means smaller files with more visible artefacts. Leave empty for tuned defaults: WebP 80, AVIF 60, JPEG 82 (good visual quality for the web). Ignored for PNG, which is lossless." }, "keepAspectRatio": { "title": "Keep aspect ratio", "type": "boolean", "description": "On (default): the image keeps its proportions and fits inside width × height. Off: the image is resized to exactly width × height (both required), which stretches it if the proportions differ; it is not cropped.", "default": true }, "allowUpscale": { "title": "Allow upscaling", "type": "boolean", "description": "Off (default): images smaller than the requested width or height are left at their size, so quality is never degraded by enlarging. On: small images are enlarged to the requested size.", "default": false }, "keepMetadata": { "title": "Keep metadata", "type": "boolean", "description": "Off (default): EXIF, XMP and comments are removed, including the GPS location of phone photos, for privacy and smaller files. On: keep them (for example to preserve copyright or camera data). The ICC colour profile is always kept, so colours stay correct.", "default": false } } }, "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 } } } } } } } } } }