POST api/v4/media_files/:s3_key/remove_bg

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : 'Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION'

Success response body ↑

{
  "success": true,
  "result": Base64String
}

Params

Param name Description
s3_key
required

Validations:

  • Must be a String
format_type
required

Validations:

  • Must be a String
location
required

From what location was requested removeBG

Validations:

  • Must be one of: gallery, templateEditor, signUpForm.
template_id
optional

REQUIRED if location is templateEditor

Validations:

  • Must be a Integer