{ "openapi": "3.0.1", "info": { "title": "Image Upscaler API & Background Remover (Batch 2x/4x)", "description": "Image upscaler API: batch upscale images 2x/4x and remove backgrounds from image URLs or datasets with open models on CPU. Returns PNG/WebP/JPEG links, sizes and status per image. From $1 per 1,000 images.", "version": "0.1", "x-build-id": "gDZ9g06DCXnPrjcgS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/leadsbrary~image-upscaler-background-remover-onnx/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-leadsbrary-image-upscaler-background-remover-onnx", "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/leadsbrary~image-upscaler-background-remover-onnx/runs": { "post": { "operationId": "runs-sync-leadsbrary-image-upscaler-background-remover-onnx", "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/leadsbrary~image-upscaler-background-remover-onnx/run-sync": { "post": { "operationId": "run-sync-leadsbrary-image-upscaler-background-remover-onnx", "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 JPEG, PNG or WebP images. Use this and/or a dataset below.", "items": { "type": "string" } }, "datasetId": { "title": "Dataset ID (optional)", "type": "string", "description": "ID of an Apify dataset whose rows contain image URLs (for example the output of a product scraper)." }, "datasetUrlField": { "title": "URL field in the dataset", "type": "string", "description": "Field holding the image URL; dot paths allowed (e.g. images.0). A field containing an array of URLs is expanded.", "default": "imageUrl" }, "mode": { "title": "Mode", "enum": [ "upscale", "remove-background", "both" ], "type": "string", "description": "upscale: enlarge. remove-background: transparent cut-out. both: cut-out then enlarge.", "default": "upscale" }, "scale": { "title": "Upscale factor", "minimum": 2, "maximum": 4, "type": "integer", "description": "2 or 4 (ignored for remove-background).", "default": 2 }, "outputFormat": { "title": "Output format", "enum": [ "png", "webp", "jpeg" ], "type": "string", "description": "Transparency needs png or webp; jpeg is flattened onto the background colour (white by default).", "default": "png" }, "backgroundColor": { "title": "Background colour", "type": "string", "description": "Optional hex colour such as #ffffff to replace transparency after background removal." }, "maxInputMegapixels": { "title": "Max input megapixels", "minimum": 0.1, "maximum": 4, "type": "number", "description": "Larger inputs are downscaled (or rejected, see below) to bound time and cost. 0.1 to 4.", "default": 0.5 }, "downscaleLargeInputs": { "title": "Downscale large inputs", "type": "boolean", "description": "If off, images above the megapixel limit return an unbilled TOO_LARGE row.", "default": true }, "maxResults": { "title": "Maximum images", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Process at most this many images (also caps your spending).", "default": 10 }, "maxConcurrency": { "title": "Parallel images", "minimum": 1, "maximum": 4, "type": "integer", "description": "Keep low: processing is CPU and memory heavy.", "default": 1 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Only needed if the image host blocks direct requests; datacenter proxy was enough in testing.", "default": { "useApifyProxy": 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 } } } } } } } } } }