Skip to content

Migrating to the RMBG PRO API gateway

Use https://rmbg.pro/api for new integrations. Existing legacy integrations stay supported during the transition; no retirement date is set. Image routes support the existing server processing bridge and the internal gateway contract described in the release guide.

Old: https://api.rmbg.pro/v1.0.1/remove_background

New: https://rmbg.pro/api/remove-background

Authentication stays X-API-KEY. Use your account API key, never the internal service secret.

Request and response compatibility

Multipart uploads accept image and the legacy alias image_file. PNG, JPEG and WebP files are limited to 20 MB each and 40 megapixels. Background colors, background images, logo overlays, logo size and position remain supported. Both left-top and top-left style positions are accepted.

Use return_type=base64 for JSON with image_base64, or return_type=binary to save the response as an image. JSON adds request_id and usage. The gateway does not support legacy link output, AVIF output or remote image URLs; use binary/base64 with PNG, JPEG or WebP instead. No internal backend URLs are returned.

curl --fail-with-body 'https://rmbg.pro/api/remove-background' \
  -H 'X-API-KEY: YOUR_API_KEY' \
  -H 'Idempotency-Key: product-123-revision-1' \
  -F '[email protected]' \
  -F 'return_type=binary' \
  --output product-cutout.png

Credits, retries and errors

Image processing uses the configured RemoveBackground service cost, normally 1 credit. Credits are reserved before processing and refunded once if processing fails. PDF conversion costs 0 credits. API access requires an active account. Each account may send 60 requests per minute with up to 4 pending operations; 429 responses include Retry-After.

Reuse an Idempotency-Key only for identical input. Successful retries replay the saved result without another debit. Pending requests, changed input and previously failed requests return 409. After a refunded failure, use a new key to try again. A stalled pending request requires support review. Without a key, each upload is a separate operation.

Errors retain a string error field and add success=false, code and request_id. Use the HTTP status and code rather than parsing message text.

Supported operations

Background removal and replacement, plus PDF-to-text and PDF-to-Markdown. Masked object/watermark removal is available only when enabled. Standalone watermark addition, resizing and PDF editing/merge/split/compression remain website tools and are not published processing APIs.

Legacy integrations are not redirected. WordPress, Shopify, macOS, Telegram, mobile and browser-extension releases must be tested before legacy access is restricted.

API examples · Canonical OpenAPI specification