Cut the background out of a photo

Returns a transparent PNG saved to your assets (an asset slot; when every slot is taken the oldest previous cutout is evicted to make room). Costs 1 credit, refunded when the cutout fails.

post/images/remove-background

Request

  • Base URL: https://rendry.io/api/v1
  • URL: https://rendry.io/api/v1/images/remove-background
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Headers

X-Rendry-Accountstring

Browser/OAuth current member account selector. API keys/embed credentials are bound to their persisted account and reject another account. Omitting this header selects the browser actor personal account.

Request body

urlstring

Public https image URL

storage_keystring

storage_key of your own uploaded image (from GET /assets)

filenamestring

Response

Cutout saved to assets

urlstring required

Absolute URL of the PNG; served to the owner only, like every user asset

storage_keystring required
file_namestring required
hintstring
evicted_notestring

Sent when the asset slots were full and the OLDEST previous cutout was removed to make room

image_base64string

A JPEG preview of the cutout

mime_typestring

Changes

No recorded changes to this operation across all 1 revision of this API.