{ "uuid": "0f96a898-9721-44af-afc9-dc9aaed724be", "lastMigration": 29, "name": "Background Removal API", "endpointPrefix": "v1.0", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "72f22487-03f2-4c52-bb2a-7d3203d21172", "documentation": "Fetch credit balance and free API calls.", "method": "get", "endpoint": "account", "responses": [ { "uuid": "e3e75e47-5b8e-4e27-9ff8-05fee89c9251", "body": "", "latency": 0, "statusCode": 200, "label": "", "headers": [{ "key": "Content-Type", "value": "*/*" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "eb753f32-d17e-4632-8a00-c6b39e38163b", "body": "", "latency": 0, "statusCode": 403, "label": "Error: Authentication failed", "headers": [{ "key": "Content-Type", "value": "*/*" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2787445a-ad0d-497e-b12f-811fa13370c9", "body": "", "latency": 0, "statusCode": 429, "label": "Error: Rate limit exceeded", "headers": [{ "key": "Content-Type", "value": "*/*" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d226a20c-a167-40c5-b548-4f44c0fdd17a", "documentation": "Submit an image to the remove.bg Improvement program\n* Contribute an image that remove.bg is currently not able to remove the background from properly\n* Help us make remove.bg better\n* Get better results for similiar images in the future\n\nNotes:\n * By submitting images through the API you agree to the Improvement Program Conditions\n * File size: up to 12MB\n * up to 100 files per day (up to 1000 for Enterprise customers).
Higher Rate Limits are available upon request.\n\nRequires either an API Key to be provided in the `X-API-Key` request header or an OAuth 2.0 access token to be provided in the `Authorization` request header.\n\nPlease note that submissions are used on a best-effort basis and the extent of expected improvement varies depending on many factors, including the number of provided images, their complexity and visual similarity. Improvements usually take several weeks to become effective.\n", "method": "post", "endpoint": "improve", "responses": [ { "uuid": "cbd50a26-6532-48c1-b481-fb450d23dd48", "body": "", "latency": 0, "statusCode": 200, "label": "Image submitted", "headers": [{ "key": "Content-Type", "value": "*/*" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "70a488fa-8ccd-462e-9e18-1fa39cd5da58", "body": "", "latency": 0, "statusCode": 400, "label": "Error: Invalid parameters or input file unprocessable", "headers": [{ "key": "Content-Type", "value": "*/*" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bfcbdf7c-a51f-4c92-ae31-0931696f639f", "body": "", "latency": 0, "statusCode": 403, "label": "Error: Authentication failed", "headers": [{ "key": "Content-Type", "value": "*/*" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "03ed5d21-ff5e-469f-9770-6c415074f363", "body": "", "latency": 0, "statusCode": 429, "label": "Error: Rate limit exceeded", "headers": [{ "key": "Content-Type", "value": "*/*" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5f7b8a7c-8eb9-444c-9d10-65aea43d75a7", "documentation": "Remove the background of an image", "method": "post", "endpoint": "removebg", "responses": [ { "uuid": "2a773bcf-7573-4ed3-8003-af89ad579a4a", "body": "{\n \"data\": {\n \"result_b64\": \"iVBORw0KGgoAAAANSUhEUgAAAIsAAACFC...\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Image background removed", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Credits-Charged", "value": "" }, { "key": "X-Height", "value": "" }, { "key": "X-Type", "value": "" }, { "key": "X-Width", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8af4eb32-87f3-4d09-b157-c26d7773c2f7", "body": "", "latency": 0, "statusCode": 400, "label": "Error: Invalid parameters or input file unprocessable (no credits charged)", "headers": [{ "key": "Content-Type", "value": "*/*" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0038c12a-f564-49e3-bc9e-062956c0b06c", "body": "", "latency": 0, "statusCode": 402, "label": "Error: Insufficient credits (no credits charged)", "headers": [{ "key": "Content-Type", "value": "*/*" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0baac8f0-f9f9-43ee-8158-4f11b025a7ae", "body": "", "latency": 0, "statusCode": 403, "label": "Error: Authentication failed (no credits charged)", "headers": [{ "key": "Content-Type", "value": "*/*" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "96614ac8-c883-4e93-8a24-66990a17814c", "body": "", "latency": 0, "statusCode": 429, "label": "Error: Rate limit exceeded (no credits charged)", "headers": [{ "key": "Content-Type", "value": "*/*" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "72f22487-03f2-4c52-bb2a-7d3203d21172" }, { "type": "route", "uuid": "d226a20c-a167-40c5-b548-4f44c0fdd17a" }, { "type": "route", "uuid": "5f7b8a7c-8eb9-444c-9d10-65aea43d75a7" } ] }