Pricing
from $7.00 / 1,000 results
Pricing
from $7.00 / 1,000 results
Rating
0.0
(0)
Developer
Elmehdi felaouss
Actor stats
0
Bookmarked
3
Total users
0
Monthly active users
16 days ago
Last modified
Categories
Share
You can access the background remover programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "0.0", "x-build-id": "kaqM1KXTEkaJ1kqh9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ainz~background-remover/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ainz-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/ainz~background-remover/runs": { "post": { "operationId": "runs-sync-ainz-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/ainz~background-remover/run-sync": { "post": { "operationId": "run-sync-ainz-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", "properties": { "Image": { "title": "Upload Image", "type": "string", "description": "Upload an image to process" }, "maxResolution": { "title": "Maximum resolution", "minimum": 512, "maximum": 4096, "type": "integer", "description": "Maximum resolution for the output image (in pixels)", "default": 2048 }, "preserveTransparency": { "title": "Preserve transparency", "type": "boolean", "description": "Keep transparent areas from the original image (useful for images that already have transparent elements)", "default": false }, "backgroundColor": { "title": "Background Color", "pattern": "^(#[0-9A-Fa-f]{6}|rgb\\(\\d{1,3},\\s*\\d{1,3},\\s*\\d{1,3}\\)|[a-zA-Z]+)?$", "type": "string", "description": "Background color for the processed image. Can be a hex color (#FFFFFF), RGB (rgb(255,255,255)), or color name (white). Leave empty for transparent background.", "default": "" }, "backgroundImage": { "title": "Background Image", "type": "string", "description": "Upload a background image to composite behind the processed image. This will override backgroundColor if provided." }, "outputFormat": { "title": "Output format", "enum": [ "png", "jpg", "jpeg", "webp" ], "type": "string", "description": "Format for the output image", "default": "png" }, "compressionOptions": { "title": "Compression Options", "type": "object", "description": "Configure compression settings for the output image", "properties": { "quality": { "title": "Image Quality", "type": "integer", "description": "Quality for JPG/WebP output (1-100), where 100 is highest quality", "minimum": 1, "maximum": 100, "default": 80, "editor": "number" }, "lossless": { "title": "Lossless WebP", "type": "boolean", "description": "Use lossless compression for WebP output", "default": false }, "compressionLevel": { "title": "PNG Compression Level", "type": "integer", "description": "PNG compression level (0-9), where 9 is maximum compression", "minimum": 0, "maximum": 9, "default": 6, "editor": "number" } } }, "verboseOutput": { "title": "Verbose output", "type": "boolean", "description": "Include detailed processing information in the response", "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 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for background remover from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: