Images

Submit a background-removal job

Two tiers behind the model discriminator: bria-bg-remove (state-of-the-art alpha matting, commercially licensed) and 851-bg-remove (sub-cent fast path). Both return a transparent PNG.

post/v2/images/background-remove

Request

  • Base URL: https://api.apiframe.ai
  • URL: https://api.apiframe.ai/v2/images/background-remove
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Headers

Idempotency-Keystring

Optional client-supplied key (max 255 chars). Replaying the same key within 24 hours returns the original job rather than creating a duplicate. Strongly recommended for any non-idempotent network: cron jobs, browser retries, mobile clients.

Request body

OR

Response

Job accepted and queued. Track via GET /v2/jobs/{id} or webhook.

jobIdstring uuid required
status'QUEUED' | 'PROCESSING' | 'COMPLETED' | 'FAILED' required

Status at the moment the job record was persisted. Almost always QUEUED; idempotent replays may return the original status.

Changes

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