remove background

Remove the background from an image or a video. An image is saved as a transparent PNG beside the original (a GIF as a still). A video keeps its subject and drops what is behind them, saved as a WebM with transparency at up to 1080p, with its sound; it holds on a presenter and comes apart on fast motion, and takes up to 3 minutes at a time. For a video clip on a timeline, timeline_id and clip_id cut only the stretch the clip plays: as “clip” (default) takes its slot, as “mask” attaches the cutout as a subject mask over the still-playing clip, the one mask that follows a moving person. Returns a job; refunded when it fails. Credits.

POST

/

tools

/

remove_background

remove background

curl --request POST \
  --url https://eversince.ai/api/v1/tools/remove_background \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ref": "<string>",
  "idempotency_key": "<string>"
}
'

import requests

url = "https://eversince.ai/api/v1/tools/remove_background"

payload = {
    "ref": "<string>",
    "idempotency_key": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ref: '<string>', idempotency_key: '<string>'})
};

fetch('https://eversince.ai/api/v1/tools/remove_background', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ok": true,
  "data": {},
  "meta": {
    "request_id": "<string>",
    "cost": {},
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  },
  "media": [
    {}
  ]
}

{
  "ok": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  }
}

Authorizations

Authorization

string

header

required

An API key (es_live_…) from Settings, under API keys, or an OAuth access token.

Headers

Idempotency-Key

string

Retry a paid dispatch safely: the same key returns the job already dispatched instead of charging again.

x-workspace-id

string

The workspace this one call acts in, when it is not the key's own.

Body

application/json

ref

string

required

idempotency_key

string

required

A key you mint per dispatch (a UUID). The same key on a retry returns the job already dispatched instead of charging again; a new attempt takes a new key.

Required string length: 1 - 200

timeline_id

string

Video only. With clip_id: only that clip's trimmed stretch is cut, and the result lands on it. Alone: the result is attached to this timeline.

clip_id

string

Video only, with timeline_id: the clip whose trimmed stretch is cut, and which the result replaces or carries a mask for.

as

enum<string>

Video on a clip: "clip" (default) takes the clip's slot; "mask" leaves the clip playing and attaches the cutout as a subject mask on it.

Available options:

clip,

mask

context

string

Optional: one sentence shown to the user beside this action.

Maximum string length: 600

Response

Done, or a job started for work that runs longer (follow it with get_jobs).

ok

any

required

data

object

required

meta

object

required

Show child attributes

media

object[]

remove background

curl --request POST \
  --url https://eversince.ai/api/v1/tools/remove_background \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ref": "<string>",
  "idempotency_key": "<string>"
}
'

import requests

url = "https://eversince.ai/api/v1/tools/remove_background"

payload = {
    "ref": "<string>",
    "idempotency_key": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ref: '<string>', idempotency_key: '<string>'})
};

fetch('https://eversince.ai/api/v1/tools/remove_background', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "ok": true,
  "data": {},
  "meta": {
    "request_id": "<string>",
    "cost": {},
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  },
  "media": [
    {}
  ]
}

{
  "ok": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "retryable": true,
    "suggested_action": "<string>",
    "cloud_processing": {
      "ran_on": "cloud",
      "minutes": 123,
      "queued_minutes": 123,
      "left_minutes": 123,
      "bought_minutes": 123,
      "note": "<string>"
    }
  }
}