{ "openapi": "3.0.1", "info": { "title": "WhatsApp Product Image Resizer (Carousel, Catalog, Templates)", "description": "Prepare inventory for WhatsApp sales actions & catalogs. Smart padding ensures fashion products are never cropped in Carousels or Thumbnails. Automate formatting for bulk marketing pushes. Supports all API specs (1125x600, <5MB) to maximize conversion rates.", "version": "0.3", "x-build-id": "rfrmpHRxeOlImUc5J" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/treplit~whatsapp-product-image-resizer-carousel-catalog-templates/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-treplit-whatsapp-product-image-resizer-carousel-catalog-templates", "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/treplit~whatsapp-product-image-resizer-carousel-catalog-templates/runs": { "post": { "operationId": "runs-sync-treplit-whatsapp-product-image-resizer-carousel-catalog-templates", "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/treplit~whatsapp-product-image-resizer-carousel-catalog-templates/run-sync": { "post": { "operationId": "run-sync-treplit-whatsapp-product-image-resizer-carousel-catalog-templates", "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", "targetFormat" ], "properties": { "images": { "title": "Images to Process", "minItems": 1, "maxItems": 100, "type": "array", "description": "List of images to resize. Each image must have either a URL or base64-encoded data.", "items": { "type": "object", "properties": { "url": { "title": "Image URL", "type": "string", "description": "HTTP/HTTPS URL to the source image. Must be publicly accessible." }, "data": { "title": "Base64 Data", "type": "string", "description": "Base64-encoded image data (use if URL not available). content-type header is not required in the string." }, "id": { "title": "Image ID (Optional)", "type": "string", "description": "Optional identifier for tracking this image in results. If omitted, results are returned in the same order as input URLs." } } } }, "targetFormat": { "title": "Target Format", "enum": [ "carousel", "catalog_thumbnail", "template_header" ], "type": "string", "description": "WhatsApp format to resize images to. Carousel (1.91:1) and Template Header (1.91:1) are 1125x600px. Catalog Thumbnail is 640x640px (1:1).", "default": "carousel" }, "outputFormat": { "title": "Output File Format", "enum": [ "jpeg", "png" ], "type": "string", "description": "Image format for the processed output. JPEG is recommended for photos. PNG supports transparency.", "default": "jpeg" }, "outputQuality": { "title": "JPEG Quality", "minimum": 1, "maximum": 95, "type": "integer", "description": "JPEG compression quality (1-95). Lower values reduce file size but may show artifacts. 85 is a good balance. Only applies when Output Format is JPEG.", "default": 85 }, "backgroundColor": { "title": "Background Color", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$", "type": "string", "description": "Hex color code for the padding area (the 'bars' added to fit the aspect ratio). Supports #RGB and #RRGGBB formats.", "default": "#FFFFFF" }, "expansionMode": { "title": "Expansion Mode", "enum": [ "edge_extend", "blur", "solid" ], "type": "string", "description": "Strategy for filling the empty space when the image aspect ratio doesn't match the target. 'Edge Extend' repeats the last pixel (subtle). 'Blur' creates a blurred background version. 'Solid' uses the Background Color.", "default": "edge_extend" }, "combineImages": { "title": "Combine Images", "type": "boolean", "description": "Stitch all input images side-by-side into a single output image. Useful for showing multiple product angles in one carousel card.", "default": false }, "combineSpacing": { "title": "Combine Spacing (px)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Gap width in pixels between combined images. Only used when 'Combine Images' is enabled.", "default": 20 } } }, "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 } } }, "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 } } } } } } } } } }