{ "openapi": "3.0.1", "info": { "title": "Image Resizer API", "description": "Resize, crop, pad, and convert images by URL, base64, or key-value-store key. E-commerce, social, website, and WhatsApp presets. Batch up to 100 images per run.", "version": "1.0", "x-build-id": "WqcavAsLzRFTHlDwd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~image-resizer-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-image-resizer-api", "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/parsebird~image-resizer-api/runs": { "post": { "operationId": "runs-sync-parsebird-image-resizer-api", "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/parsebird~image-resizer-api/run-sync": { "post": { "operationId": "run-sync-parsebird-image-resizer-api", "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": [ "images" ], "properties": { "images": { "title": "Images", "type": "array", "description": "1 to 100 image objects. Each needs exactly one of `url`, `base64`, or `keyValueStoreKey`. Add `id` and/or `filename` for stable matching in the output." }, "combineImages": { "title": "Combine images", "type": "boolean", "description": "Combine 2 or 3 source images into a single output image side by side, then apply the size/fit settings below to the combined result.", "default": false }, "targetPreset": { "title": "Target preset", "enum": [ "custom", "ecommerce_square", "website_thumbnail", "social_square", "whatsapp_carousel", "whatsapp_catalog_thumbnail", "whatsapp_template_header" ], "type": "string", "description": "A preset sets width, height, and fit for a common layout. Choose Custom to set width/height/fit yourself.", "default": "custom" }, "width": { "title": "Width (px)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Output width in pixels. Only used when Target preset is Custom.", "default": 800 }, "height": { "title": "Height (px)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Output height in pixels. Only used when Target preset is Custom.", "default": 600 }, "fit": { "title": "Fit", "enum": [ "cover", "contain", "fill", "inside", "outside" ], "type": "string", "description": "How the image fills the target box. Only used when Target preset is Custom.", "default": "cover" }, "position": { "title": "Position", "enum": [ "center", "top", "bottom", "left", "right", "top-left", "top-right", "bottom-left", "bottom-right" ], "type": "string", "description": "Anchor used when cropping (Cover) or placing the image on padding (Contain).", "default": "center" }, "paddingMode": { "title": "Padding mode", "enum": [ "solid", "blur", "edge_extend" ], "type": "string", "description": "How to fill extra space left by Contain fit, or by transparent areas in formats that don't support alpha.", "default": "solid" }, "backgroundColor": { "title": "Background color", "type": "string", "description": "Hex color used for solid padding, and to flatten transparent areas when the output format has no alpha channel (e.g. JPEG).", "default": "#FFFFFF" }, "outputFormat": { "title": "Output format", "enum": [ "webp", "jpeg", "png", "avif", "gif", "tiff", "original" ], "type": "string", "description": "File format for every generated image.", "default": "webp" }, "quality": { "title": "Quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "Quality for lossy formats (JPEG, WebP, AVIF), 1-100. Ignored for PNG, GIF, and TIFF.", "default": 80 }, "maxFileSizeMb": { "title": "Max file size (MB)", "minimum": 0.1, "maximum": 50, "type": "number", "description": "Optional. For JPEG, WebP, or AVIF output, re-encode at a lower quality until the file is under this size. Leave empty for no limit. Some presets imply a limit (e.g. WhatsApp) unless you set one here." }, "preserveMetadata": { "title": "Preserve metadata", "type": "boolean", "description": "Keep EXIF and other source metadata in the output. Off by default, which also produces smaller files.", "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 } } } } } } } } } }