{ "openapi": "3.0.1", "info": { "description": "Photoshop v2 API Server for Adobe Firefly Services.", "license": { "name": "Adobe Creative API License", "url": "https://www.adobe.com/content/dam/cc/en/legal/terms/enterprise/pdfs/PSLT-AdobeCreativeAPI-WW-2024v2.pdf" }, "title": "Photoshop v2 API endpoints", "version": "2.0" }, "servers": [ { "url": "https://photoshop-api.adobe.io", "description": "Prod server." } ], "security": [ { "Authorization": [], "X-Api-Key": [] } ], "tags": [ { "description": "Photoshop APIs for image processing operations", "name": "Photoshop APIs" }, { "description": "APIs for retrieving job status information", "name": "Job Status" } ], "paths": { "/v1/auto-crop": { "post": { "description": "Generates smart crops, subject bounding boxes, and detects objects for an input image. The request is processed asynchronously. Poll GET /v2/status/{jobId} with the returned jobId for completion.", "operationId": "autoCrop", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoCropRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobAcceptedResponse" } } }, "description": "Job accepted for processing" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request - Invalid request payload" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized - Invalid or missing access token" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden - User not authorized or quota exhausted" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not found - Requested resource was not found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Validation error - Invalid input data" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too many requests - Rate limit exceeded. When present, Retry-After header (seconds) indicates delay before retrying." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "servers": [ { "description": "Production server.", "url": "https://image.adobe.io" } ], "summary": "Auto crop", "tags": [ "Photoshop APIs" ] } }, "/v2/create-artboard": { "post": { "operationId": "createArtboard", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateArtboardRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobAcceptedResponse" } } }, "description": "Job accepted for processing" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request - Invalid request payload" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized - Invalid or missing access token" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden - User not authorized or quota exhausted" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Validation error - Invalid input data" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too many requests - Rate limit exceeded. When present, Retry-After header (seconds) indicates delay before retrying." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Create an artboard", "tags": [ "Photoshop APIs" ] } }, "/v2/create-composite": { "post": { "operationId": "createComposite", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCompositeRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobAcceptedResponse" } } }, "description": "Job accepted for processing" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request - Invalid request payload" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized - Invalid or missing access token" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden - User not authorized or quota exhausted" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Validation error - Invalid input data" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too many requests - Rate limit exceeded. When present, Retry-After header (seconds) indicates delay before retrying." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Create or edit a composite", "tags": [ "Photoshop APIs" ] } }, "/v2/edit": { "post": { "operationId": "edit", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobAcceptedResponse" } } }, "description": "Job accepted for processing" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request - Invalid request payload" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized - Invalid or missing access token" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden - User not authorized or quota exhausted" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Validation error - Invalid input data" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too many requests - Rate limit exceeded. When present, Retry-After header (seconds) indicates delay before retrying." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Edit an image with various adjustments", "tags": [ "Photoshop APIs" ] } }, "/v2/execute-actions": { "post": { "operationId": "executeActions", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionsRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobAcceptedResponse" } } }, "description": "Job accepted for processing" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request - Invalid request payload" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized - Invalid or missing access token" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden - User not authorized or quota exhausted" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Validation error - Invalid input data" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too many requests - Rate limit exceeded. When present, Retry-After header (seconds) indicates delay before retrying." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Execute Photoshop actions, scripts, and transformations", "tags": [ "Photoshop APIs" ] } }, "/v2/generate-manifest": { "post": { "operationId": "generateManifest", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateManifestRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobAcceptedResponse" } } }, "description": "Job accepted for processing" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request - Invalid request payload" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized - Invalid or missing access token" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden - User not authorized or quota exhausted" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Validation error - Invalid input data" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too many requests - Rate limit exceeded. When present, Retry-After header (seconds) indicates delay before retrying." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Generate a manifest for given input image", "tags": [ "Photoshop APIs" ] } }, "/v2/status/{jobId}": { "get": { "description": "Retrieves the current status and details of a specific job including metadata, outputs, and processing information. Use this endpoint to poll jobs submitted to Photoshop v2 operations and POST /v1/auto-crop.", "operationId": "getJobStatus", "parameters": [ { "description": "Unique identifier for the job to retrieve status information", "example": "550e8400-e29b-41d4-a716-446655440000", "in": "path", "name": "jobId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobStatusResponse" } } }, "description": "Job status retrieved successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request - Invalid job ID format or missing required parameters" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized - Invalid or missing access token" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not found - Job with the specified ID does not exist" } }, "summary": "Get Job Status", "tags": [ "Job Status" ] } }, "/v2/remove-background": { "servers": [ { "url": "https://image.adobe.io", "description": "Photoshop image production host." } ], "post": { "description": "This endpoint allows you to remove the background from an image. The request is processed asynchronously and the status of the running job can be checked with the Get Job Status endpoint. This path uses the Photoshop image production host; other endpoints in this reference default to the Photoshop API production host unless otherwise noted.", "operationId": "removeBackground", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveBackgroundV2Request" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobAcceptedResponse" } } }, "description": "Job accepted for processing" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request - Invalid request payload" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized - Invalid or missing access token" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden - User not authorized or quota exhausted" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Validation error - Invalid input data" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too many requests - Rate limit exceeded. When present, Retry-After header (seconds) indicates delay before retrying." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal server error" } }, "summary": "Remove the background from an image", "tags": [ "Photoshop APIs" ] } } }, "components": { "schemas": { "ActionResource": { "type": "object", "description": "Single Photoshop action resource (.atn or inline actionJSON). When present, the 'source' field is required.", "properties": { "actionName": { "type": "string", "description": "The name of a specific action to execute within the action set. If omitted, all actions in the file are executed." }, "source": { "description": "Source for the action. Can be external file reference or inline actionJSON content. Inline actionJSON can use placeholders `__ADDITIONAL_CONTENTS_PATH_0__`, `__ADDITIONAL_CONTENTS_PATH_1__`, etc. which will be replaced at runtime with the file paths of the corresponding additional images. Legacy format `ACTION_JSON_OPTIONS_ADDITIONAL_IMAGES_0` is also supported for backward compatibility.", "oneOf": [ { "$ref": "#/components/schemas/CreativeCloudFileIdResourceInput" }, { "$ref": "#/components/schemas/CreativeCloudResourceInput" }, { "$ref": "#/components/schemas/InlineContentResourceInput" }, { "$ref": "#/components/schemas/LightroomResourceInput" }, { "$ref": "#/components/schemas/UrlResourceInput" } ] } }, "required": [ "source" ] }, "ActionsOptions": { "type": "object", "properties": { "actions": { "type": "array", "description": "List of Photoshop actions. Can be .atn files or inline actionJSON. Optional.", "items": { "$ref": "#/components/schemas/ActionResource" }, "maxItems": 10, "minItems": 0 }, "additionalContents": { "type": "array", "description": "List of additional resources. Optional. These images, js, brushes can be referenced in inline actionJSON or in UXPusing placeholders `__ADDITIONAL_CONTENTS_PATH_0__`, `__ADDITIONAL_CONTENTS_PATH_1__`, etc. based on their array index.", "items": { "$ref": "#/components/schemas/AdditionalContentResource" }, "maxItems": 25, "minItems": 0 }, "brushes": { "type": "array", "description": "List of brush resources. External references only. Optional.", "items": { "$ref": "#/components/schemas/BrushResource" }, "maxItems": 10, "minItems": 0 }, "fontOptions": { "$ref": "#/components/schemas/FontOptions", "description": "Font options configuration. Optional." }, "patterns": { "type": "array", "description": "List of pattern resources. External references only. Optional.", "items": { "$ref": "#/components/schemas/PatternResource" }, "maxItems": 10, "minItems": 0 }, "uxp": { "$ref": "#/components/schemas/UxpResource", "description": "An UXP plugin script that can be executed, Optional." } } }, "ActionsRequest": { "type": "object", "properties": { "image": { "$ref": "#/components/schemas/ImageSource", "description": "The image input for the actions operation. Required." }, "options": { "$ref": "#/components/schemas/ActionsOptions", "description": "Options configuration for the actions execution. At least one of actions or uxp is required." }, "outputs": { "type": "array", "description": "List of output asset details. Required. Maximum of 25 outputs allowed.", "items": { "oneOf": [ { "$ref": "#/components/schemas/JpegOutput" }, { "$ref": "#/components/schemas/JsonOutput" }, { "$ref": "#/components/schemas/PngOutput" }, { "$ref": "#/components/schemas/PsdOutput" }, { "$ref": "#/components/schemas/PsdcOutput" }, { "$ref": "#/components/schemas/TiffOutput" } ] }, "maxItems": 25, "minItems": 1 } }, "required": [ "image", "options", "outputs" ] }, "AddAdjustmentLayer": { "allOf": [ { "$ref": "#/components/schemas/OperationBase" }, { "type": "object", "properties": { "adjustments": { "description": "Adjustment settings to apply. Must specify exactly one adjustment type (brightness_contrast, hue_saturation, exposure, or color_balance).", "oneOf": [ { "$ref": "#/components/schemas/BrightnessContrastAdjustments" }, { "$ref": "#/components/schemas/ColorBalanceAdjustments" }, { "$ref": "#/components/schemas/ExposureAdjustments" }, { "$ref": "#/components/schemas/HueSaturationAdjustments" } ] }, "blendOptions": { "$ref": "#/components/schemas/BlendOptions", "description": "Blend options for the layer" }, "isClipped": { "type": "boolean", "description": "Whether the layer is clipped. Defaults to false when adding layers." }, "isVisible": { "type": "boolean", "description": "Whether the layer is visible. Defaults to true when adding layers. Optional for edits." }, "layerEffects": { "$ref": "#/components/schemas/LayerEffects", "description": "Layer Style effects applied to the layer (e.g. drop shadow). Optional." }, "pixelMask": { "$ref": "#/components/schemas/PixelMask", "description": "Pixel mask applied to the layer." }, "protection": { "type": "array", "description": "Protection flags for the layer (e.g. none, all, transparency, composite, position, artboard_autonest). Defaults to 'none' when adding layers. Optional for edits; omit, null, or empty array [] mean 'don't change'. When 'none' or 'all' is used, the array must contain only that element.", "items": { "type": "string", "description": "Protection flag for layer. Used in protection array.", "enum": [ "none", "all", "transparency", "composite", "position", "artboard_autonest" ] } }, "transform": { "$ref": "#/components/schemas/Transform", "description": "Transform applied to the layer" }, "transformMode": { "type": "string", "description": "Transform mode applied to the layer. Defaults to 'none' when adding layers. Optional for edits. Modes: 'none' — applies no scaling. 'fit' — scales the layer uniformly to fit within the canvas bounds while preserving aspect ratio. 'fill' — scales the layer uniformly to fill the canvas bounds while preserving aspect ratio, cropping overflow if the layer's aspect ratio differs from the canvas. 'custom' — applies the exact width and height from the Transform without preserving aspect ratio. Important for text layers: Any mode other than 'none' (or any non-identity scale on the Transform) causes the type engine to render glyphs and leading multiplied by the layer's scale factors. fontSize and lineHeight in CharacterStyle are stored unscaled. The rendered output becomes: fontSize x horizontalScale and lineHeight x verticalScale. To produce text at exact pixel sizes, use transformMode 'none' and avoid scaling Transforms on text layers.", "enum": [ "fit", "fill", "custom", "none" ] }, "type": { "type": "string", "description": "Type of layer. Required for add/edit operations, optional for delete/move.", "enum": [ "layer", "solid_color_layer", "text_layer", "smart_object_layer", "adjustment_layer", "group_layer", "background_layer" ] } } } ], "description": "Adjustment layer for applying image adjustments like brightness, contrast, hue/saturation, etc.", "required": [ "adjustments", "operation" ] }, "AddBackgroundLayer": { "allOf": [ { "$ref": "#/components/schemas/OperationBase" }, { "type": "object", "properties": { "blendOptions": { "$ref": "#/components/schemas/BlendOptions", "description": "Blend options for the layer" }, "image": { "$ref": "#/components/schemas/ImageSource", "description": "Image content including source URL for the background layer pixel content. Optional." }, "isVisible": { "type": "boolean", "description": "Whether the layer is visible. Defaults to true when adding layers. Optional for edits." }, "layerEffects": { "$ref": "#/components/schemas/LayerEffects", "description": "Layer Style effects applied to the layer (e.g. drop shadow). Optional." }, "pixelMask": { "$ref": "#/components/schemas/PixelMask", "description": "Pixel mask applied to the layer." }, "protection": { "type": "array", "description": "Protection flags for the layer (e.g. none, all, transparency, composite, position, artboard_autonest). Defaults to 'none' when adding layers. Optional for edits; omit, null, or empty array [] mean 'don't change'. When 'none' or 'all' is used, the array must contain only that element.", "items": { "type": "string", "description": "Protection flag for layer. Used in protection array.", "enum": [ "none", "all", "transparency", "composite", "position", "artboard_autonest" ] } }, "transform": { "$ref": "#/components/schemas/Transform", "description": "Transform applied to the layer" }, "transformMode": { "type": "string", "description": "Transform mode applied to the layer. Defaults to 'none' when adding layers. Optional for edits. Modes: 'none' — applies no scaling. 'fit' — scales the layer uniformly to fit within the canvas bounds while preserving aspect ratio. 'fill' — scales the layer uniformly to fill the canvas bounds while preserving aspect ratio, cropping overflow if the layer's aspect ratio differs from the canvas. 'custom' — applies the exact width and height from the Transform without preserving aspect ratio. Important for text layers: Any mode other than 'none' (or any non-identity scale on the Transform) causes the type engine to render glyphs and leading multiplied by the layer's scale factors. fontSize and lineHeight in CharacterStyle are stored unscaled. The rendered output becomes: fontSize x horizontalScale and lineHeight x verticalScale. To produce text at exact pixel sizes, use transformMode 'none' and avoid scaling Transforms on text layers.", "enum": [ "fit", "fill", "custom", "none" ] }, "type": { "type": "string", "description": "Type of layer. Required for add/edit operations, optional for delete/move.", "enum": [ "layer", "solid_color_layer", "text_layer", "smart_object_layer", "adjustment_layer", "group_layer", "background_layer" ] } } } ], "description": "Background layer for adding a background to the document.", "required": [ "operation" ] }, "AddLayer": { "allOf": [ { "$ref": "#/components/schemas/OperationBase" }, { "type": "object", "properties": { "blendOptions": { "$ref": "#/components/schemas/BlendOptions", "description": "Blend options for the layer" }, "image": { "$ref": "#/components/schemas/ImageSource", "description": "Image content including source URL. Supported file formats: PSD, PNG, JPEG, SVG. Required when adding a layer." }, "isClipped": { "type": "boolean", "description": "Whether the layer is clipped. Defaults to false when adding layers." }, "isVisible": { "type": "boolean", "description": "Whether the layer is visible. Defaults to true when adding layers. Optional for edits." }, "layerEffects": { "$ref": "#/components/schemas/LayerEffects", "description": "Layer Style effects applied to the layer (e.g. drop shadow). Optional." }, "pixelMask": { "$ref": "#/components/schemas/PixelMask", "description": "Pixel mask applied to the layer." }, "protection": { "type": "array", "description": "Protection flags for the layer (e.g. none, all, transparency, composite, position, artboard_autonest). Defaults to 'none' when adding layers. Optional for edits; omit, null, or empty array [] mean 'don't change'. When 'none' or 'all' is used, the array must contain only that element.", "items": { "type": "string", "description": "Protection flag for layer. Used in protection array.", "enum": [ "none", "all", "transparency", "composite", "position", "artboard_autonest" ] } }, "transform": { "$ref": "#/components/schemas/Transform", "description": "Transform applied to the layer" }, "transformMode": { "type": "string", "description": "Transform mode applied to the layer. Defaults to 'none' when adding layers. Optional for edits. Modes: 'none' — applies no scaling. 'fit' — scales the layer uniformly to fit within the canvas bounds while preserving aspect ratio. 'fill' — scales the layer uniformly to fill the canvas bounds while preserving aspect ratio, cropping overflow if the layer's aspect ratio differs from the canvas. 'custom' — applies the exact width and height from the Transform without preserving aspect ratio. Important for text layers: Any mode other than 'none' (or any non-identity scale on the Transform) causes the type engine to render glyphs and leading multiplied by the layer's scale factors. fontSize and lineHeight in CharacterStyle are stored unscaled. The rendered output becomes: fontSize x horizontalScale and lineHeight x verticalScale. To produce text at exact pixel sizes, use transformMode 'none' and avoid scaling Transforms on text layers.", "enum": [ "fit", "fill", "custom", "none" ] }, "type": { "type": "string", "description": "Type of layer. Required for add/edit operations, optional for delete/move.", "enum": [ "layer", "solid_color_layer", "text_layer", "smart_object_layer", "adjustment_layer", "group_layer", "background_layer" ] } } } ], "description": "Image layer for adding raster images to the document.", "required": [ "image", "operation" ] }, "AddOperation": { "allOf": [ { "$ref": "#/components/schemas/Operation" }, { "type": "object", "properties": { "placement": { "$ref": "#/components/schemas/Placement", "description": "Placement settings for the add operation. Required for non-background layers." } } } ], "description": "Add operation for adding layers.", "required": [ "placement", "type" ] }, "AddSmartObjectLayer": { "allOf": [ { "$ref": "#/components/schemas/OperationBase" }, { "type": "object", "properties": { "blendOptions": { "$ref": "#/components/schemas/BlendOptions", "description": "Blend options for the layer" }, "isClipped": { "type": "boolean", "description": "Whether the layer is clipped. Defaults to false when adding layers." }, "isVisible": { "type": "boolean", "description": "Whether the layer is visible. Defaults to true when adding layers. Optional for edits." }, "layerEffects": { "$ref": "#/components/schemas/LayerEffects", "description": "Layer Style effects applied to the layer (e.g. drop shadow). Optional." }, "pixelMask": { "$ref": "#/components/schemas/PixelMask", "description": "Pixel mask applied to the layer." }, "protection": { "type": "array", "description": "Protection flags for the layer (e.g. none, all, transparency, composite, position, artboard_autonest). Defaults to 'none' when adding layers. Optional for edits; omit, null, or empty array [] mean 'don't change'. When 'none' or 'all' is used, the array must contain only that element.", "items": { "type": "string", "description": "Protection flag for layer. Used in protection array.", "enum": [ "none", "all", "transparency", "composite", "position", "artboard_autonest" ] } }, "smartObject": { "$ref": "#/components/schemas/SmartObject", "description": "Smart object settings and file reference. Required." }, "transform": { "$ref": "#/components/schemas/Transform", "description": "Transform applied to the layer" }, "transformMode": { "type": "string", "description": "Transform mode applied to the layer. Defaults to 'none' when adding layers. Optional for edits. Modes: 'none' — applies no scaling. 'fit' — scales the layer uniformly to fit within the canvas bounds while preserving aspect ratio. 'fill' — scales the layer uniformly to fill the canvas bounds while preserving aspect ratio, cropping overflow if the layer's aspect ratio differs from the canvas. 'custom' — applies the exact width and height from the Transform without preserving aspect ratio. Important for text layers: Any mode other than 'none' (or any non-identity scale on the Transform) causes the type engine to render glyphs and leading multiplied by the layer's scale factors. fontSize and lineHeight in CharacterStyle are stored unscaled. The rendered output becomes: fontSize x horizontalScale and lineHeight x verticalScale. To produce text at exact pixel sizes, use transformMode 'none' and avoid scaling Transforms on text layers.", "enum": [ "fit", "fill", "custom", "none" ] }, "type": { "type": "string", "description": "Type of layer. Required for add/edit operations, optional for delete/move.", "enum": [ "layer", "solid_color_layer", "text_layer", "smart_object_layer", "adjustment_layer", "group_layer", "background_layer" ] } } } ], "description": "Smart object layer for embedding external files or vector graphics.", "required": [ "operation", "smartObject" ] }, "AddSolidColorLayer": { "allOf": [ { "$ref": "#/components/schemas/OperationBase" }, { "type": "object", "properties": { "blendOptions": { "$ref": "#/components/schemas/BlendOptions", "description": "Blend options for the layer" }, "fill": { "$ref": "#/components/schemas/Fill", "description": "Fill settings including color. Required." }, "isClipped": { "type": "boolean", "description": "Whether the layer is clipped. Defaults to false when adding layers." }, "isVisible": { "type": "boolean", "description": "Whether the layer is visible. Defaults to true when adding layers. Optional for edits." }, "layerEffects": { "$ref": "#/components/schemas/LayerEffects", "description": "Layer Style effects applied to the layer (e.g. drop shadow). Optional." }, "pixelMask": { "$ref": "#/components/schemas/PixelMask", "description": "Pixel mask applied to the layer." }, "protection": { "type": "array", "description": "Protection flags for the layer (e.g. none, all, transparency, composite, position, artboard_autonest). Defaults to 'none' when adding layers. Optional for edits; omit, null, or empty array [] mean 'don't change'. When 'none' or 'all' is used, the array must contain only that element.", "items": { "type": "string", "description": "Protection flag for layer. Used in protection array.", "enum": [ "none", "all", "transparency", "composite", "position", "artboard_autonest" ] } }, "transform": { "$ref": "#/components/schemas/Transform", "description": "Transform applied to the layer" }, "transformMode": { "type": "string", "description": "Transform mode applied to the layer. Defaults to 'none' when adding layers. Optional for edits. Modes: 'none' — applies no scaling. 'fit' — scales the layer uniformly to fit within the canvas bounds while preserving aspect ratio. 'fill' — scales the layer uniformly to fill the canvas bounds while preserving aspect ratio, cropping overflow if the layer's aspect ratio differs from the canvas. 'custom' — applies the exact width and height from the Transform without preserving aspect ratio. Important for text layers: Any mode other than 'none' (or any non-identity scale on the Transform) causes the type engine to render glyphs and leading multiplied by the layer's scale factors. fontSize and lineHeight in CharacterStyle are stored unscaled. The rendered output becomes: fontSize x horizontalScale and lineHeight x verticalScale. To produce text at exact pixel sizes, use transformMode 'none' and avoid scaling Transforms on text layers.", "enum": [ "fit", "fill", "custom", "none" ] }, "type": { "type": "string", "description": "Type of layer. Required for add/edit operations, optional for delete/move.", "enum": [ "layer", "solid_color_layer", "text_layer", "smart_object_layer", "adjustment_layer", "group_layer", "background_layer" ] } } } ], "description": "Fill layer for adding solid color layer.", "required": [ "fill", "operation" ] }, "AddTextLayer": { "allOf": [ { "$ref": "#/components/schemas/OperationBase" }, { "type": "object", "properties": { "blendOptions": { "$ref": "#/components/schemas/BlendOptions", "description": "Blend options for the layer" }, "isClipped": { "type": "boolean", "description": "Whether the layer is clipped. Defaults to false when adding layers." }, "isVisible": { "type": "boolean", "description": "Whether the layer is visible. Defaults to true when adding layers. Optional for edits." }, "layerEffects": { "$ref": "#/components/schemas/LayerEffects", "description": "Layer Style effects applied to the layer (e.g. drop shadow). Optional." }, "pixelMask": { "$ref": "#/components/schemas/PixelMask", "description": "Pixel mask applied to the layer." }, "protection": { "type": "array", "description": "Protection flags for the layer (e.g. none, all, transparency, composite, position, artboard_autonest). Defaults to 'none' when adding layers. Optional for edits; omit, null, or empty array [] mean 'don't change'. When 'none' or 'all' is used, the array must contain only that element.", "items": { "type": "string", "description": "Protection flag for layer. Used in protection array.", "enum": [ "none", "all", "transparency", "composite", "position", "artboard_autonest" ] } }, "text": { "$ref": "#/components/schemas/Text", "description": "Text content and formatting settings for this text layer." }, "transform": { "$ref": "#/components/schemas/Transform", "description": "Transform applied to the layer" }, "transformMode": { "type": "string", "description": "Transform mode applied to the layer. Defaults to 'none' when adding layers. Optional for edits. Modes: 'none' — applies no scaling. 'fit' — scales the layer uniformly to fit within the canvas bounds while preserving aspect ratio. 'fill' — scales the layer uniformly to fill the canvas bounds while preserving aspect ratio, cropping overflow if the layer's aspect ratio differs from the canvas. 'custom' — applies the exact width and height from the Transform without preserving aspect ratio. Important for text layers: Any mode other than 'none' (or any non-identity scale on the Transform) causes the type engine to render glyphs and leading multiplied by the layer's scale factors. fontSize and lineHeight in CharacterStyle are stored unscaled. The rendered output becomes: fontSize x horizontalScale and lineHeight x verticalScale. To produce text at exact pixel sizes, use transformMode 'none' and avoid scaling Transforms on text layers.", "enum": [ "fit", "fill", "custom", "none" ] }, "type": { "type": "string", "description": "Type of layer. Required for add/edit operations, optional for delete/move.", "enum": [ "layer", "solid_color_layer", "text_layer", "smart_object_layer", "adjustment_layer", "group_layer", "background_layer" ] } } } ], "description": "Text layer for adding text content in the document.", "required": [ "operation", "text" ] }, "AdditionalContentResource": { "type": "object", "description": "Single additional resource (images, js, brushes, etc.). When present, the 'source' field is required.", "properties": { "source": { "$ref": "#/components/schemas/PortableFileResourceInput", "description": "Source for the additional resource. Must be a URL, Creative Cloud path, or Creative Cloud file ID. Lightroom resources are not supported here. Inline content is not supported. These resources can be referenced in inline actionJSON using placeholders `__ADDITIONAL_CONTENTS_PATH_0__`, `__ADDITIONAL_CONTENTS_PATH_1__`, etc." } }, "required": [ "source" ] }, "AdditionalFont": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/PortableFileResourceInput", "description": "Source of the font file. Must be a URL, Creative Cloud path, or Creative Cloud file ID. Lightroom resources are not supported for fonts. Required." } } }, "Anchor": { "type": "object", "description": "Anchor point coordinates for transformations and positioning.", "properties": { "horizontal": { "type": "number", "format": "double", "description": "Horizontal anchor position. Required." }, "vertical": { "type": "number", "format": "double", "description": "Vertical anchor position. Required." } }, "required": [ "horizontal", "vertical" ] }, "Apply": { "type": "object", "description": "Inclusive range (from/to) for character or paragraph styling. When present, both 'from' and 'to' are required.", "properties": { "from": { "type": "integer", "format": "int32", "description": "From value. Required.", "minimum": 0 }, "to": { "type": "integer", "format": "int32", "description": "To value. Required.", "minimum": 0 } }, "required": [ "from", "to" ] }, "AreaFrame": { "allOf": [ { "$ref": "#/components/schemas/TextFrame" }, { "type": "object", "properties": { "bounds": { "$ref": "#/components/schemas/Bounds", "description": "Area boundaries" } } } ], "description": "Area text frame defining a bounded rectangular region for text content. Text will wrap within the specified bounds", "required": [ "type" ] }, "ArtboardImageInput": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the artboard. Optional. Defaults to rendition dimensions (e.g. \"1920 x 1080\").", "maxLength": 255, "minLength": 1 }, "source": { "$ref": "#/components/schemas/FileResourceInput", "description": "Source of the image. Must be an external file reference (URL, Creative Cloud file ID, or Creative Cloud path). Required.", "oneOf": [ { "$ref": "#/components/schemas/UrlResourceInput" }, { "$ref": "#/components/schemas/CreativeCloudResourceInput" }, { "$ref": "#/components/schemas/CreativeCloudFileIdResourceInput" } ] } }, "required": [ "source" ] }, "AutoStraighten": { "type": "object", "description": "Auto straighten configuration with options", "properties": { "constrainCrop": { "type": "boolean", "default": true, "description": "Whether to constrain crop the straightened image to remove blank edges" }, "enabled": { "type": "boolean", "default": false, "description": "Whether auto straighten is enabled. Defaults to false when omitted. Explicit null is invalid." }, "uprightMode": { "type": "string", "description": "The upright mode to use for straightening. When not specified, performs basic straighten without upright correction. Specify a mode to enable upright correction.", "enum": [ "auto", "full", "level", "vertical" ] } }, "required": [ "enabled" ] }, "AutoCropAspectRatio": { "type": "string", "description": "Desired aspect ratio for generated crops.", "enum": [ "1:1", "16:9", "9:16", "4:3", "3:4", "4:5", "5:4", "3:2", "2:3", "21:9" ] }, "AutoCropBoundingBox": { "required": [ "x", "y", "width", "height" ], "type": "object", "properties": { "height": { "type": "number", "description": "Height of the bounding box." }, "url": { "type": "string", "description": "Presigned URL for the cropped image. Only present when outputType is 'images'." }, "width": { "type": "number", "description": "Width of the bounding box." }, "x": { "type": "number", "description": "X coordinate of the bounding box." }, "y": { "type": "number", "description": "Y coordinate of the bounding box." } } }, "AutoCropCrop": { "required": [ "boundingBoxes" ], "type": "object", "properties": { "boundingBoxes": { "type": "array", "description": "List of bounding boxes for the generated crop.", "items": { "$ref": "#/components/schemas/AutoCropBoundingBox" } } } }, "AutoCropImageMediaType": { "type": "string", "description": "The media type of the input image. Supported values are image/jpeg, image/png, and image/webp.", "enum": [ "image/jpeg", "image/png", "image/webp" ] }, "AutoCropInputImage": { "required": [ "source" ], "type": "object", "properties": { "mediaType": { "$ref": "#/components/schemas/AutoCropImageMediaType" }, "source": { "$ref": "#/components/schemas/AutoCropUrlResource" } }, "description": "The input image for the auto-crop operation." }, "AutoCropMode": { "type": "string", "description": "Mode for the auto crop operation. 'smartCrop' and 'subjectCrop' generate crops using aspectRatio with optional zoom. 'fullSceneDetection' and 'objectDetection' detect subjects or objects in the scene.", "enum": [ "smartCrop", "subjectCrop", "fullSceneDetection", "objectDetection" ] }, "AutoCropObjectDetection": { "required": [ "objectName", "boundingBoxes", "confidence" ], "type": "object", "properties": { "boundingBoxes": { "type": "array", "description": "Bounding boxes enclosing the detected object in {x, y, width, height} format.", "items": { "$ref": "#/components/schemas/AutoCropBoundingBox" } }, "confidence": { "type": "number", "description": "Confidence score for the detected object." }, "objectName": { "type": "string", "description": "Name of the detected object." } } }, "AutoCropOutput": { "required": [ "subject", "objects", "crops" ], "type": "object", "properties": { "crops": { "type": "array", "description": "Generated crops for the input image.", "items": { "$ref": "#/components/schemas/AutoCropCrop" } }, "objects": { "type": "array", "description": "Detected objects in the input image.", "items": { "$ref": "#/components/schemas/AutoCropObjectDetection" } }, "subject": { "type": "array", "description": "Subject crops detected in the input image.", "items": { "$ref": "#/components/schemas/AutoCropCrop" } } }, "description": "Auto crop output details." }, "AutoCropOutputType": { "type": "string", "description": "Output type for the auto crop operation. 'images' returns cropped images with presigned URLs (default). 'boundingBoxes' returns only bounding box coordinates.", "default": "images", "enum": [ "images", "boundingBoxes" ] }, "AutoCropRequest": { "required": [ "image", "mode" ], "type": "object", "properties": { "aspectRatio": { "description": "Desired aspect ratio(s) for generated crops. Accepts either a single enum string or an array of up to 20 strings. Allowed only for 'smartCrop' and 'subjectCrop'. When omitted, the service defaults to 1:1. An empty array is treated as absent.", "example": [ "16:9", "1:1", "4:3" ], "oneOf": [ { "$ref": "#/components/schemas/AutoCropAspectRatio" }, { "type": "array", "items": { "$ref": "#/components/schemas/AutoCropAspectRatio" } } ] }, "focus": { "type": "array", "description": "Focus labels, ordered by preference, used to prioritize objects during cropping or as detection targets. Required for 'subjectCrop' and 'objectDetection'; must be empty for 'smartCrop' and 'fullSceneDetection'.", "example": [ "logo", "person" ], "items": { "type": "string" } }, "image": { "$ref": "#/components/schemas/AutoCropInputImage" }, "mode": { "$ref": "#/components/schemas/AutoCropMode" }, "outputType": { "$ref": "#/components/schemas/AutoCropOutputType" }, "zoom": { "description": "Optional zoom level(s) paired with aspectRatio. Accepts either a number or an array of up to 20 numbers in (0, 1]. Must not be sent without aspectRatio. When aspectRatio is an array, zoom may be omitted or must be a matching non-empty array.", "example": [ 0.9, 0.8, 0.85 ], "oneOf": [ { "type": "number" }, { "type": "array", "items": { "type": "number" } } ] } } }, "AutoCropUrlResource": { "required": [ "url" ], "type": "object", "properties": { "url": { "type": "string", "description": "The URL of the resource. Only allow-listed domains are accepted as input URLs (e.g. amazonaws.com, windows.net, dropboxusercontent.com, assets.frame.io, storage.googleapis.com, adobe.io, azureedge.net)." } }, "description": "The source of the input image." }, "BaseAdjustment": { "type": "object", "discriminator": { "propertyName": "type" }, "properties": { "type": { "type": "string", "description": "Type of adjustment. Must match one of the supported types: hue_saturation, brightness_contrast, exposure, or color_balance.", "enum": [ "hue_saturation", "brightness_contrast", "exposure", "color_balance" ] } }, "required": [ "type" ] }, "BlendOptions": { "type": "object", "description": "Blend options for layer effects, including opacity settings.", "properties": { "blendMode": { "type": "string", "description": "Blend mode for the layer. Defaults to normal when adding new layers. Optional for edits.", "enum": [ "normal", "dissolve", "darken", "multiply", "color_burn", "linear_burn", "darker_color", "lighten", "screen", "color_dodge", "linear_dodge", "lighter_color", "overlay", "soft_light", "hard_light", "vivid_light", "pin_light", "hard_mix", "difference", "exclusion", "divide", "hue", "saturation", "color", "luminosity" ] }, "opacity": { "type": "integer", "format": "int32", "description": "Opacity percentage for the blend effect. Range: 0-100. Defaults to 100 when adding new layers. Optional for edits.", "maximum": 100, "minimum": 0 } } }, "Bounds": { "type": "object", "properties": { "bottom": { "type": "integer", "format": "int32", "description": "Bottom coordinate in pixels. Optional." }, "left": { "type": "integer", "format": "int32", "description": "Left coordinate in pixels. Optional." }, "right": { "type": "integer", "format": "int32", "description": "Right coordinate in pixels. Optional." }, "top": { "type": "integer", "format": "int32", "description": "Top coordinate in pixels. Optional." } } }, "BrightnessContrast": { "type": "object", "properties": { "brightness": { "type": "integer", "format": "int32", "description": "The adjustment layer's brightness. Range: -150 to 150. Defaults to 0 when adding new layers. Optional for edits", "maximum": 150, "minimum": -150 }, "contrast": { "type": "integer", "format": "int32", "description": "The adjustment layer's contrast. Range: -150 to 150. Defaults to 0 when adding new layers. Optional for edits", "maximum": 150, "minimum": -150 } } }, "BrightnessContrastAdjustments": { "allOf": [ { "$ref": "#/components/schemas/BaseAdjustment" }, { "type": "object", "properties": { "brightnessContrast": { "$ref": "#/components/schemas/BrightnessContrast", "description": "Brightness and contrast adjustment settings" } } } ], "description": "Brightness and contrast adjustment", "required": [ "brightnessContrast", "type" ] }, "BrushResource": { "type": "object", "description": "Single brush resource (.abr, etc.). When present, the 'source' field is required.", "properties": { "source": { "$ref": "#/components/schemas/PortableFileResourceInput", "description": "Source for the brush resource. Must be a URL, Creative Cloud path, or Creative Cloud file ID. Lightroom resources are not supported for brushes. Inline content is not supported." } }, "required": [ "source" ] }, "CharacterStyle": { "type": "object", "description": "Character-level styling properties for text.", "properties": { "autoLeading": { "type": "boolean", "default": false, "description": "When true, line height is calculated automatically based on the font size. When false, custom lineHeight is applied. Optional." }, "capsOption": { "type": "string", "description": "Caps option for text. Optional. Default is normal_caps.", "enum": [ "normal_caps", "small_caps", "all_caps", "all_small_caps" ] }, "font": { "$ref": "#/components/schemas/Font", "description": "Font definition. Optional." }, "fontAlpha": { "type": "number", "format": "double", "description": "Font alpha/transparency value. Optional. Default is 1.0.", "maximum": 1, "minimum": 0 }, "fontColor": { "$ref": "#/components/schemas/FontColor", "description": "Font color settings. Optional. Default is black in RGB." }, "fontSize": { "type": "number", "format": "double", "description": "Font size in pixels. Optional. Default is 30." }, "letterSpacing": { "type": "number", "format": "double", "description": "Letter spacing in pixels. Optional. Default is 0." }, "lineHeight": { "type": "number", "format": "double", "default": 36, "description": "Line height (leading) in pixels. Optional. This value represents the unscaled leading stored on the character style. If the text layer carries a non-identity transform, for example because the bounding box was resized in Photoshop, the rendered leading becomes lineHeight x the layer's vertical scale factor. To get exact rendered pixel leading, ensure the layer has no residual scaling (transformMode: none with no scaling Transform applied), or pre-divide the desired rendered leading by the layer's current vertical scale. The same scaling behavior applies to fontSize." }, "syntheticBold": { "type": "boolean", "description": "Whether to apply synthetic bold. Optional. Default is false." }, "syntheticItalic": { "type": "boolean", "description": "Whether to apply synthetic italic. Optional. Default is false." }, "underline": { "type": "boolean", "description": "Whether to apply underline. Optional. Default is false." } } }, "CharacterStyleRange": { "type": "object", "description": "Character style range defining styling for specific text ranges.", "properties": { "apply": { "$ref": "#/components/schemas/Apply", "description": "Range of characters to apply styling to. Optional." }, "characterStyle": { "$ref": "#/components/schemas/CharacterStyle", "description": "Character style settings. Optional." } } }, "ColorAdjustments": { "type": "object", "description": "Color adjustments for image editing.", "properties": { "saturation": { "type": "integer", "format": "int32", "description": "Saturation adjustment. Range: -100 to +100", "example": 20, "maximum": 100, "minimum": -100 }, "vibrance": { "type": "integer", "format": "int32", "description": "Vibrance adjustment. Range: -100 to +100", "example": 15, "maximum": 100, "minimum": -100 }, "whiteBalance": { "type": "string", "description": "White balance adjustment. Optional.", "enum": [ "As Shot", "Auto", "Cloudy", "Custom", "Daylight", "Flash", "Fluorescent", "Shade", "Tungsten" ], "example": "As Shot" } } }, "ColorBalance": { "type": "object", "properties": { "highlightLevels": { "type": "array", "description": "Array of 3 integers for highlight levels. Each value must be between -100 and 100. Defaults to [0, 0, 0] when adding new layers. Optional for edits", "items": { "type": "integer", "format": "int32", "maximum": 100, "minimum": -100 }, "maxItems": 3, "minItems": 3 }, "midtoneLevels": { "type": "array", "description": "Array of 3 integers for midtone levels. Each value must be between -100 and 100. Defaults to [0, 0, 0] when adding new layers. Optional for edits", "items": { "type": "integer", "format": "int32", "maximum": 100, "minimum": -100 }, "maxItems": 3, "minItems": 3 }, "preserveLuminosity": { "type": "boolean", "description": "Whether to preserve luminosity. Defaults to true when adding new layers. Optional for edits" }, "shadowLevels": { "type": "array", "description": "Array of 3 integers for shadow levels. Each value must be between -100 and 100. Defaults to [0, 0, 0] when adding new layers. Optional for edits", "items": { "type": "integer", "format": "int32", "maximum": 100, "minimum": -100 }, "maxItems": 3, "minItems": 3 } } }, "ColorBalanceAdjustments": { "allOf": [ { "$ref": "#/components/schemas/BaseAdjustment" }, { "type": "object", "properties": { "colorBalance": { "$ref": "#/components/schemas/ColorBalance", "description": "Color balance adjustment settings" } } } ], "description": "Color balance adjustment", "required": [ "colorBalance", "type" ] }, "CreateArtboardRequest": { "type": "object", "properties": { "artboardSpacing": { "type": "integer", "format": "int32", "description": "Horizontal spacing in pixels between each artboard. Defaults to 50. Optional." }, "images": { "type": "array", "description": "List of input images for the artboard. Each image must have a source with an external file reference (URL, Creative Cloud file ID, or Creative Cloud path). Required.", "items": { "$ref": "#/components/schemas/ArtboardImageInput" }, "maxItems": 25, "minItems": 1 }, "outputs": { "type": "array", "description": "List of output asset details. Each output specifies destination and output options. Maximum of 25 outputs allowed.", "items": { "oneOf": [ { "$ref": "#/components/schemas/JpegOutputWithScan" }, { "$ref": "#/components/schemas/JsonOutput" }, { "$ref": "#/components/schemas/PngOutput" }, { "$ref": "#/components/schemas/PsdOutput" }, { "$ref": "#/components/schemas/PsdcOutput" }, { "$ref": "#/components/schemas/TiffOutput" } ] }, "maxItems": 25, "minItems": 1 } }, "required": [ "images", "outputs" ] }, "CreateCompositeRequest": { "type": "object", "properties": { "edits": { "$ref": "#/components/schemas/Edits", "description": "Edits to be applied to the input asset. Optional." }, "fontOptions": { "$ref": "#/components/schemas/FontOptions", "description": "Font options to be applied. Optional." }, "image": { "description": "The image input for the composite operation. Required.", "oneOf": [ { "$ref": "#/components/schemas/ImageParameters" }, { "$ref": "#/components/schemas/ImageSource" } ] }, "outputs": { "type": "array", "description": "List of output asset details. Required. Maximum of 25 outputs allowed.", "items": { "oneOf": [ { "$ref": "#/components/schemas/JpegOutputWithScan" }, { "$ref": "#/components/schemas/JsonOutput" }, { "$ref": "#/components/schemas/PngOutput" }, { "$ref": "#/components/schemas/PsdOutput" }, { "$ref": "#/components/schemas/PsdcOutput" }, { "$ref": "#/components/schemas/TiffOutput" } ] }, "maxItems": 25, "minItems": 1 } }, "required": [ "image", "outputs" ] }, "CreativeCloudDestination": { "allOf": [ { "$ref": "#/components/schemas/Destination" }, { "type": "object", "properties": { "creativeCloudPath": { "type": "string", "description": "Path to Creative Cloud storage. Required.", "minLength": 1 }, "creativeCloudProjectId": { "type": "string", "description": "The Creative Cloud project ID. Optional. Must be a valid URN starting with 'urn:aaid:sc:'. Example: urn:aaid:sc:US:a21c8629-413f-55d9-...", "pattern": "^urn:aaid:.*" } } } ], "required": [ "creativeCloudPath" ] }, "CreativeCloudFileIdResourceInput": { "allOf": [ { "$ref": "#/components/schemas/ResourceInput" }, { "type": "object", "properties": { "creativeCloudFileId": { "type": "string", "description": "The file ID of the asset in Creative Cloud. Required. Must start with 'urn:aaid' (case-insensitive).", "minLength": 1, "pattern": "^urn:aaid:.*" } } } ], "description": "Creative Cloud file ID resource input. References a resource via Creative Cloud file ID (URN).", "required": [ "creativeCloudFileId" ] }, "CreativeCloudResourceInput": { "allOf": [ { "$ref": "#/components/schemas/ResourceInput" }, { "type": "object", "properties": { "creativeCloudPath": { "type": "string", "description": "The path to the asset in Creative Cloud. Required.", "minLength": 1 }, "creativeCloudProjectId": { "type": "string", "description": "The Creative Cloud project ID. Optional. Must be a valid URN starting with 'urn:aaid:sc:'. Example: urn:aaid:sc:US:a21c8629-413f-55d9-...", "pattern": "^urn:aaid:.*" } } } ], "description": "Creative Cloud resource input. References a resource via Creative Cloud path.", "required": [ "creativeCloudPath" ] }, "Crop": { "type": "object", "description": "Options for cropping a document, specifying the bounds to crop to.", "properties": { "bounds": { "$ref": "#/components/schemas/Bounds", "description": "The bounds to crop the document to" }, "hide": { "type": "boolean", "description": "When true, hides pixels outside the crop bounds (non-destructive). When false, permanently deletes pixels outside the crop bounds (destructive). Defaults to false." } }, "required": [ "bounds" ] }, "CurvePoint": { "type": "object", "description": "A single point on a contour curve.", "properties": { "continuity": { "type": "boolean", "description": "Whether the curve point is smooth (true) or a corner (false). Required." }, "horizontal": { "type": "number", "format": "double", "description": "Horizontal position of the curve point. Range: 0-255. Required.", "maximum": 255, "minimum": 0 }, "vertical": { "type": "number", "format": "double", "description": "Vertical position of the curve point. Range: 0-255. Required.", "maximum": 255, "minimum": 0 } }, "required": [ "continuity", "horizontal", "vertical" ] }, "CustomIccProfile": { "allOf": [ { "$ref": "#/components/schemas/IccProfile" }, { "type": "object", "properties": { "imageMode": { "type": "string", "description": "Image mode for custom ICC profiles. Allowed values: rgb, grayscale, cmyk. Optional", "enum": [ "rgb", "grayscale", "cmyk" ], "example": "rgb" }, "name": { "type": "string", "description": "Custom ICC profile name. Provide a descriptive name (max 255 characters). Required.", "example": "U.S. Web Coated (SWOP) v2", "maxLength": 255, "minLength": 0 }, "source": { "$ref": "#/components/schemas/FileResourceInput", "description": "Resource input for custom ICC profile file. Required. Must point to a valid .icc or .icm file. Supports URL, Creative Cloud, and other resource types.", "oneOf": [ { "$ref": "#/components/schemas/UrlResourceInput" }, { "$ref": "#/components/schemas/CreativeCloudResourceInput" }, { "$ref": "#/components/schemas/CreativeCloudFileIdResourceInput" } ] } } } ], "description": "Custom ICC profile with user-provided profile file", "required": [ "name", "source", "type" ] }, "DeleteLayer": { "allOf": [ { "$ref": "#/components/schemas/OperationBase" } ], "description": "Layer for delete operations", "required": [ "operation" ] }, "DeleteOperation": { "allOf": [ { "$ref": "#/components/schemas/Operation" }, { "type": "object", "properties": { "shouldIncludeChildren": { "type": "boolean", "description": "Whether to include child layers in the deletion. Optional. Default - true" } } } ], "description": "Delete operation for removing layers.", "required": [ "type" ] }, "Destination": { "description": "Destination for output files. Can be either a URL with optional storage type or a Creative Cloud path." }, "Dimension": { "type": "object", "description": "Offset coordinates for positioning elements.", "properties": { "height": { "type": "integer", "format": "int32", "description": "Height after transformation. Optional.", "maximum": 32000, "minimum": 0 }, "unit": { "type": "string", "default": "pixels_unit", "description": "Unit for width and height. Accepted values for transform dimensions: 'pixels_unit' (default) and 'points_unit'. Optional — omitting this field defaults to pixels_unit.", "enum": [ "pixels_unit", "points_unit" ] }, "width": { "type": "integer", "format": "int32", "description": "Width after transformation. Optional.", "maximum": 32000, "minimum": 0 } } }, "DimensionMeasurement": { "type": "object", "description": "Represents a dimension measurement for width or height with appropriate units.", "properties": { "unit": { "type": "string", "default": "pixels_unit", "description": "The unit of measurement for the dimension. 'pixels_unit' for absolute pixel measurements (default), 'percent_unit' for percentage-based scaling, 'distance_unit' for physical measurements, 'points_unit' for typographic points — converted to pixels using pixels = round(value × dpi / 72) before processing. Defaults to pixels_unit when omitted.", "enum": [ "pixels_unit", "percent_unit", "distance_unit", "points_unit" ] }, "value": { "type": "integer", "format": "int32", "description": "The value of the dimension. Must be greater than or equal to 0.", "minimum": 0 } }, "required": [ "unit" ] }, "Document": { "type": "object", "description": "Represents the editable document structure, including resize, crop and trim options. Each field corresponds to a specific type of document edit operation.", "properties": { "crop": { "$ref": "#/components/schemas/Crop", "description": "Crop options for the document. Includes bounds for cropping." }, "resize": { "$ref": "#/components/schemas/Resize", "description": "Resize options for the document. Includes width, height, resolution, resample type, and booleans for constraining proportions, scaling styles, and rasterizing." }, "trim": { "$ref": "#/components/schemas/Trim", "description": "Trim options for the document. Includes a 'basedOn' field to specify the trim basis." } } }, "DropShadow": { "type": "object", "description": "Drop shadow layer effect.", "properties": { "angle": { "type": "integer", "format": "int32", "description": "Local lighting angle in degrees. Used when useGlobalLight is false. Range: -180 to 180. Optional.", "maximum": 180, "minimum": -180 }, "antiAliased": { "type": "boolean", "description": "Whether anti-aliasing is applied to the drop shadow contour. Optional." }, "blendMode": { "type": "string", "description": "Blend mode for the drop shadow. Optional.", "enum": [ "normal", "dissolve", "darken", "multiply", "color_burn", "linear_burn", "darker_color", "lighten", "screen", "color_dodge", "linear_dodge", "lighter_color", "overlay", "soft_light", "hard_light", "vivid_light", "pin_light", "hard_mix", "difference", "exclusion", "divide", "hue", "saturation", "color", "luminosity" ] }, "color": { "$ref": "#/components/schemas/EffectColor", "description": "Color of the drop shadow. Optional." }, "contour": { "$ref": "#/components/schemas/TransparencyShape", "description": "Contour applied to the drop shadow. Optional." }, "distance": { "type": "integer", "format": "int32", "description": "Distance of the drop shadow in pixels. Range: 0-30000. Optional.", "maximum": 30000, "minimum": 0 }, "enabled": { "type": "boolean", "description": "Whether the drop shadow effect is enabled. Optional." }, "layerKnocksOut": { "type": "boolean", "description": "Whether the layer's content knocks out (hides) the drop shadow beneath it. Optional." }, "noise": { "type": "integer", "format": "int32", "description": "Noise applied to the drop shadow as a percentage. Range: 0-100. Optional.", "maximum": 100, "minimum": 0 }, "opacity": { "type": "integer", "format": "int32", "description": "Opacity of the drop shadow as a percentage. Range: 0-100. Optional.", "maximum": 100, "minimum": 0 }, "size": { "type": "integer", "format": "int32", "description": "Size of the drop shadow in pixels. Range: 0-250. Optional.", "maximum": 250, "minimum": 0 }, "spread": { "type": "integer", "format": "int32", "description": "Spread of the drop shadow as a percentage. Range: 0-100. Optional.", "maximum": 100, "minimum": 0 }, "useGlobalLight": { "type": "boolean", "description": "Whether to use the document's global light angle. Optional." } } }, "EditAdjustmentLayer": { "allOf": [ { "$ref": "#/components/schemas/OperationBase" }, { "type": "object", "properties": { "adjustments": { "description": "Adjustment settings to apply. Must specify exactly one adjustment type (brightness_contrast, hue_saturation, exposure, or color_balance).", "oneOf": [ { "$ref": "#/components/schemas/BrightnessContrastAdjustments" }, { "$ref": "#/components/schemas/ColorBalanceAdjustments" }, { "$ref": "#/components/schemas/ExposureAdjustments" }, { "$ref": "#/components/schemas/HueSaturationAdjustments" } ] }, "blendOptions": { "$ref": "#/components/schemas/BlendOptions", "description": "Blend options for the layer" }, "isClipped": { "type": "boolean", "description": "Whether the layer is clipped. Optional for edits." }, "isVisible": { "type": "boolean", "description": "Whether the layer is visible. Defaults to true when adding layers. Optional for edits." }, "layerEffects": { "$ref": "#/components/schemas/LayerEffects", "description": "Layer Style effects applied to the layer (e.g. drop shadow). Optional." }, "pixelMask": { "$ref": "#/components/schemas/EditPixelMask", "description": "Pixel mask applied to the layer. Supports delete for edit operations." }, "protection": { "type": "array", "description": "Protection flags for the layer (e.g. none, all, transparency, composite, position, artboard_autonest). Defaults to 'none' when adding layers. Optional for edits; omit, null, or empty array [] mean 'don't change'. When 'none' or 'all' is used, the array must contain only that element.", "items": { "type": "string", "description": "Protection flag for layer. Used in protection array.", "enum": [ "none", "all", "transparency", "composite", "position", "artboard_autonest" ] } }, "transform": { "$ref": "#/components/schemas/Transform", "description": "Transform applied to the layer" }, "transformMode": { "type": "string", "description": "Transform mode applied to the layer. Defaults to 'none' when adding layers. Optional for edits. Modes: 'none' — applies no scaling. 'fit' — scales the layer uniformly to fit within the canvas bounds while preserving aspect ratio. 'fill' — scales the layer uniformly to fill the canvas bounds while preserving aspect ratio, cropping overflow if the layer's aspect ratio differs from the canvas. 'custom' — applies the exact width and height from the Transform without preserving aspect ratio. Important for text layers: Any mode other than 'none' (or any non-identity scale on the Transform) causes the type engine to render glyphs and leading multiplied by the layer's scale factors. fontSize and lineHeight in CharacterStyle are stored unscaled. The rendered output becomes: fontSize x horizontalScale and lineHeight x verticalScale. To produce text at exact pixel sizes, use transformMode 'none' and avoid scaling Transforms on text layers.", "enum": [ "fit", "fill", "custom", "none" ] }, "type": { "type": "string", "description": "Type of layer. Required for add/edit operations, optional for delete/move.", "enum": [ "layer", "solid_color_layer", "text_layer", "smart_object_layer", "adjustment_layer", "group_layer", "background_layer" ] } } } ], "description": "Adjustment layer for applying image adjustments like brightness, contrast, hue/saturation, etc.", "required": [ "operation" ] }, "EditBackgroundLayer": { "allOf": [ { "$ref": "#/components/schemas/OperationBase" }, { "type": "object", "properties": { "blendOptions": { "$ref": "#/components/schemas/BlendOptions", "description": "Blend options for the layer" }, "convertToLayer": { "type": "boolean", "description": "When true, promotes the background layer to a regular layer. Mutually exclusive with image." }, "convertedLayerName": { "type": "string", "description": "Name to set on the layer after conversion. Only applicable when convertToLayer is true. Optional." }, "image": { "$ref": "#/components/schemas/ImageSource", "description": "Image content for pixel replacement of the background layer. Mutually exclusive with convertToLayer." }, "isVisible": { "type": "boolean", "description": "Whether the layer is visible. Defaults to true when adding layers. Optional for edits." }, "layerEffects": { "$ref": "#/components/schemas/LayerEffects", "description": "Layer Style effects applied to the layer (e.g. drop shadow). Optional." }, "pixelMask": { "$ref": "#/components/schemas/EditPixelMask", "description": "Pixel mask applied to the layer. Supports delete for edit operations." }, "protection": { "type": "array", "description": "Protection flags for the layer (e.g. none, all, transparency, composite, position, artboard_autonest). Defaults to 'none' when adding layers. Optional for edits; omit, null, or empty array [] mean 'don't change'. When 'none' or 'all' is used, the array must contain only that element.", "items": { "type": "string", "description": "Protection flag for layer. Used in protection array.", "enum": [ "none", "all", "transparency", "composite", "position", "artboard_autonest" ] } }, "transform": { "$ref": "#/components/schemas/Transform", "description": "Transform applied to the layer" }, "transformMode": { "type": "string", "description": "Transform mode applied to the layer. Defaults to 'none' when adding layers. Optional for edits. Modes: 'none' — applies no scaling. 'fit' — scales the layer uniformly to fit within the canvas bounds while preserving aspect ratio. 'fill' — scales the layer uniformly to fill the canvas bounds while preserving aspect ratio, cropping overflow if the layer's aspect ratio differs from the canvas. 'custom' — applies the exact width and height from the Transform without preserving aspect ratio. Important for text layers: Any mode other than 'none' (or any non-identity scale on the Transform) causes the type engine to render glyphs and leading multiplied by the layer's scale factors. fontSize and lineHeight in CharacterStyle are stored unscaled. The rendered output becomes: fontSize x horizontalScale and lineHeight x verticalScale. To produce text at exact pixel sizes, use transformMode 'none' and avoid scaling Transforms on text layers.", "enum": [ "fit", "fill", "custom", "none" ] }, "type": { "type": "string", "description": "Type of layer. Required for add/edit operations, optional for delete/move.", "enum": [ "layer", "solid_color_layer", "text_layer", "smart_object_layer", "adjustment_layer", "group_layer", "background_layer" ] } } } ], "description": "Background layer for editing an existing background layer.", "required": [ "operation" ] }, "EditGroupLayer": { "allOf": [ { "$ref": "#/components/schemas/OperationBase" }, { "type": "object", "properties": { "blendOptions": { "$ref": "#/components/schemas/BlendOptions", "description": "Blend options for the layer" }, "isVisible": { "type": "boolean", "description": "Whether the layer is visible. Defaults to true when adding layers. Optional for edits." }, "layerEffects": { "$ref": "#/components/schemas/LayerEffects", "description": "Layer Style effects applied to the layer (e.g. drop shadow). Optional." }, "pixelMask": { "$ref": "#/components/schemas/EditPixelMask", "description": "Pixel mask applied to the layer. Supports delete for edit operations." }, "protection": { "type": "array", "description": "Protection flags for the layer (e.g. none, all, transparency, composite, position, artboard_autonest). Defaults to 'none' when adding layers. Optional for edits; omit, null, or empty array [] mean 'don't change'. When 'none' or 'all' is used, the array must contain only that element.", "items": { "type": "string", "description": "Protection flag for layer. Used in protection array.", "enum": [ "none", "all", "transparency", "composite", "position", "artboard_autonest" ] } }, "transform": { "$ref": "#/components/schemas/Transform", "description": "Transform applied to the layer" }, "transformMode": { "type": "string", "description": "Transform mode applied to the layer. Defaults to 'none' when adding layers. Optional for edits. Modes: 'none' — applies no scaling. 'fit' — scales the layer uniformly to fit within the canvas bounds while preserving aspect ratio. 'fill' — scales the layer uniformly to fill the canvas bounds while preserving aspect ratio, cropping overflow if the layer's aspect ratio differs from the canvas. 'custom' — applies the exact width and height from the Transform without preserving aspect ratio. Important for text layers: Any mode other than 'none' (or any non-identity scale on the Transform) causes the type engine to render glyphs and leading multiplied by the layer's scale factors. fontSize and lineHeight in CharacterStyle are stored unscaled. The rendered output becomes: fontSize x horizontalScale and lineHeight x verticalScale. To produce text at exact pixel sizes, use transformMode 'none' and avoid scaling Transforms on text layers.", "enum": [ "fit", "fill", "custom", "none" ] }, "type": { "type": "string", "description": "Type of layer. Required for add/edit operations, optional for delete/move.", "enum": [ "layer", "solid_color_layer", "text_layer", "smart_object_layer", "adjustment_layer", "group_layer", "background_layer" ] } } } ], "description": "Group layer for organizing layers hierarchically.", "required": [ "operation" ] }, "EditImageInput": { "type": "object", "description": "The image input for the edit operation. Supported input source mime types: image/jpeg, image/png, image/x-adobe-dng, image/webp, image/tiff, image/vnd.adobe.photoshop, image/x-sony-arw, and other supported raw/camera formats. Required.", "properties": { "source": { "$ref": "#/components/schemas/FileResourceInput", "description": "The resource input for the image. Required. Must be a valid FileResourceInput subtype: UrlResourceInput, CreativeCloudResourceInput, CreativeCloudFileIdResourceInput, or LightroomResourceInput.", "oneOf": [ { "$ref": "#/components/schemas/UrlResourceInput" }, { "$ref": "#/components/schemas/CreativeCloudResourceInput" }, { "$ref": "#/components/schemas/CreativeCloudFileIdResourceInput" }, { "$ref": "#/components/schemas/LightroomResourceInput" } ] } }, "required": [ "source" ] }, "EditLayer": { "allOf": [ { "$ref": "#/components/schemas/OperationBase" }, { "type": "object", "properties": { "blendOptions": { "$ref": "#/components/schemas/BlendOptions", "description": "Blend options for the layer" }, "image": { "$ref": "#/components/schemas/ImageSource", "description": "Image content including source URL. Supported file formats: PSD, PNG, JPEG, SVG." }, "isClipped": { "type": "boolean", "description": "Whether the layer is clipped. Optional for edits." }, "isVisible": { "type": "boolean", "description": "Whether the layer is visible. Defaults to true when adding layers. Optional for edits." }, "layerEffects": { "$ref": "#/components/schemas/LayerEffects", "description": "Layer Style effects applied to the layer (e.g. drop shadow). Optional." }, "pixelMask": { "$ref": "#/components/schemas/EditPixelMask", "description": "Pixel mask applied to the layer. Supports delete for edit operations." }, "protection": { "type": "array", "description": "Protection flags for the layer (e.g. none, all, transparency, composite, position, artboard_autonest). Defaults to 'none' when adding layers. Optional for edits; omit, null, or empty array [] mean 'don't change'. When 'none' or 'all' is used, the array must contain only that element.", "items": { "type": "string", "description": "Protection flag for layer. Used in protection array.", "enum": [ "none", "all", "transparency", "composite", "position", "artboard_autonest" ] } }, "transform": { "$ref": "#/components/schemas/Transform", "description": "Transform applied to the layer" }, "transformMode": { "type": "string", "description": "Transform mode applied to the layer. Defaults to 'none' when adding layers. Optional for edits. Modes: 'none' — applies no scaling. 'fit' — scales the layer uniformly to fit within the canvas bounds while preserving aspect ratio. 'fill' — scales the layer uniformly to fill the canvas bounds while preserving aspect ratio, cropping overflow if the layer's aspect ratio differs from the canvas. 'custom' — applies the exact width and height from the Transform without preserving aspect ratio. Important for text layers: Any mode other than 'none' (or any non-identity scale on the Transform) causes the type engine to render glyphs and leading multiplied by the layer's scale factors. fontSize and lineHeight in CharacterStyle are stored unscaled. The rendered output becomes: fontSize x horizontalScale and lineHeight x verticalScale. To produce text at exact pixel sizes, use transformMode 'none' and avoid scaling Transforms on text layers.", "enum": [ "fit", "fill", "custom", "none" ] }, "type": { "type": "string", "description": "Type of layer. Required for add/edit operations, optional for delete/move.", "enum": [ "layer", "solid_color_layer", "text_layer", "smart_object_layer", "adjustment_layer", "group_layer", "background_layer" ] } } } ], "description": "Image layer for editing existing image layers.", "required": [ "operation" ] }, "EditOperation": { "allOf": [ { "$ref": "#/components/schemas/Operation" } ], "description": "Edit operation for modifying existing layer properties", "required": [ "type" ] }, "EditPixelMask": { "type": "object", "description": "Pixel mask settings for edit operations. Extends PixelMask with the ability to delete the mask.", "properties": { "delete": { "type": "boolean", "description": "When true, removes the pixel mask from the layer. Takes precedence over all other options. Defaults to false." }, "isEnabled": { "type": "boolean", "description": "Whether the pixel mask is enabled. Optional. Defaults to true when adding new layers. Optional for edits" }, "isLinked": { "type": "boolean", "description": "Whether the pixel mask is linked to the layer. Optional. Defaults to true when adding new layers. Optional for edits" }, "offset": { "$ref": "#/components/schemas/Offset", "description": "Offset position for the pixel mask. Optional." }, "source": { "$ref": "#/components/schemas/FileResourceInput", "description": "Source input for the pixel mask. Must be an external file reference (URL, Creative Cloud path, or asset ID). Inline content is not supported. Optional." } }, "required": [ "delete" ] }, "EditRequest": { "type": "object", "properties": { "edits": { "$ref": "#/components/schemas/LightroomEdits", "description": "Lightroom edit adjustments including XMP, presets, and all adjustment parameters. Optional." }, "image": { "$ref": "#/components/schemas/EditImageInput" }, "outputs": { "type": "array", "description": "List of output asset details. Required. Maximum of 25 outputs allowed.", "items": { "oneOf": [ { "$ref": "#/components/schemas/LrDngOutput" }, { "$ref": "#/components/schemas/LrJpegOutput" }, { "$ref": "#/components/schemas/LrPngOutput" }, { "$ref": "#/components/schemas/XmpOutput" } ] }, "maxItems": 25, "minItems": 1 } }, "required": [ "image", "outputs" ] }, "EditSmartObject": { "type": "object", "description": "Smart object settings and file reference for edit operations.", "properties": { "autoResize": { "type": "boolean", "default": true, "description": "Controls how the embedded smart object content is sized when a replacement file is provided. Only applies to embedded smart objects (isLinked=false) with raster (PNG, JPEG, TIFF, PSD) or PDF/AI replacement files. SVG, vector formats without intrinsic dimensions, and linked smart objects are unaffected. true (default): scales the replacement to match the original smart object's canvas dimensions and resolution. false: preserves the replacement file's native dimensions and dpi." }, "contentPlacement": { "$ref": "#/components/schemas/SmartObjectContentPlacement", "description": "Optional frame-contained replacement policy for an existing embedded smart object. Requires smartObjectFile.source and isLinked=false. Omit autoResize, transformMode and transform when using this option. Omitting contentPlacement preserves the existing replacement behavior." }, "isLinked": { "type": "boolean", "default": false, "description": "Whether the smart object is linked to the layer." }, "smartObjectFile": { "$ref": "#/components/schemas/SmartObjectFile", "description": "File reference for the smart object. Supported file formats: PSD, PNG, JPEG, TIFF, SVG, PDF, AI. Optional." } } }, "EditSmartObjectLayer": { "allOf": [ { "$ref": "#/components/schemas/OperationBase" }, { "type": "object", "properties": { "blendOptions": { "$ref": "#/components/schemas/BlendOptions", "description": "Blend options for the layer" }, "isClipped": { "type": "boolean", "description": "Whether the layer is clipped. Optional for edits." }, "isVisible": { "type": "boolean", "description": "Whether the layer is visible. Defaults to true when adding layers. Optional for edits." }, "layerEffects": { "$ref": "#/components/schemas/LayerEffects", "description": "Layer Style effects applied to the layer (e.g. drop shadow). Optional." }, "pixelMask": { "$ref": "#/components/schemas/EditPixelMask", "description": "Pixel mask applied to the layer. Supports delete for edit operations." }, "protection": { "type": "array", "description": "Protection flags for the layer (e.g. none, all, transparency, composite, position, artboard_autonest). Defaults to 'none' when adding layers. Optional for edits; omit, null, or empty array [] mean 'don't change'. When 'none' or 'all' is used, the array must contain only that element.", "items": { "type": "string", "description": "Protection flag for layer. Used in protection array.", "enum": [ "none", "all", "transparency", "composite", "position", "artboard_autonest" ] } }, "smartObject": { "$ref": "#/components/schemas/EditSmartObject", "description": "Smart object settings and file reference." }, "transform": { "$ref": "#/components/schemas/Transform", "description": "Transform applied to the layer" }, "transformMode": { "type": "string", "description": "Transform mode applied to the layer. Defaults to 'none' when adding layers. Optional for edits. Modes: 'none' — applies no scaling. 'fit' — scales the layer uniformly to fit within the canvas bounds while preserving aspect ratio. 'fill' — scales the layer uniformly to fill the canvas bounds while preserving aspect ratio, cropping overflow if the layer's aspect ratio differs from the canvas. 'custom' — applies the exact width and height from the Transform without preserving aspect ratio. Important for text layers: Any mode other than 'none' (or any non-identity scale on the Transform) causes the type engine to render glyphs and leading multiplied by the layer's scale factors. fontSize and lineHeight in CharacterStyle are stored unscaled. The rendered output becomes: fontSize x horizontalScale and lineHeight x verticalScale. To produce text at exact pixel sizes, use transformMode 'none' and avoid scaling Transforms on text layers.", "enum": [ "fit", "fill", "custom", "none" ] }, "type": { "type": "string", "description": "Type of layer. Required for add/edit operations, optional for delete/move.", "enum": [ "layer", "solid_color_layer", "text_layer", "smart_object_layer", "adjustment_layer", "group_layer", "background_layer" ] } } } ], "description": "Smart object layer for embedding external files or vector graphics.", "required": [ "operation" ] }, "EditSolidColorLayer": { "allOf": [ { "$ref": "#/components/schemas/OperationBase" }, { "type": "object", "properties": { "blendOptions": { "$ref": "#/components/schemas/BlendOptions", "description": "Blend options for the layer" }, "fill": { "$ref": "#/components/schemas/Fill", "description": "Fill settings including color." }, "isClipped": { "type": "boolean", "description": "Whether the layer is clipped. Optional for edits." }, "isVisible": { "type": "boolean", "description": "Whether the layer is visible. Defaults to true when adding layers. Optional for edits." }, "layerEffects": { "$ref": "#/components/schemas/LayerEffects", "description": "Layer Style effects applied to the layer (e.g. drop shadow). Optional." }, "pixelMask": { "$ref": "#/components/schemas/EditPixelMask", "description": "Pixel mask applied to the layer. Supports delete for edit operations." }, "protection": { "type": "array", "description": "Protection flags for the layer (e.g. none, all, transparency, composite, position, artboard_autonest). Defaults to 'none' when adding layers. Optional for edits; omit, null, or empty array [] mean 'don't change'. When 'none' or 'all' is used, the array must contain only that element.", "items": { "type": "string", "description": "Protection flag for layer. Used in protection array.", "enum": [ "none", "all", "transparency", "composite", "position", "artboard_autonest" ] } }, "transform": { "$ref": "#/components/schemas/Transform", "description": "Transform applied to the layer" }, "transformMode": { "type": "string", "description": "Transform mode applied to the layer. Defaults to 'none' when adding layers. Optional for edits. Modes: 'none' — applies no scaling. 'fit' — scales the layer uniformly to fit within the canvas bounds while preserving aspect ratio. 'fill' — scales the layer uniformly to fill the canvas bounds while preserving aspect ratio, cropping overflow if the layer's aspect ratio differs from the canvas. 'custom' — applies the exact width and height from the Transform without preserving aspect ratio. Important for text layers: Any mode other than 'none' (or any non-identity scale on the Transform) causes the type engine to render glyphs and leading multiplied by the layer's scale factors. fontSize and lineHeight in CharacterStyle are stored unscaled. The rendered output becomes: fontSize x horizontalScale and lineHeight x verticalScale. To produce text at exact pixel sizes, use transformMode 'none' and avoid scaling Transforms on text layers.", "enum": [ "fit", "fill", "custom", "none" ] }, "type": { "type": "string", "description": "Type of layer. Required for add/edit operations, optional for delete/move.", "enum": [ "layer", "solid_color_layer", "text_layer", "smart_object_layer", "adjustment_layer", "group_layer", "background_layer" ] } } } ], "description": "Fill layer for editing solid color layer.", "required": [ "operation" ] }, "EditTextLayer": { "allOf": [ { "$ref": "#/components/schemas/OperationBase" }, { "type": "object", "properties": { "blendOptions": { "$ref": "#/components/schemas/BlendOptions", "description": "Blend options for the layer" }, "isClipped": { "type": "boolean", "description": "Whether the layer is clipped. Optional for edits." }, "isVisible": { "type": "boolean", "description": "Whether the layer is visible. Defaults to true when adding layers. Optional for edits." }, "layerEffects": { "$ref": "#/components/schemas/LayerEffects", "description": "Layer Style effects applied to the layer (e.g. drop shadow). Optional." }, "pixelMask": { "$ref": "#/components/schemas/EditPixelMask", "description": "Pixel mask applied to the layer. Supports delete for edit operations." }, "protection": { "type": "array", "description": "Protection flags for the layer (e.g. none, all, transparency, composite, position, artboard_autonest). Defaults to 'none' when adding layers. Optional for edits; omit, null, or empty array [] mean 'don't change'. When 'none' or 'all' is used, the array must contain only that element.", "items": { "type": "string", "description": "Protection flag for layer. Used in protection array.", "enum": [ "none", "all", "transparency", "composite", "position", "artboard_autonest" ] } }, "text": { "$ref": "#/components/schemas/Text", "description": "Text content and formatting settings for this text layer. Optional." }, "transform": { "$ref": "#/components/schemas/Transform", "description": "Transform applied to the layer" }, "transformMode": { "type": "string", "description": "Transform mode applied to the layer. Defaults to 'none' when adding layers. Optional for edits. Modes: 'none' — applies no scaling. 'fit' — scales the layer uniformly to fit within the canvas bounds while preserving aspect ratio. 'fill' — scales the layer uniformly to fill the canvas bounds while preserving aspect ratio, cropping overflow if the layer's aspect ratio differs from the canvas. 'custom' — applies the exact width and height from the Transform without preserving aspect ratio. Important for text layers: Any mode other than 'none' (or any non-identity scale on the Transform) causes the type engine to render glyphs and leading multiplied by the layer's scale factors. fontSize and lineHeight in CharacterStyle are stored unscaled. The rendered output becomes: fontSize x horizontalScale and lineHeight x verticalScale. To produce text at exact pixel sizes, use transformMode 'none' and avoid scaling Transforms on text layers.", "enum": [ "fit", "fill", "custom", "none" ] }, "type": { "type": "string", "description": "Type of layer. Required for add/edit operations, optional for delete/move.", "enum": [ "layer", "solid_color_layer", "text_layer", "smart_object_layer", "adjustment_layer", "group_layer", "background_layer" ] } } } ], "description": "Text layer for adding text content in the document.", "required": [ "operation" ] }, "Edits": { "type": "object", "properties": { "document": { "$ref": "#/components/schemas/Document", "description": "Document-level edits such as resize, crop, trim, etc. Optional." }, "layers": { "type": "array", "description": "Array of layer edits to be applied. Optional.", "items": { "oneOf": [ { "$ref": "#/components/schemas/AddAdjustmentLayer" }, { "$ref": "#/components/schemas/AddBackgroundLayer" }, { "$ref": "#/components/schemas/AddLayer" }, { "$ref": "#/components/schemas/AddSmartObjectLayer" }, { "$ref": "#/components/schemas/AddSolidColorLayer" }, { "$ref": "#/components/schemas/AddTextLayer" }, { "$ref": "#/components/schemas/DeleteLayer" }, { "$ref": "#/components/schemas/EditAdjustmentLayer" }, { "$ref": "#/components/schemas/EditBackgroundLayer" }, { "$ref": "#/components/schemas/EditGroupLayer" }, { "$ref": "#/components/schemas/EditLayer" }, { "$ref": "#/components/schemas/EditSmartObjectLayer" }, { "$ref": "#/components/schemas/EditSolidColorLayer" }, { "$ref": "#/components/schemas/EditTextLayer" }, { "$ref": "#/components/schemas/MoveLayer" } ] } } } }, "EffectColor": { "type": "object", "description": "Color for a layer effect.", "properties": { "rgb": { "$ref": "#/components/schemas/Rgb", "description": "RGB color values." } }, "required": [ "rgb" ] }, "EffectsAdjustments": { "type": "object", "description": "Effects adjustments for image editing.", "properties": { "clarity": { "type": "integer", "format": "int32", "description": "Clarity adjustment. Range: -100 to +100", "example": 5, "maximum": 100, "minimum": -100 }, "dehaze": { "type": "integer", "format": "int32", "description": "Dehaze adjustment. Range: -100 to +100", "example": 2, "maximum": 100, "minimum": -100 }, "texture": { "type": "integer", "format": "int32", "description": "Texture adjustment. Range: -100 to +100", "example": 10, "maximum": 100, "minimum": -100 }, "vignette": { "type": "integer", "format": "int32", "description": "Vignette amount. Range: -100 to +100", "example": -10, "maximum": 100, "minimum": -100 } } }, "EmbeddedDestination": { "allOf": [ { "$ref": "#/components/schemas/Destination" }, { "type": "object", "properties": { "embedded": { "type": "string", "default": "string", "description": "Embedded format (string, base64, or json). Defaults to string when omitted.", "enum": [ "string", "base64", "json" ] } } } ], "required": [ "embedded" ] }, "ErrorDetails": { "type": "object", "properties": { "errorCode": { "type": "string" }, "message": { "type": "string" } } }, "ErrorResponse": { "type": "object", "description": "Error response containing error code, message, and optional list of validation errors.\n\nError Code Reference:\n| Error Code | Message |\n| ----------------------------- | ------------------------------------|\n| | |\n| 401013 | Oauth token is not valid |\n| validation_error | Validation failed |\n| unsupported_method | Method not allowed |\n| invalid_content_type | Unsupported media type |\n| unknown_job_id | Job not found |\n| unauthorized_forbidden | The quota for the calling user has exhausted OR\n| | The Service is experiencing high traffic. please retry after a brief wait OR\n| | The user is not entitled to call this service OR\n| | The user is currently blocked by the admin OR\n| | The user is having an invalid subscription OR\n| | The user is blocked due to a violation OR\n| | The user is having an invalid scope |\n| unauthorized_legal_reasons | The user is unauthorised due to geo ip blocking failure OR\n| | The user is unauthorised due to user profile region failure from floodgate |\n| unauthorized_rate_limited | The user is unauthorised due to rate limit. When present, Retry-After header (seconds) indicates delay before retrying. |\n| runtime_error | There was a problem while attempting to perform the operation. Please try again. |\n| invalid_json | The request payload is having invalid JSON (fallback) |\n", "properties": { "error_code": { "type": "string", "description": "The error code for this specific validation error" }, "errors": { "type": "array", "description": "List of detailed validation errors when multiple errors occur. This field is optional and only populated when there are multiple validation errors.", "items": { "$ref": "#/components/schemas/ValidationError" } }, "message": { "type": "string", "description": "Human-readable string describing this specific validation error" } } }, "ExportOptions": { "type": "object", "description": "Export options for the image.", "discriminator": { "propertyName": "mediaType" }, "properties": { "mediaType": { "type": "string", "description": "The desired output format. Required. Supported formats: image/jpeg, image/png", "enum": [ "image/jpeg", "image/png", "image/tiff", "image/vnd.adobe.photoshop", "document/vnd.adobe.cpsd+dcxucf", "document/vnd.adobe.cpsd+dcx", "application/json" ] } }, "required": [ "mediaType" ] }, "ExportReferenceLayer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "shouldIncludeChildren": { "type": "boolean", "default": true, "description": "When this layer is a group, whether to include its children in the export. Defaults to true. Optional." } } }, "Exposure": { "type": "object", "properties": { "exposureValue": { "type": "number", "format": "double", "description": "The layer's exposure value. Range: -20 to 20. Defaults to 0.0 when adding new layers. Optional for edits", "maximum": 20.0, "minimum": -20.0 }, "gammaCorrection": { "type": "number", "format": "double", "description": "The layer's gamma correction value. Range: 0.01 to 9.99. Defaults to 1.0 when adding new layers. Optional for edits", "maximum": 9.99, "minimum": 0.01 }, "offset": { "type": "number", "format": "double", "description": "The layer's offset value. Range: -0.5 to 0.5. Defaults to 0.0 when adding new layers. Optional for edits", "maximum": 0.5, "minimum": -0.5 } } }, "ExposureAdjustments": { "allOf": [ { "$ref": "#/components/schemas/BaseAdjustment" }, { "type": "object", "properties": { "exposure": { "$ref": "#/components/schemas/Exposure", "description": "Exposure adjustment settings" } } } ], "description": "Exposure adjustment", "required": [ "exposure", "type" ] }, "ExtendedPhotoshopOutput": { "description": "Export options for a single output.", "discriminator": { "propertyName": "mediaType" }, "properties": { "mediaType": { "type": "string" } }, "required": [ "mediaType" ] }, "FileResourceInput": {}, "Fill": { "type": "object", "description": "Fill settings for layers.", "properties": { "solidColor": { "$ref": "#/components/schemas/SolidColor", "description": "Solid color fill settings. Optional." } } }, "Font": { "type": "object", "description": "Font definition with PostScript name.", "properties": { "postScriptName": { "type": "string", "description": "PostScript name of the font for precise identification. Optional." } } }, "FontColor": { "description": "Font color definition supporting RGB, CMYK, LAB, and Grayscale color models in 16-bit depth." }, "FontOptions": { "type": "object", "properties": { "additionalFonts": { "type": "array", "description": "Array of custom fonts needed in this document. Optional.", "items": { "$ref": "#/components/schemas/AdditionalFont" } }, "defaultFontPostScriptName": { "type": "string", "description": "The full postscript name of the font to be used as the global default for the document. Optional." }, "missingFontStrategy": { "type": "string", "description": "Action to take if there are missing fonts. Optional.", "enum": [ "fail", "use_default" ] } } }, "GenerateManifestRequest": { "type": "object", "properties": { "exportOptions": { "description": "Optional. Export options for the image.", "oneOf": [ { "$ref": "#/components/schemas/JpegExportOptions" }, { "$ref": "#/components/schemas/PngExportOptions" } ] }, "extractSmartObjectData": { "type": "boolean", "default": false, "description": "Optional. Extract embedded smart objects and include presigned URLs in the manifest. Only applies to embedded (non-linked) smart objects. Default is false.", "example": false }, "image": { "$ref": "#/components/schemas/Image", "description": "The image input, which contains a source field of type ResourceInput. Required." }, "includeLayerThumbnails": { "type": "boolean", "default": false, "description": "Optional. Indicates whether to generate renditions. Default is false.", "example": false }, "includeXmp": { "type": "boolean", "default": false, "description": "Optional. Include the XMP metadata in the response.", "example": false }, "maximumThumbnailDepth": { "type": "integer", "format": "int32", "description": "Optional. Depth for layer renditions. If provided, must be greater than or equal to 0. 0 signifies no limit.", "minimum": 0 }, "outputs": { "type": "array", "description": "List of output destinations for the manifest. Required. Maximum of 25 outputs allowed.", "items": { "oneOf": [ { "$ref": "#/components/schemas/ManifestJsonOutput" } ] }, "maxItems": 25, "minItems": 1 }, "trimToTransparency": { "type": "boolean", "default": false, "description": "Optional. Trim the layer to remove the transparent pixels.", "example": false } }, "required": [ "image", "outputs" ] }, "HostedDestination": { "allOf": [ { "$ref": "#/components/schemas/Destination" }, { "type": "object", "properties": { "validityPeriod": { "type": "integer", "format": "int32", "default": 3600, "description": "Validity period in seconds. Minimum: 60 seconds (1 minute). Maximum: 86400 seconds (1 day). Defaults to 3600 seconds (1 hour) when omitted.", "maximum": 86400, "minimum": 60 } } } ], "required": [ "validityPeriod" ] }, "HueSaturation": { "type": "object", "description": "Hue/Saturation adjustment settings. When colorize is true, LocalRange cannot be used. When colorize is false, LocalRange can only be used for non-master channels (reds, yellows, greens, cyans, blues, magentas).", "properties": { "colorize": { "type": "boolean", "description": "Whether to colorize the layer. When true, LocalRange cannot be used in any adjustment. Defaults to false when adding new layers. Optional for edits" }, "hueSaturationAdjustments": { "type": "array", "items": { "$ref": "#/components/schemas/HueSaturationAdjustment", "description": "Array of hue/saturation adjustments. For master channel, LocalRange is not applicable." }, "maxItems": 2147483647, "minItems": 1 } } }, "HueSaturationAdjustment": { "type": "object", "properties": { "hue": { "type": "integer", "format": "int32", "description": "The hue adjustment value. When colorize=false: -180 to 180. When colorize=true: 0 to 360. Defaults to 0 when adding new layers. Optional for edits" }, "lightness": { "type": "integer", "format": "int32", "description": "The lightness adjustment value. When colorize=false: -100 to 100. When colorize=true: 0 to 100. Defaults to 0 when adding new layers. Optional for edits" }, "localRange": { "$ref": "#/components/schemas/LocalRange", "description": "The local range for targeted color adjustments. Only applicable when colorize is false. Contains channel (reds, yellows, greens, cyans, blues, magentas) to specify target channel. If localRange is not present, adjustment applies to master channel (full hue wheel)." }, "saturation": { "type": "integer", "format": "int32", "description": "The saturation adjustment value. When colorize=false: -100 to 100. When colorize=true: 0 to 100. Defaults to 0 when adding new layers. Optional for edits" } } }, "HueSaturationAdjustments": { "allOf": [ { "$ref": "#/components/schemas/BaseAdjustment" }, { "type": "object", "properties": { "hueSaturation": { "$ref": "#/components/schemas/HueSaturation", "description": "Hue and saturation adjustment settings" } } } ], "description": "Hue and saturation adjustment", "required": [ "hueSaturation", "type" ] }, "IccProfile": { "type": "object", "description": "ICC profile configuration for color management", "discriminator": { "propertyName": "type" }, "properties": { "type": { "type": "string", "default": "standard", "description": "Type of ICC profile. 'standard' for predefined profiles, 'custom' for user-provided profiles. Defaults to standard when omitted; explicit null is invalid.", "enum": [ "standard", "custom" ], "example": "standard" } }, "required": [ "type" ] }, "Image": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/FileResourceInput", "description": "The resource input for the image. Required. Must be a valid FileResourceInput subtype: UrlResourceInput, CreativeCloudResourceInput, CreativeCloudFileIdResourceInput, or LightroomResourceInput.", "oneOf": [ { "$ref": "#/components/schemas/UrlResourceInput" }, { "$ref": "#/components/schemas/CreativeCloudResourceInput" }, { "$ref": "#/components/schemas/CreativeCloudFileIdResourceInput" }, { "$ref": "#/components/schemas/LightroomResourceInput" } ] } }, "required": [ "source" ] }, "ImageInput": { "description": "Image input configuration. Can be either a source image or parameters to create a new image." }, "ImageParameters": { "allOf": [ { "$ref": "#/components/schemas/ImageInput" }, { "type": "object", "properties": { "depth": { "type": "integer", "format": "int32", "description": "Bit depth. Optional. Supported: 1, 8, 16, 32. Valid per mode: rgb/hsb/grayscale(8,16,32), cmyk/lab(8,16), indexed/multichannel/duotone(8), bitmap(1).", "enum": [ 1, 8, 16, 32 ] }, "fill": { "type": "string", "description": "Fill color for the background. Optional.", "enum": [ "white", "background_color", "transparent" ] }, "height": { "type": "integer", "format": "int32", "default": 100, "description": "Height of the canvas in pixels (or points when unit is points_unit). Defaults to 100.", "maximum": 32000, "minimum": 1 }, "iccProfile": { "description": "ICC profile configuration for color management. Optional. Supports standard named profiles (e.g. sRGB, Adobe RGB 1998) and custom ICC profile files.", "oneOf": [ { "$ref": "#/components/schemas/StandardIccProfile" }, { "$ref": "#/components/schemas/CustomIccProfile" } ] }, "mode": { "type": "string", "description": "Color mode. Optional. Supported: rgb, bitmap, grayscale, indexed, cmyk, lab, hsb, duotone, multichannel. Defaults to rgb. Depth constraints per mode: bitmap(omit depth), grayscale(8,16,32), indexed(8), rgb/hsb(8,16,32), cmyk/lab(8,16), multichannel(8,16), duotone(8).", "enum": [ "rgb", "bitmap", "grayscale", "indexed", "hsb", "cmyk", "lab", "duotone", "multichannel" ] }, "name": { "type": "string", "description": "Name/title of the document. Optional. Maximum 255 characters.", "maxLength": 255, "minLength": 0 }, "pixelScaleFactor": { "type": "number", "format": "double", "default": "1.0", "description": "Pixel scale factor. Optional. Must be positive (minimum 0.1).", "minimum": 0.1 }, "resolution": { "$ref": "#/components/schemas/ResolutionMeasurement", "default": { "value": 72, "unit": "density_unit" }, "description": "Resolution with value and unit. Optional. When specified, value must be a positive number (density_unit)." }, "unit": { "type": "string", "default": "pixels_unit", "description": "Unit applied to width and height values. Use 'points_unit' when dimensions are in typographic points. Defaults to pixels_unit.", "enum": [ "pixels_unit", "percent_unit", "distance_unit", "points_unit" ] }, "width": { "type": "integer", "format": "int32", "default": 100, "description": "Width of the canvas in pixels (or points when unit is points_unit). Defaults to 100.", "maximum": 32000, "minimum": 1 } } } ], "required": [ "height", "width" ] }, "ImageSource": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/FileResourceInput", "description": "The resource input for the image. Required. Must be an external file reference (URL, Creative Cloud, etc.). Inline content is not supported.", "oneOf": [ { "$ref": "#/components/schemas/UrlResourceInput" }, { "$ref": "#/components/schemas/CreativeCloudResourceInput" }, { "$ref": "#/components/schemas/CreativeCloudFileIdResourceInput" }, { "$ref": "#/components/schemas/LightroomResourceInput" } ] } }, "required": [ "source" ] }, "InlineContentResourceInput": { "allOf": [ { "$ref": "#/components/schemas/ResourceInput" }, { "type": "object", "properties": { "content": { "type": "string", "description": "Inline content as string (for scripts, JSON, or other text-based content). Required. Maximum size: 50KB (51,200 characters).", "maxLength": 51200, "minLength": 0 }, "contentType": { "type": "string", "description": "MIME type of the content. Optional but recommended for proper processing." } } } ], "description": "Inline content resource input. Allows embedding content directly in the request.", "required": [ "content" ] }, "JobAcceptedResponse": { "type": "object", "properties": { "jobId": { "type": "string" }, "statusUrl": { "type": "string" } } }, "JobStatusResponse": { "type": "object", "properties": { "createdTime": { "type": "string", "format": "date-time" }, "errorDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDetails" } }, "jobId": { "type": "string" }, "modifiedTime": { "type": "string", "format": "date-time" }, "result": { "$ref": "#/components/schemas/Result" }, "status": { "type": "string", "enum": [ "not_started", "running", "succeeded", "failed" ] } } }, "JpegExportOptions": { "allOf": [ { "$ref": "#/components/schemas/ExportOptions" }, { "type": "object", "properties": { "quality": { "type": "string", "description": "Optional. The quality of the JPEG export.", "enum": [ "very_poor", "poor", "low", "medium", "high", "maximum", "photoshop_max" ] }, "scan": { "$ref": "#/components/schemas/JpegScanOptions" } } } ], "description": "Jpeg Export options for the image.", "required": [ "mediaType" ] }, "JpegOutput": { "allOf": [ { "$ref": "#/components/schemas/PhotoshopOutput" }, { "type": "object", "properties": { "quality": { "type": "string", "description": "JPEG quality setting. Optional.", "enum": [ "very_poor", "poor", "low", "medium", "high", "maximum", "photoshop_max" ] } } } ], "required": [ "destination", "mediaType" ] }, "JpegOutputWithScan": { "allOf": [ { "$ref": "#/components/schemas/ExtendedPhotoshopOutput" }, { "type": "object", "properties": { "cropMode": { "type": "string", "description": "Crop mode for export output. Optional.", "enum": [ "trim_to_transparency", "document_bounds", "layer_bounds" ] }, "destination": { "description": "The destination details for the output file. Required. When scriptOutputPattern is used, only EmbeddedDestination and HostedDestination are supported. URL destinations (presigned URLs) and Creative Cloud destinations cannot be used with scriptOutputPattern because they require pre-knowledge of file names and counts.", "oneOf": [ { "$ref": "#/components/schemas/CreativeCloudDestination" }, { "$ref": "#/components/schemas/EmbeddedDestination" }, { "$ref": "#/components/schemas/HostedDestination" }, { "$ref": "#/components/schemas/UrlDestination" } ] }, "height": { "type": "integer", "format": "int32", "description": "Height in pixels. Must be >= 0. Optional.", "minimum": 0 }, "iccProfile": { "description": "ICC profile configuration for color management. Allows specifying standard ICC profiles (e.g., sRGB, Adobe RGB) or custom ICC profile files. Supported output formats: JPEG, PNG, TIFF, PSD. Not supported for PSDC (document/vnd.adobe.cpsd+dcxucf, document/vnd.adobe.cpsd+dcx). Optional.", "oneOf": [ { "$ref": "#/components/schemas/StandardIccProfile" }, { "$ref": "#/components/schemas/CustomIccProfile" } ] }, "layers": { "type": "array", "description": "Layers to export. Specify layers by id, name, or both. Optional.", "items": { "$ref": "#/components/schemas/ExportReferenceLayer" }, "maxItems": 100, "minItems": 0 }, "maxWidth": { "type": "integer", "format": "int32", "description": "Maximum width constraint in pixels. Must be >= 0. If specified and (width > maxWidth OR documentWidth > maxWidth), the output will be constrained to maxWidth. Optional.", "minimum": 0 }, "mediaType": { "type": "string", "default": "image/jpeg", "description": "The desired output format. Supported formats: image/jpeg, image/png, image/tiff, image/vnd.adobe.photoshop, document/vnd.adobe.cpsd+dcxucf, document/vnd.adobe.cpsd+dcx and application/json. Defaults to image/jpeg when omitted.", "enum": [ "image/jpeg", "image/png", "image/tiff", "image/vnd.adobe.photoshop", "document/vnd.adobe.cpsd+dcxucf", "document/vnd.adobe.cpsd+dcx", "application/json" ] }, "quality": { "type": "string", "description": "JPEG quality setting. Optional.", "enum": [ "very_poor", "poor", "low", "medium", "high", "maximum", "photoshop_max" ] }, "resample": { "type": "string", "description": "Resampling algorithm used when resizing output to a target width. Valid values: nearest_neighbor, bilinear, bicubic, bicubic_smoother, bicubic_sharper. Defaults to bicubic_sharper when width or maxWidth is specified and this field is omitted. Optional.", "enum": [ "nearest_neighbor", "bilinear", "bicubic", "bicubic_smoother", "bicubic_sharper" ] }, "scan": { "$ref": "#/components/schemas/JpegScanOptions" }, "scriptOutputPattern": { "type": "string", "description": "Pattern for matching script output files in the UXP output directory. Supports both exact filenames and glob patterns. Examples: 'output.json' (matches single specific file), '*.json' (matches all JSON files), 'result-*.png' (matches result-1.png, result-2.png, etc.). Files are filtered based on the mediaType of this output definition. Only files with extensions matching the mediaType will be included. When a pattern matches multiple files, one output entry is created per file. When present, skips normal rendering/export and uses matched files instead. Output parameters like quality, compression, width, and height are ignored when this field is present. Only applicable for /v2/execute-actions endpoint. Optional, nullable.", "maxLength": 255, "minLength": 0 }, "shouldOverwrite": { "type": "boolean", "description": "Whether to overwrite existing files. Optional." }, "width": { "type": "integer", "format": "int32", "description": "Width in pixels. Must be >= 0. Optional.", "minimum": 0 } } } ], "required": [ "destination", "mediaType" ] }, "JpegScanOptions": { "type": "object", "description": "JPEG scan/encoding options (baseline vs progressive). Only supported on the create-composite, create-artboard, and generate-manifest endpoints. Optional; defaults to baseline standard encoding when omitted.", "properties": { "optimized": { "type": "boolean", "default": false, "description": "Whether to use baseline-optimized encoding. Only valid when type is baseline." }, "scans": { "type": "integer", "format": "int32", "description": "Number of progressive scans. Only valid when type is progressive. Allowed values: 3, 4, 5.", "maximum": 5, "minimum": 3 }, "type": { "type": "string", "default": "baseline", "description": "JPEG scan type.", "enum": [ "baseline", "progressive" ] } } }, "JsonOutput": { "allOf": [ { "$ref": "#/components/schemas/PhotoshopOutput" }, { "$ref": "#/components/schemas/ExtendedPhotoshopOutput" } ], "description": "JSON output configuration", "required": [ "destination", "mediaType" ] }, "LayerEffects": { "type": "object", "description": "Layer Style effects applied to the layer.", "properties": { "dropShadow": { "type": "array", "description": "One or more drop shadow effects. Between 1 and 10 per layer. Optional.", "items": { "$ref": "#/components/schemas/DropShadow" }, "maxItems": 10, "minItems": 1 } } }, "LightAdjustments": { "type": "object", "description": "Light adjustments for image editing.", "properties": { "blacks": { "type": "integer", "format": "int32", "description": "Blacks adjustment. Range: -100 to +100", "example": -10, "maximum": 100, "minimum": -100 }, "contrast": { "type": "integer", "format": "int32", "description": "Contrast adjustment. Range: -100 to +100", "example": 10, "maximum": 100, "minimum": -100 }, "exposure": { "type": "number", "format": "double", "description": "Exposure adjustment. Range: -5.0 to +5.0", "example": 1.2, "maximum": 5, "minimum": -5 }, "highlights": { "type": "integer", "format": "int32", "description": "Highlights adjustment. Range: -100 to +100", "example": -20, "maximum": 100, "minimum": -100 }, "shadows": { "type": "integer", "format": "int32", "description": "Shadows adjustment. Range: -100 to +100", "example": 15, "maximum": 100, "minimum": -100 }, "whites": { "type": "integer", "format": "int32", "description": "Whites adjustment. Range: -100 to +100", "example": 5, "maximum": 100, "minimum": -100 } } }, "LightroomEdits": { "type": "object", "properties": { "autoStraighten": { "$ref": "#/components/schemas/AutoStraighten", "description": "Auto straighten adjustment with options. Optional." }, "autoTone": { "type": "boolean", "description": "Auto tone adjustment. Optional." }, "color": { "$ref": "#/components/schemas/ColorAdjustments", "description": "Color adjustments. Optional." }, "effects": { "$ref": "#/components/schemas/EffectsAdjustments", "description": "Effects adjustments. Optional." }, "light": { "$ref": "#/components/schemas/LightAdjustments", "description": "Light adjustments. Optional." }, "noiseReduction": { "$ref": "#/components/schemas/NoiseReduction", "description": "Noise reduction settings. Optional." }, "presets": { "type": "array", "description": "List of preset inputs to apply. Optional.", "items": { "$ref": "#/components/schemas/FileResourceInput" }, "maxItems": 10, "minItems": 0 }, "sharpen": { "$ref": "#/components/schemas/SharpenAdjustments", "description": "Sharpen adjustments. Optional." }, "sharpness": { "type": "integer", "format": "int32", "description": "Sharpness value. Optional. Range: 0 to 150", "maximum": 150, "minimum": 0 }, "xmp": { "$ref": "#/components/schemas/XmpInput", "description": "XMP metadata input for the edit operation. Optional." } } }, "LightroomOutput": { "type": "object", "description": "Export options for a single output.", "discriminator": { "propertyName": "mediaType" }, "properties": { "destination": { "description": "The destination details for the output file. Required.", "oneOf": [ { "$ref": "#/components/schemas/CreativeCloudDestination" }, { "$ref": "#/components/schemas/EmbeddedDestination" }, { "$ref": "#/components/schemas/HostedDestination" }, { "$ref": "#/components/schemas/UrlDestination" } ] }, "mediaType": { "type": "string", "description": "The manifest output type. Required. Supported types: application/json", "enum": [ "image/jpeg", "image/png", "image/x-adobe-dng", "application/rdf+xml" ] } }, "required": [ "destination", "mediaType" ] }, "LightroomResourceInput": { "allOf": [ { "$ref": "#/components/schemas/ResourceInput" }, { "type": "object", "properties": { "lightroomPath": { "type": "string", "description": "The path to the asset in Lightroom. Required. Must be a partial path that starts with '/v2/', e.g. '/v2/catalogs/{catalogId}/assets/{assetId}/revisions/{revisionId}/proxies/{proxyId}'. The host/domain is always fixed server-side and cannot be supplied by the caller. Only letters, digits, '.', '_', '-' and '/' are allowed — query strings, fragments, schemes, hosts, percent-encoding, and '..' path segments are all rejected.", "minLength": 1, "pattern": "^/v2/[A-Za-z0-9_.-]+(?:/[A-Za-z0-9_.-]+)*$" } } } ], "description": "Lightroom resource input. References a resource via Lightroom path.", "required": [ "lightroomPath" ] }, "LocalRange": { "type": "object", "description": "Local range settings for targeted color adjustments. Defines the hue range boundaries for the adjustment.", "properties": { "beginRamp": { "type": "integer", "format": "int32", "description": "The beginning of the ramp (feather start). Range: 0-360 degrees.", "maximum": 360, "minimum": 0 }, "beginSustain": { "type": "integer", "format": "int32", "description": "The beginning of the sustain (full effect start). Range: 0-360 degrees.", "maximum": 360, "minimum": 0 }, "channelId": { "type": "string", "default": "REDS", "description": "The channel for this local range adjustment. Allowed values: REDS, YELLOWS, GREENS, CYANS, BLUES, MAGENTAS. Defaults to REDS when omitted.", "enum": [ "REDS", "YELLOWS", "GREENS", "CYANS", "BLUES", "MAGENTAS" ] }, "endRamp": { "type": "integer", "format": "int32", "description": "The end of the ramp (feather end). Range: 0-360 degrees.", "maximum": 360, "minimum": 0 }, "endSustain": { "type": "integer", "format": "int32", "description": "The end of the sustain (full effect end). Range: 0-360 degrees.", "maximum": 360, "minimum": 0 } }, "required": [ "channelId" ] }, "LrDngOutput": { "allOf": [ { "$ref": "#/components/schemas/LightroomOutput" } ], "required": [ "destination", "mediaType" ] }, "LrJpegOutput": { "allOf": [ { "$ref": "#/components/schemas/LightroomOutput" }, { "type": "object", "properties": { "quality": { "type": "string", "description": "JPEG quality setting. Optional.", "enum": [ "very_poor", "poor", "low", "medium", "high", "maximum", "photoshop_max" ] } } } ], "required": [ "destination", "mediaType" ] }, "LrPngOutput": { "allOf": [ { "$ref": "#/components/schemas/LightroomOutput" }, { "type": "object", "properties": { "compression": { "type": "string", "description": "PNG compression level. Optional.", "enum": [ "none", "very_low", "low", "medium_low", "medium", "medium_high", "default", "high", "very_high", "maximum" ] } } } ], "required": [ "destination", "mediaType" ] }, "ManifestJsonOutput": { "allOf": [ { "$ref": "#/components/schemas/ManifestOutput" } ], "description": "JSON manifest output configuration", "required": [ "destination", "mediaType" ] }, "ManifestOutput": { "type": "object", "description": "Export options for manifest output.", "discriminator": { "propertyName": "mediaType" }, "properties": { "destination": { "description": "The destination details for the output file. Required.", "oneOf": [ { "$ref": "#/components/schemas/CreativeCloudDestination" }, { "$ref": "#/components/schemas/EmbeddedDestination" }, { "$ref": "#/components/schemas/HostedDestination" }, { "$ref": "#/components/schemas/UrlDestination" } ] }, "mediaType": { "type": "string", "default": "application/json", "description": "The manifest output type. Supported types: application/json. Defaults to application/json when omitted.", "enum": [ "application/json" ] } }, "required": [ "destination", "mediaType" ] }, "Mask": { "type": "object", "description": "Mask input for XMP operations. Contains source file reference and digest for dictionary lookup.", "properties": { "digest": { "type": "string", "description": "Fingerprint/digest of the mask for dictionary lookup. Required." }, "source": { "$ref": "#/components/schemas/FileResourceInput", "description": "Source input for the mask file. Required. Must be an external file reference (URL, Creative Cloud path, or Creative Cloud file ID). Inline content is not supported." } }, "required": [ "digest", "source" ] }, "MoveLayer": { "allOf": [ { "$ref": "#/components/schemas/OperationBase" } ], "description": "Layer for move operations", "required": [ "operation" ] }, "MoveOperation": { "allOf": [ { "$ref": "#/components/schemas/Operation" }, { "type": "object", "properties": { "placement": { "$ref": "#/components/schemas/Placement", "description": "Placement settings for the move operation. Required." }, "shouldIncludeChildren": { "type": "boolean", "description": "Whether to include child layers in the move. Optional." } } } ], "description": "Move operation for moving layers.", "required": [ "placement", "type" ] }, "NoiseReduction": { "type": "object", "description": "Noise reduction settings for image editing.", "properties": { "color": { "type": "integer", "format": "int32", "description": "Color noise reduction. Range: 0 to 100", "example": 10, "maximum": 100, "minimum": 0 }, "luminance": { "type": "integer", "format": "int32", "description": "Luminance noise reduction. Range: 0 to 100", "example": 25, "maximum": 100, "minimum": 0 } } }, "Offset": { "type": "object", "description": "Offset coordinates for positioning elements.", "properties": { "horizontal": { "type": "integer", "format": "int32", "description": "Horizontal offset in pixels. Defaults to 0 when adding new layers. Optional for edits." }, "vertical": { "type": "integer", "format": "int32", "description": "Vertical offset in pixels. Defaults to 0 when adding new layers. Optional for edits." } } }, "Operation": { "type": "object", "description": "Layer operation settings including placement, delete, move and edit operations.", "discriminator": { "propertyName": "type" }, "properties": { "type": { "type": "string", "description": "Type of operation. Required.", "enum": [ "add", "edit", "delete", "move" ] } }, "required": [ "type" ] }, "OperationBase": { "type": "object", "description": "Base for a single layer edit. When present, the 'operation' field is required.", "properties": { "id": { "type": "integer", "format": "int32", "description": "Layer ID" }, "name": { "type": "string", "description": "Layer name" }, "operation": { "description": "Operation to perform on the layer. Required.", "oneOf": [ { "$ref": "#/components/schemas/AddOperation" }, { "$ref": "#/components/schemas/DeleteOperation" }, { "$ref": "#/components/schemas/EditOperation" }, { "$ref": "#/components/schemas/MoveOperation" } ] } }, "required": [ "operation" ] }, "Origin": { "type": "object", "description": "2D point coordinates", "properties": { "x": { "type": "integer", "format": "int32", "description": "X coordinate" }, "y": { "type": "integer", "format": "int32", "description": "Y coordinate" } } }, "ParagraphStyle": { "type": "object", "description": "Paragraph style properties.", "properties": { "alignment": { "type": "string", "description": "Text alignment. Optional. Default is left.", "enum": [ "left", "center", "right", "justify", "justify_left", "justify_right", "justify_center" ] }, "endIndent": { "type": "number", "format": "double", "description": "End indent in pixels. Optional. Default is 0." }, "firstLineIndent": { "type": "number", "format": "double", "description": "First line indent in pixels. Optional. Default is 0." }, "spaceAfter": { "type": "number", "format": "double", "description": "Space after paragraph in pixels. Optional. Default is 0." }, "spaceBefore": { "type": "number", "format": "double", "description": "Space before paragraph in pixels. Optional. Default is 0." }, "startIndent": { "type": "number", "format": "double", "description": "Start indent in pixels. Optional. Default is 0." }, "writingDirection": { "type": "string", "description": "Writing direction. Optional. Default is left_to_right.", "enum": [ "left_to_right", "right_to_left" ] } } }, "ParagraphStyleRange": { "type": "object", "description": "Paragraph style range defining paragraph formatting for specific text ranges.", "properties": { "apply": { "$ref": "#/components/schemas/Apply", "description": "Range of paragraphs to apply styling to. Optional." }, "paragraphStyle": { "$ref": "#/components/schemas/ParagraphStyle", "description": "Paragraph style settings. Optional." } } }, "PatternResource": { "type": "object", "description": "External pattern file reference. Requires source (URL, Creative Cloud path, or Creative Cloud file ID). Inline content is not supported.", "properties": { "source": { "$ref": "#/components/schemas/PortableFileResourceInput", "description": "Source for the pattern resource. Must be a URL, Creative Cloud path, or Creative Cloud file ID. Lightroom resources are not supported for patterns. Inline content is not supported." } }, "required": [ "source" ] }, "PhotoshopOutput": { "type": "object", "description": "Export options for a single output.", "discriminator": { "propertyName": "mediaType" }, "properties": { "cropMode": { "type": "string", "description": "Crop mode for export output. Optional.", "enum": [ "trim_to_transparency", "document_bounds", "layer_bounds" ] }, "destination": { "description": "The destination details for the output file. Required. When scriptOutputPattern is used, only EmbeddedDestination and HostedDestination are supported. URL destinations (presigned URLs) and Creative Cloud destinations cannot be used with scriptOutputPattern because they require pre-knowledge of file names and counts.", "oneOf": [ { "$ref": "#/components/schemas/CreativeCloudDestination" }, { "$ref": "#/components/schemas/EmbeddedDestination" }, { "$ref": "#/components/schemas/HostedDestination" }, { "$ref": "#/components/schemas/UrlDestination" } ] }, "height": { "type": "integer", "format": "int32", "description": "Height in pixels. Must be >= 0. Optional.", "minimum": 0 }, "iccProfile": { "description": "ICC profile configuration for color management. Allows specifying standard ICC profiles (e.g., sRGB, Adobe RGB) or custom ICC profile files. Supported output formats: JPEG, PNG, TIFF, PSD. Not supported for PSDC (document/vnd.adobe.cpsd+dcxucf, document/vnd.adobe.cpsd+dcx). Optional.", "oneOf": [ { "$ref": "#/components/schemas/StandardIccProfile" }, { "$ref": "#/components/schemas/CustomIccProfile" } ] }, "layers": { "type": "array", "description": "Layers to export. Specify layers by id, name, or both. Optional.", "items": { "$ref": "#/components/schemas/ExportReferenceLayer" }, "maxItems": 100, "minItems": 0 }, "maxWidth": { "type": "integer", "format": "int32", "description": "Maximum width constraint in pixels. Must be >= 0. If specified and (width > maxWidth OR documentWidth > maxWidth), the output will be constrained to maxWidth. Optional.", "minimum": 0 }, "mediaType": { "type": "string", "default": "image/jpeg", "description": "The desired output format. Supported formats: image/jpeg, image/png, image/tiff, image/vnd.adobe.photoshop, document/vnd.adobe.cpsd+dcxucf, document/vnd.adobe.cpsd+dcx and application/json. Defaults to image/jpeg when omitted.", "enum": [ "image/jpeg", "image/png", "image/tiff", "image/vnd.adobe.photoshop", "document/vnd.adobe.cpsd+dcxucf", "document/vnd.adobe.cpsd+dcx", "application/json" ] }, "resample": { "type": "string", "description": "Resampling algorithm used when resizing output to a target width. Valid values: nearest_neighbor, bilinear, bicubic, bicubic_smoother, bicubic_sharper. Defaults to bicubic_sharper when width or maxWidth is specified and this field is omitted. Optional.", "enum": [ "nearest_neighbor", "bilinear", "bicubic", "bicubic_smoother", "bicubic_sharper" ] }, "scriptOutputPattern": { "type": "string", "description": "Pattern for matching script output files in the UXP output directory. Supports both exact filenames and glob patterns. Examples: 'output.json' (matches single specific file), '*.json' (matches all JSON files), 'result-*.png' (matches result-1.png, result-2.png, etc.). Files are filtered based on the mediaType of this output definition. Only files with extensions matching the mediaType will be included. When a pattern matches multiple files, one output entry is created per file. When present, skips normal rendering/export and uses matched files instead. Output parameters like quality, compression, width, and height are ignored when this field is present. Only applicable for /v2/execute-actions endpoint. Optional, nullable.", "maxLength": 255, "minLength": 0 }, "shouldOverwrite": { "type": "boolean", "description": "Whether to overwrite existing files. Optional." }, "width": { "type": "integer", "format": "int32", "description": "Width in pixels. Must be >= 0. Optional.", "minimum": 0 } }, "required": [ "destination", "mediaType" ] }, "PixelMask": { "type": "object", "description": "Pixel mask settings for layer operations, including source input and pixel mask properties.", "properties": { "isEnabled": { "type": "boolean", "description": "Whether the pixel mask is enabled. Optional. Defaults to true when adding new layers. Optional for edits" }, "isLinked": { "type": "boolean", "description": "Whether the pixel mask is linked to the layer. Optional. Defaults to true when adding new layers. Optional for edits" }, "offset": { "$ref": "#/components/schemas/Offset", "description": "Offset position for the pixel mask. Optional." }, "source": { "$ref": "#/components/schemas/FileResourceInput", "description": "Source input for the pixel mask. Must be an external file reference (URL, Creative Cloud path, or asset ID). Inline content is not supported. Optional." } } }, "Placement": { "type": "object", "description": "Placement settings for positioning elements with alignment and insertion point.", "properties": { "referenceLayer": { "$ref": "#/components/schemas/ReferenceLayer" }, "type": { "type": "string", "default": "top", "description": "Type of placement operation (below, into, top, bottom, above). Defaults to top when omitted.", "enum": [ "below", "into", "top", "bottom", "above" ] } }, "required": [ "type" ] }, "PngExportOptions": { "allOf": [ { "$ref": "#/components/schemas/ExportOptions" }, { "type": "object", "properties": { "compression": { "type": "string", "description": "Optional. The compression level of the PNG export.", "enum": [ "none", "very_low", "low", "medium_low", "medium", "medium_high", "default", "high", "very_high", "maximum" ] } } } ], "description": "Png Export options for the image.", "required": [ "mediaType" ] }, "PngOutput": { "allOf": [ { "$ref": "#/components/schemas/PhotoshopOutput" }, { "type": "object", "properties": { "compression": { "type": "string", "description": "PNG compression level. Optional.", "enum": [ "none", "very_low", "low", "medium_low", "medium", "medium_high", "default", "high", "very_high", "maximum" ] } } }, { "$ref": "#/components/schemas/ExtendedPhotoshopOutput" } ], "required": [ "destination", "mediaType" ] }, "PointFrame": { "allOf": [ { "$ref": "#/components/schemas/TextFrame" }, { "type": "object", "properties": { "origin": { "$ref": "#/components/schemas/Origin", "description": "Starting origin coordinates" } } } ], "description": "Point frame for text starting at a single point", "required": [ "type" ] }, "PortableFileResourceInput": { "description": "External file reference. Must be a URL, Creative Cloud path, or Creative Cloud file ID. Lightroom resources are not supported.", "oneOf": [ { "$ref": "#/components/schemas/UrlResourceInput" }, { "$ref": "#/components/schemas/CreativeCloudResourceInput" }, { "$ref": "#/components/schemas/CreativeCloudFileIdResourceInput" } ] }, "PsdOutput": { "allOf": [ { "$ref": "#/components/schemas/PhotoshopOutput" }, { "$ref": "#/components/schemas/ExtendedPhotoshopOutput" } ], "required": [ "destination", "mediaType" ] }, "PsdcOutput": { "allOf": [ { "$ref": "#/components/schemas/PhotoshopOutput" }, { "$ref": "#/components/schemas/ExtendedPhotoshopOutput" } ], "required": [ "destination", "mediaType" ] }, "ReferenceLayer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "Resize": { "type": "object", "description": "Options for resizing a document, including width, height, resolution, resample type, and additional flags.", "properties": { "constrainProportions": { "type": "boolean", "default": true, "description": "Whether to constrain proportions during resizing." }, "height": { "$ref": "#/components/schemas/DimensionMeasurement", "description": "The target height for resizing. Optional." }, "rasterize": { "type": "boolean", "description": "Whether to rasterize the image during resizing. Optional." }, "resample": { "type": "string", "default": "bilinear", "description": "The resampling method to use when resizing.", "enum": [ "nearest_neighbor", "bilinear", "bicubic", "bicubic_smoother", "bicubic_sharper" ] }, "resolution": { "$ref": "#/components/schemas/ResolutionMeasurement", "description": "The target resolution for resizing. Optional." }, "scaleStyles": { "type": "boolean", "default": true, "description": "Whether to scale styles during resizing." }, "width": { "$ref": "#/components/schemas/DimensionMeasurement", "description": "The target width for resizing. Optional." } } }, "ResolutionMeasurement": { "type": "object", "description": "Represents a resolution measurement with density unit.", "properties": { "unit": { "type": "string", "default": "density_unit", "description": "The unit of measurement for resolution. 'density_unit' represents pixel density measurements like DPI (dots per inch) or PPI (pixels per inch). Defaults to density_unit when omitted.", "enum": [ "density_unit" ] }, "value": { "type": "integer", "format": "int32", "description": "The value of the resolution. Must be greater than or equal to 1.", "minimum": 1 } }, "required": [ "unit" ] }, "ResourceInput": {}, "Result": { "type": "object", "properties": { "additionalFields": { "type": "object", "additionalProperties": {} }, "outputs": {} } }, "Rgb": { "type": "object", "description": "RGB color values with red, green, and blue components.", "properties": { "blue": { "type": "integer", "format": "int32", "default": 0, "description": "Blue component value (0-255). Defaults to 0 when omitted.", "maximum": 255, "minimum": 0 }, "green": { "type": "integer", "format": "int32", "default": 0, "description": "Green component value (0-255). Defaults to 0 when omitted.", "maximum": 255, "minimum": 0 }, "red": { "type": "integer", "format": "int32", "default": 0, "description": "Red component value (0-255). Defaults to 0 when omitted.", "maximum": 255, "minimum": 0 } }, "required": [ "blue", "green", "red" ] }, "SharpenAdjustments": { "type": "object", "description": "Sharpen adjustments for image editing.", "properties": { "detail": { "type": "integer", "format": "int32", "description": "Sharpen detail. Range: 0 to 100", "example": 50, "maximum": 100, "minimum": 0 }, "edgeMasking": { "type": "integer", "format": "int32", "description": "Sharpen edge masking. Range: 0 to 100", "example": 25, "maximum": 100, "minimum": 0 }, "radius": { "type": "number", "format": "double", "description": "Sharpen radius. Range: 0.5 to 3.0", "example": 1.0, "maximum": 3.0, "minimum": 0.5 } } }, "Skew": { "type": "object", "description": "Skew transformation settings for horizontal and vertical distortion.", "properties": { "horizontal": { "type": "integer", "format": "int32", "description": "Horizontal skew. Required." }, "vertical": { "type": "integer", "format": "int32", "description": "Vertical skew. Required." } }, "required": [ "horizontal", "vertical" ] }, "SmartObject": { "type": "object", "description": "Smart object settings and file reference.", "properties": { "isLinked": { "type": "boolean", "default": false, "description": "Whether the smart object is linked to the layer." }, "smartObjectFile": { "$ref": "#/components/schemas/SmartObjectFile", "description": "File reference for the smart object. Supported file formats: PSD, PNG, JPEG, TIFF, SVG, PDF, AI. Optional." } } }, "SmartObjectContentPlacement": { "type": "object", "description": "Opt-in, non-destructive replacement within an existing embedded smart object's frame. The ingredient is retained inside a nested smart object. Alignment is relative to the frame, not the document canvas. Linked, skewed/perspective and pixel-masked rotated frames are unsupported.", "properties": { "horizontalAlign": { "type": "string", "default": "left", "description": "Horizontal alignment within the smart object's frame.", "enum": [ "left", "center", "right" ] }, "mode": { "type": "string", "description": "fit contains the full ingredient; fill covers the frame and clips visible overflow while retaining the source.", "enum": [ "fit", "fill" ] }, "verticalAlign": { "type": "string", "default": "top", "description": "Vertical alignment within the smart object's frame.", "enum": [ "top", "center", "bottom" ] } }, "required": [ "mode" ] }, "SmartObjectFile": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/FileResourceInput", "description": "Source for the smart object file. Must be an external file reference. Inline content is not supported." } } }, "SolidColor": { "type": "object", "description": "Solid color definition using RGB values.", "properties": { "rgb": { "$ref": "#/components/schemas/Rgb", "description": "RGB color values. Required." } }, "required": [ "rgb" ] }, "StandardIccProfile": { "allOf": [ { "$ref": "#/components/schemas/IccProfile" }, { "type": "object", "properties": { "imageMode": { "type": "string", "description": "Image mode for standard ICC profiles. Allowed values: rgb, grayscale. Optional", "enum": [ "rgb", "grayscale" ], "example": "rgb" }, "name": { "type": "string", "default": "sRGB IEC61966-2.1", "description": "Standard ICC profile name. Must be one of the predefined values: Adobe RGB (1998), Apple RGB, ColorMatch RGB, sRGB IEC61966-2.1, Dot Gain 10%, Dot Gain 15%, Dot Gain 20%, Dot Gain 25%, Dot Gain 30%, Gray Gamma 1.8, Gray Gamma 2.2. Defaults to sRGB IEC61966-2.1 when omitted; explicit null is invalid.", "enum": [ "Adobe RGB (1998)", "Apple RGB", "ColorMatch RGB", "sRGB IEC61966-2.1", "Dot Gain 10%", "Dot Gain 15%", "Dot Gain 20%", "Dot Gain 25%", "Dot Gain 30%", "Gray Gamma 1.8", "Gray Gamma 2.2" ], "example": "sRGB IEC61966-2.1" } } } ], "description": "Standard ICC profile with predefined profile names", "required": [ "name", "type" ] }, "Text": { "type": "object", "description": "Text content and formatting settings for text layers.", "properties": { "antiAliasing": { "type": "string", "description": "Anti-aliasing setting for text. Optional.", "enum": [ "none", "sharp", "crisp", "strong", "smooth" ] }, "characterStyles": { "type": "array", "description": "Character styles applied to text ranges. Optional.", "items": { "$ref": "#/components/schemas/CharacterStyleRange" } }, "content": { "type": "string", "description": "The text content. Optional." }, "frame": { "description": "Frame configuration contains frameType and frame-specific properties. Optional.", "oneOf": [ { "$ref": "#/components/schemas/AreaFrame" }, { "$ref": "#/components/schemas/PointFrame" } ] }, "paragraphStyles": { "type": "array", "description": "Paragraph styles applied to text ranges. Optional.", "items": { "$ref": "#/components/schemas/ParagraphStyleRange" } }, "textOrientation": { "type": "string", "description": "Text orientation. Optional.", "enum": [ "horizontal", "vertical" ] } } }, "TextFrame": { "type": "object", "description": "Frame configuration for text layers", "discriminator": { "propertyName": "type" }, "properties": { "type": { "type": "string", "description": "Type of frame", "enum": [ "point", "area" ] } }, "required": [ "type" ] }, "TiffOutput": { "allOf": [ { "$ref": "#/components/schemas/PhotoshopOutput" }, { "$ref": "#/components/schemas/ExtendedPhotoshopOutput" } ], "required": [ "destination", "mediaType" ] }, "Transform": { "type": "object", "description": "Transformation applied to the smart object or layer, optional", "properties": { "anchor": { "$ref": "#/components/schemas/Anchor", "description": "Anchor point for transformation" }, "angle": { "type": "number", "format": "double", "description": "Rotation angle in degrees" }, "dimension": { "$ref": "#/components/schemas/Dimension", "description": "Dimension after transformation" }, "horizontalAlign": { "type": "string", "description": "Horizontal alignment", "enum": [ "left", "center", "right" ] }, "offset": { "$ref": "#/components/schemas/Offset", "description": "Offset for transformation" }, "skew": { "$ref": "#/components/schemas/Skew", "description": "Skew transformation" }, "verticalAlign": { "type": "string", "description": "Vertical alignment", "enum": [ "top", "center", "bottom" ] } } }, "TransparencyShape": { "type": "object", "description": "Contour (transparency shape) applied to a layer effect. Name is required; curve is required when name is Custom.", "properties": { "curve": { "type": "array", "description": "Curve points defining the contour shape. Required when name is Custom.", "items": { "$ref": "#/components/schemas/CurvePoint" } }, "name": { "type": "string", "description": "Name of the contour preset. Required. Only \"Custom\" is supported currently.", "enum": [ "Custom" ] } }, "required": [ "curve", "name" ] }, "Trim": { "type": "object", "description": "Options for trimming a document, specifying the basis for the trim operation.", "properties": { "trimUpon": { "type": "string", "description": "The basis for the trim operation (background or transparent). Optional.", "enum": [ "transparent_pixels" ] } } }, "UrlDestination": { "allOf": [ { "$ref": "#/components/schemas/Destination" }, { "type": "object", "properties": { "storageType": { "type": "string", "description": "Storage type for the destination. Optional.", "enum": [ "azure", "dropbox" ] }, "url": { "type": "string", "description": "Pre-signed URL for external storage. Must be HTTPS. Required.", "minLength": 1 } } } ], "required": [ "url" ] }, "UrlResourceInput": { "allOf": [ { "$ref": "#/components/schemas/ResourceInput" }, { "type": "object", "properties": { "url": { "type": "string", "description": "The pre-signed URL of the resource. Required.", "minLength": 1 } } } ], "description": "URL resource input. References a resource via a pre-signed URL.", "required": [ "url" ] }, "UxpResource": { "type": "object", "description": "UXP plugin script resource. Requires source (external file reference or inline script content).", "properties": { "source": { "description": "Source for the UXP script. Can be external file reference or inline script content. UXP scripts can use the placeholder `__UXP_OUTPUT_PATH__` which will be replaced at runtime with the directory path for script output files. Example usage: `const outputPath = '__UXP_OUTPUT_PATH__'; const outputFile = path.join(outputPath, 'uxpOutput.json');`", "oneOf": [ { "$ref": "#/components/schemas/CreativeCloudFileIdResourceInput" }, { "$ref": "#/components/schemas/CreativeCloudResourceInput" }, { "$ref": "#/components/schemas/InlineContentResourceInput" }, { "$ref": "#/components/schemas/LightroomResourceInput" }, { "$ref": "#/components/schemas/UrlResourceInput" } ] } }, "required": [ "source" ] }, "ValidationError": { "type": "object", "description": "Represents a single validation error with error code and message", "properties": { "error_code": { "type": "string", "description": "The error code for this specific validation error" }, "message": { "type": "string", "description": "Human-readable string describing this specific validation error" } } }, "XmpInput": { "type": "object", "description": "XMP metadata input. Requires source (external file reference). Inline content is not supported.", "properties": { "masks": { "type": "array", "description": "List of mask inputs. Optional. Each mask contains a source file reference and digest for dictionary lookup.", "items": { "$ref": "#/components/schemas/Mask" } }, "orientation": { "type": "string", "description": "XMP orientation value to override image orientation. Optional.", "enum": [ "top_left", "top_right", "bottom_right", "bottom_left", "left_top", "right_top", "right_bottom", "left_bottom" ] }, "source": { "$ref": "#/components/schemas/FileResourceInput", "description": "The resource input for the XMP. Required. Must be an external file reference (URL, Creative Cloud path, or Creative Cloud file ID). Inline content is not supported." } }, "required": [ "source" ] }, "XmpOutput": { "allOf": [ { "$ref": "#/components/schemas/LightroomOutput" }, { "type": "object", "properties": { "preset": { "type": "boolean", "description": "Optional. When true, produces a portable Lightroom preset instead of a plain XMP sidecar of the applied edit parameters. Default: false." } } } ], "required": [ "destination", "mediaType" ] }, "RemoveBackgroundV2Request": { "type": "object", "properties": { "image": { "description": "The image to be processed.", "allOf": [ { "$ref": "#/components/schemas/RemoveBgInputImage" } ] }, "mode": { "$ref": "#/components/schemas/RemoveBgMode" }, "output": { "description": "The options for the output image.", "allOf": [ { "$ref": "#/components/schemas/RemoveBgOutputImageOptions" } ] }, "trim": { "type": "boolean", "description": "If true, the image returned is cropped to the cutout border. Transparent pixels are removed.", "default": false }, "backgroundColor": { "description": "The background color.", "allOf": [ { "$ref": "#/components/schemas/RemoveBgColor" } ] }, "colorDecontamination": { "type": "number", "description": "If the value is greater than 0, automatically removes colored reflections that have been left on the main subject by the background.", "minimum": 0, "maximum": 1, "default": 1, "example": 1 } }, "required": [ "image" ] }, "RemoveBgColor": { "type": "object", "properties": { "red": { "type": "number", "description": "The red value of the color.", "minimum": 0, "maximum": 255 }, "green": { "type": "number", "description": "The green value of the color.", "minimum": 0, "maximum": 255 }, "blue": { "type": "number", "description": "The blue value of the color.", "minimum": 0, "maximum": 255 }, "alpha": { "type": "number", "description": "The transparency value. 0 is fully transparent and 1 is fully opaque.", "minimum": 0, "maximum": 1 } }, "required": [ "red", "green", "blue", "alpha" ] }, "RemoveBgMode": { "type": "string", "description": "The mode of background removal.", "default": "cutout", "enum": [ "cutout", "mask", "psd" ] }, "RemoveBgInputImage": { "type": "object", "properties": { "source": { "description": "The source path for the input image. Dimensions of the image should not be greater than 6000px X 6000px. The image media type must be `image/jpeg`, `image/png`, `image/webp`, or `image/tiff`.", "allOf": [ { "$ref": "#/components/schemas/UrlResource" } ] } }, "required": [ "source" ] }, "UrlResource": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL of the resource. Only these listed domains are accepted in the request: \n
amazonaws.comwindows.netdropboxusercontent.comassets.frame.iostorage.googleapis.com