{ "openapi": "3.0.1", "info": { "title": "Background Remover - transparent PNG cut-outs, 6 models", "description": "Remove the background from any image URL. Transparent PNG, WebP or flattened JPEG, six segmentation models, alpha matting for hair and fur.", "version": "0.1", "x-build-id": "UlC19T299NjftbnCo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/superslowsloth~background-remover/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-superslowsloth-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/superslowsloth~background-remover/runs": { "post": { "operationId": "runs-sync-superslowsloth-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/superslowsloth~background-remover/run-sync": { "post": { "operationId": "run-sync-superslowsloth-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": "One image per entry. Each is downloaded, cut out, and returned as a file URL in the dataset. The same URL listed twice is processed once. Up to 500 images per run.", "items": { "type": "string" } }, "model": { "title": "Segmentation model", "enum": [ "u2net", "u2netp", "u2net_human_seg", "isnet-general-use", "silueta", "birefnet-general" ], "type": "string", "description": "Which model decides what the subject is. u2net is the general-purpose default; u2netp is a fifth of the size and faster on simple subjects; BiRefNet is the most accurate and the slowest.", "default": "u2net" }, "outputFormat": { "title": "Output format", "enum": [ "png", "webp", "jpeg" ], "type": "string", "description": "PNG keeps transparency losslessly and is what most pipelines expect. WebP is transparent and much smaller. JPEG cannot store transparency at all, so the subject is flattened onto the background colour below.", "default": "png" }, "alphaMatting": { "title": "Alpha matting (hair, fur, fine edges)", "type": "boolean", "description": "Runs a second refinement pass over the edge. Worth it for hair, fur and semi-transparent edges; several times the compute, and billed as its own event.", "default": false }, "backgroundColor": { "title": "Background colour", "type": "string", "description": "Hex colour to put behind the subject instead of transparency, e.g. #ffffff. Leave empty to keep the background transparent. Required in effect for JPEG, which has no alpha channel - white is used if this is empty.", "default": "" }, "maskOnly": { "title": "Return the mask instead of the cut-out", "type": "boolean", "description": "Delivers the black-and-white subject mask rather than the image. Use it when your own pipeline does the compositing.", "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 } } }, "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 } } } } } } } } } }