{ "openapi": "3.0.1", "info": { "title": "AI Background Remover API: Remove BG to Transparent PNG", "description": "Remove background from images in bulk with AI: transparent PNG or WebP cutouts, or white background JPG for Amazon and Shopify product photos. Background remover API and eraser, remove bg from image URLs, change background color, crop or square, full resolution up to 16 MP. $0.0013 per photo.", "version": "0.1", "x-build-id": "1fYEtsxJxa0oNymSH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/deapi~background-remover/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-deapi-background-remover", "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/deapi~background-remover/runs": { "post": { "operationId": "runs-sync-deapi-background-remover", "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/deapi~background-remover/run-sync": { "post": { "operationId": "run-sync-deapi-background-remover", "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", "type": "array", "description": "Direct links to the images to remove the background from — each link must open the picture itself, without a login. **Formats: JPG/JPEG, PNG, WebP, BMP, GIF (first frame) and TIFF**, up to **25 MB** and **25 megapixels** per file (JPG up to 50 MP; 16 MP for transparent or 16-bit images), at least 16 px and at most 16,384 px on a side. Product photos, portraits, people, pets, cars, logos and graphics all work. Results keep the **original resolution up to 16 MP** (8 MP for WebP); larger pictures are scaled down to that, keeping their proportions. Plain strings or objects with a `url` field both work. **Free plan: 10 images per run and 50 per calendar month (resets 00:00 UTC on the 1st), within a daily capacity shared by all free users. Paid plans remove the free-plan limits.**", "items": { "type": "string" } }, "outputFormat": { "title": "Output format", "enum": [ "png", "webp", "jpg" ], "type": "string", "description": "File format of the results. **PNG** keeps a transparent background in lossless quality — best for design tools, Canva, Photoshop, stickers and logos. **WebP** keeps the transparent background in files about five times smaller — best for websites and online shops. **JPG** has no transparency: the background becomes white (or the color below) — best for Amazon, eBay and marketplace listings that require a white background. The price is the same for every format; WebP output stops at 8 MP, so it is never more.", "default": "png" }, "backgroundColor": { "title": "Background color", "type": "string", "description": "Leave empty for a transparent background. Or put the cutout on a solid color: a hex code such as `#FFFFFF` (pure white, as Amazon requires for main images), `#F5F5F5` (light gray) or a color name such as `white` or `black`. JPG output is always on a solid color and uses white when this is empty." }, "cropToSubject": { "title": "Crop to subject", "type": "boolean", "description": "Trim the empty space around the subject, leaving the margin set below. A side where the subject is cut by the photo's own edge keeps no margin.", "default": false }, "squareCanvas": { "title": "Square canvas (1:1)", "type": "boolean", "description": "Center the subject on a square canvas with the margin set below — the 1:1 format used by Amazon, Shopify, Etsy and Instagram product images. Combine with JPG or a background color for white-background marketplace photos.", "default": false }, "marginPercent": { "title": "Margin around the subject (%)", "minimum": 0, "maximum": 40, "type": "integer", "description": "Space left around the subject when cropping or using a square canvas, as a percentage of the subject's longer side. 5 % is a tight product shot; for a product filling about 85 % of the frame, as Amazon recommends, use about 8 %.", "default": 5 }, "maxConcurrency": { "title": "Images in parallel", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many images are processed at the same time. It has no effect on price.", "default": 5 } } }, "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 } } } } } } } } } }