{ "openapi": "3.0.1", "info": { "title": "Background Remover: transparent PNG cutouts in bulk", "description": "Removes the background from every image URL you list with BiRefNet, running inside the actor with no outside API. Transparent PNG or WebP at full resolution, or any solid background color, with optional crop to the subject and a black and white mask.", "version": "0.1", "x-build-id": "t7gakwt3tgUGEYyyX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/examsens.ai~background-remover/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-examsens.ai-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/examsens.ai~background-remover/runs": { "post": { "operationId": "runs-sync-examsens.ai-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/examsens.ai~background-remover/run-sync": { "post": { "operationId": "run-sync-examsens.ai-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 image files (JPEG, PNG, WebP, GIF, BMP, TIFF and other formats Pillow reads).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "outputFormat": { "title": "Output format", "enum": [ "png", "webp", "jpeg" ], "type": "string", "description": "PNG and WebP keep transparency. JPEG has none, so it always gets a background color (white unless you set one).", "default": "png" }, "backgroundColor": { "title": "Background color", "type": "string", "description": "Leave empty for a transparent background. Or a CSS color such as #ffffff, white or #00000080 to place the subject on a solid color." }, "refineEdges": { "title": "Clean edge colors", "type": "boolean", "description": "Removes the old background's color from hair, fur and other soft edges.", "default": true }, "cropToSubject": { "title": "Crop to subject", "type": "boolean", "description": "Trim the empty area around the subject.", "default": false }, "cropMargin": { "title": "Crop margin (px)", "minimum": 0, "maximum": 2000, "type": "integer", "description": "Space to keep around the subject when cropping.", "default": 0 }, "outputMask": { "title": "Also save the mask", "type": "boolean", "description": "Save a black and white PNG mask next to each cutout: white is the subject, black is the background.", "default": false }, "quality": { "title": "Quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1 to 100 for JPEG and WebP. PNG ignores this.", "default": 90 }, "maxInputMegapixels": { "title": "Largest source image (megapixels)", "minimum": 0.01, "maximum": 25, "type": "number", "description": "Source images with more pixels than this get an error item and are not charged. The ceiling is 25.", "default": 16 }, "maxFileSizeMb": { "title": "Maximum file size (MB)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Skip source files larger than this, with an error item.", "default": 25 } } }, "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 } } } } } } } } } }