Adobe Photoshop · Schema

DocumentCreateRequest

DocumentCreateRequest from Adobe Photoshop API

AI/MLCreative CloudImage EditingPhotoshopPluginsREST APIScripting

Properties

Name Type Description
options object
outputs array
View JSON Schema on GitHub

JSON Schema

adobe-photoshop-api-document-create-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adobe-photoshop/refs/heads/main/json-schema/adobe-photoshop-api-document-create-request-schema.json",
  "title": "DocumentCreateRequest",
  "description": "DocumentCreateRequest from Adobe Photoshop API",
  "type": "object",
  "properties": {
    "options": {
      "type": "object",
      "required": [
        "document"
      ],
      "properties": {
        "document": {
          "type": "object",
          "required": [
            "width",
            "height"
          ],
          "properties": {
            "width": {
              "type": "integer",
              "description": "Document width in pixels."
            },
            "height": {
              "type": "integer",
              "description": "Document height in pixels."
            },
            "resolution": {
              "type": "integer",
              "default": 72,
              "description": "Document resolution in PPI."
            },
            "fill": {
              "type": "string",
              "enum": [
                "white",
                "transparent",
                "backgroundColor"
              ],
              "default": "white"
            },
            "mode": {
              "type": "string",
              "enum": [
                "rgb",
                "cmyk",
                "grayscale"
              ],
              "default": "rgb"
            },
            "depth": {
              "type": "integer",
              "enum": [
                8,
                16,
                32
              ],
              "default": 8,
              "description": "Bit depth per channel."
            }
          }
        },
        "layers": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/LayerOperation"
          }
        }
      }
    },
    "outputs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StorageOutput"
      }
    }
  },
  "required": [
    "options",
    "outputs"
  ]
}