Adobe Photoshop · JSON Structure

Adobe Photoshop Api Remove Background Request Structure

RemoveBackgroundRequest from Adobe Photoshop API

Type: object Properties: 6 Required: 2
AI/MLCreative CloudImage EditingPhotoshopPluginsREST APIScripting

RemoveBackgroundRequest is a JSON Structure definition published by Adobe Photoshop, describing 6 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

image mode output trim backgroundColor colorDecontamination

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adobe-photoshop/refs/heads/main/json-structure/adobe-photoshop-api-remove-background-request-structure.json",
  "name": "RemoveBackgroundRequest",
  "description": "RemoveBackgroundRequest from Adobe Photoshop API",
  "type": "object",
  "properties": {
    "image": {
      "type": "object",
      "required": [
        "source"
      ],
      "properties": {
        "source": {
          "type": "object",
          "required": [
            "url"
          ],
          "properties": {
            "url": {
              "type": "string",
              "description": "Pre-signed GET URL of the source image."
            }
          }
        }
      }
    },
    "mode": {
      "type": "string",
      "enum": [
        "cutout",
        "mask"
      ],
      "default": "cutout",
      "description": "cutout removes the background, mask returns a grayscale mask.",
      "example": "cutout"
    },
    "output": {
      "type": "object",
      "properties": {
        "mediaType": {
          "type": "string",
          "enum": [
            "image/jpeg",
            "image/png"
          ],
          "description": "Output format."
        }
      }
    },
    "trim": {
      "type": "boolean",
      "default": false,
      "description": "Whether to trim whitespace around the subject.",
      "example": true
    },
    "backgroundColor": {
      "type": "object",
      "description": "Optional replacement background color.",
      "properties": {
        "red": {
          "type": "int32",
          "minimum": 0,
          "maximum": 255
        },
        "green": {
          "type": "int32",
          "minimum": 0,
          "maximum": 255
        },
        "blue": {
          "type": "int32",
          "minimum": 0,
          "maximum": 255
        },
        "alpha": {
          "type": "double",
          "minimum": 0,
          "maximum": 1
        }
      }
    },
    "colorDecontamination": {
      "type": "int32",
      "minimum": 0,
      "maximum": 1,
      "description": "Level of color decontamination to apply.",
      "example": 1920
    }
  },
  "required": [
    "image",
    "output"
  ]
}