The identity and technical contract details declared by the specification.
FontRgb
object
RGB color values for fonts with 16-bit depth (red, green, blue components).
3 required
ExportOptions
object
Export options for the image.
1 property
1 required
AdditionalFont
object
Array of custom fonts needed in this document. Optional.
1 property
GenerateManifestRequest
object
8 properties
2 required
AddAdjustmentLayer
object
Adjustment layer for applying image adjustments like brightness, contrast, hue/saturation, etc.
2 required
ResourceInput
object
Source for the UXP script. Can be external file reference or inline script content. UXP scripts can use the placeholder UXPOUTPUTPATH which will be replaced at…
CreativeCloudFileIdResourceInput
object
Creative Cloud file ID resource input. References a resource via Creative Cloud file ID (URN).
1 required
Crop
object
Options for cropping a document, specifying the bounds to crop to.
2 properties
1 required
BaseAdjustment
object
Adjustment settings to apply. Must specify exactly one adjustment type (brightnesscontrast, huesaturation, exposure, or colorbalance).
1 property
1 required
LrJpegOutput
object
2 required
JpegOutput
object
2 required
CharacterStyle
object
Character-level styling properties for text.
11 properties
CreateArtboardRequest
object
3 properties
2 required
ErrorResponse
object
Error response containing error code, message, and optional list of validation errors. Error Code Reference: | Error Code | Message | | -----------------------…
3 properties
JpegExportOptions
object
Jpeg Export options for the image.
1 required
EditSolidColorLayer
object
Fill layer for editing solid color layer.
1 required
PortableFileResourceInput
object
External file reference. Must be a URL, Creative Cloud path, or Creative Cloud file ID. Lightroom resources are not supported.
PatternResource
object
External pattern file reference. Requires source (URL, Creative Cloud path, or Creative Cloud file ID). Inline content is not supported.
1 property
1 required
JsonOutput
object
JSON output configuration
2 required
ImageSource
object
The image input for the actions operation. Required.
1 property
1 required
Operation
object
Layer operation settings including placement, delete, move and edit operations.
1 property
1 required
EditLayer
object
Image layer for editing existing image layers.
1 required
Exposure
object
Exposure adjustment settings
3 properties
DimensionMeasurement
object
Represents a dimension measurement for width or height with appropriate units.
2 properties
1 required
MoveLayer
object
Layer for move operations
1 required
ValidationError
object
Represents a single validation error with error code and message
2 properties
AreaFrame
object
Area text frame defining a bounded rectangular region for text content. Text will wrap within the specified bounds
1 required
Resize
object
Options for resizing a document, including width, height, resolution, resample type, and additional flags.
7 properties
ParagraphStyleRange
object
Paragraph style range defining paragraph formatting for specific text ranges.
2 properties
LightAdjustments
object
Light adjustments for image editing.
6 properties
EditTextLayer
object
Text layer for adding text content in the document.
1 required
ImageParameters
object
2 required
ColorBalanceAdjustments
object
Color balance adjustment
2 required
Placement
object
Placement settings for positioning elements with alignment and insertion point.
2 properties
1 required
HueSaturationAdjustments
object
Hue and saturation adjustment
2 required
Origin
object
2D point coordinates
2 properties
Mask
object
Mask input for XMP operations. Contains source file reference and digest for dictionary lookup.
2 properties
2 required
EditSmartObject
object
Smart object settings and file reference for edit operations.
3 properties
NoiseReduction
object
Noise reduction settings for image editing.
2 properties
Bounds
object
Area boundaries
4 properties
ImageInput
object
Image input configuration. Can be either a source image or parameters to create a new image.
CustomIccProfile
object
Custom ICC profile with user-provided profile file
3 required
AutoStraighten
object
Auto straighten configuration with options
3 properties
1 required
CharacterStyleRange
object
Character style range defining styling for specific text ranges.
2 properties
PsdcOutput
object
2 required
ManifestJsonOutput
object
JSON manifest output configuration
2 required
PngOutput
object
2 required
Destination
object
Destination for output files. Can be either a URL with optional storage type or a Creative Cloud path.
FontColor
object
Font color definition supporting RGB, CMYK, LAB, and Grayscale color models in 16-bit depth.
FontLab
object
LAB color values for fonts with 16-bit depth (lightness and color channels).
3 required
Edits
object
Edits to be applied to the input asset. Optional.
2 properties
AddSmartObjectLayer
object
Smart object layer for embedding external files or vector graphics.
2 required
PngExportOptions
object
Png Export options for the image.
1 required
SmartObject
object
Smart object settings and file reference.
2 properties
ArtboardImageInput
object
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). Req…
2 properties
1 required
Image
object
The image input, which contains a source field of type ResourceInput. Required.
1 property
1 required
Fill
object
Fill settings for layers.
1 property
FileResourceInput
object
The resource input for the image. Required. Must be a valid FileResourceInput subtype: UrlResourceInput, CreativeCloudResourceInput, CreativeCloudFileIdResourc…
EffectsAdjustments
object
Effects adjustments for image editing.
4 properties
EditGroupLayer
object
Group layer for organizing layers hierarchically.
1 required
AddOperation
object
Add operation for adding layers.
2 required
PointFrame
object
Point frame for text starting at a single point
1 required
Document
object
Represents the editable document structure, including resize, crop and trim options. Each field corresponds to a specific type of document edit operation.
3 properties
LrPngOutput
object
2 required
BrushResource
object
Single brush resource (.abr, etc.). When present, the 'source' field is required.
1 property
1 required
EditPixelMask
object
Pixel mask settings for edit operations. Extends PixelMask with the ability to delete the mask.
5 properties
1 required
BrightnessContrast
object
Brightness and contrast adjustment settings
2 properties
Transform
object
Transformation applied to the smart object or layer, optional
7 properties
TextFrame
object
Frame configuration for text layers
1 property
1 required
Dimension
object
Offset coordinates for positioning elements.
3 properties
ActionResource
object
Single Photoshop action resource (.atn or inline actionJSON). When present, the 'source' field is required.
2 properties
1 required
AutoCropInputImage
object
The input image for the auto-crop operation.
2 properties
1 required
FontGray
object
Grayscale color value for fonts with 16-bit depth.
1 required
DeleteOperation
object
Delete operation for removing layers.
1 required
AddBackgroundLayer
object
Background layer for adding a background to the document.
1 required
Offset
object
Offset coordinates for positioning elements.
2 properties
EditBackgroundLayer
object
Background layer for editing an existing background layer.
1 required
OperationBase
object
Base for a single layer edit. When present, the 'operation' field is required.
3 properties
1 required
Font
object
Font definition with PostScript name.
1 property
ManifestOutput
object
Export options for manifest output.
2 properties
2 required
AddSolidColorLayer
object
Fill layer for adding solid color layer.
2 required
XmpOutput
object
2 required
HostedDestination
object
1 required
FontCmyk
object
CMYK color values for fonts with 16-bit depth (cyan, magenta, yellow, black components).
4 required
ParagraphStyle
object
Paragraph style properties.
7 properties
AutoCropMode
string
Mode for the auto crop operation. 'smartCrop' and 'subjectCrop' generate crops using aspectRatio with optional zoom. 'fullSceneDetection' and 'objectDetection'…
InlineContentResourceInput
object
Inline content resource input. Allows embedding content directly in the request.
1 required
TiffOutput
object
2 required
ActionsRequest
object
3 properties
3 required
LrDngOutput
object
2 required
AutoCropAspectRatio
string
Desired aspect ratio for generated crops.
LightroomEdits
object
Lightroom edit adjustments including XMP, presets, and all adjustment parameters. Optional.
10 properties
FontOptions
object
Font options configuration. Optional.
3 properties
AddLayer
object
Image layer for adding raster images to the document.
2 required
ColorBalance
object
Color balance adjustment settings
4 properties
StandardIccProfile
object
Standard ICC profile with predefined profile names
2 required
PixelMask
object
Pixel mask settings for layer operations, including source input and pixel mask properties.
4 properties
EditOperation
object
Edit operation for modifying existing layer properties
1 required
EditImageInput
object
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.ph…
1 property
1 required
AutoCropImageMediaType
string
The media type of the input image. Supported values are image/jpeg, image/png, and image/webp.
ReferenceLayer
object
Layers to export. Specify layers by id, name, or both. Optional.
2 properties
CreativeCloudDestination
object
1 required
MoveOperation
object
Move operation for moving layers.
2 required
LocalRange
object
Local range settings for targeted color adjustments. Defines the hue range boundaries for the adjustment.
5 properties
1 required
EmbeddedDestination
object
1 required
PsdOutput
object
2 required
Trim
object
Options for trimming a document, specifying the basis for the trim operation.
1 property
LightroomOutput
object
Export options for a single output.
2 properties
2 required
PhotoshopOutput
object
Export options for a single output.
11 properties
2 required
UrlDestination
object
1 required
UrlResourceInput
object
URL resource input. References a resource via a pre-signed URL.
1 required
AdditionalContentResource
object
Single additional resource (images, js, brushes, etc.). When present, the 'source' field is required.
1 property
1 required
Apply
object
Inclusive range (from/to) for character or paragraph styling. When present, both 'from' and 'to' are required.
2 properties
2 required
Anchor
object
Anchor point coordinates for transformations and positioning.
2 properties
2 required
AutoCropUrlResource
object
The source of the input image.
1 property
1 required
BlendOptions
object
Blend options for layer effects, including opacity settings.
2 properties
ResolutionMeasurement
object
Represents a resolution measurement with density unit.
2 properties
1 required
XmpInput
object
XMP metadata input. Requires source (external file reference). Inline content is not supported.
3 properties
1 required
ExposureAdjustments
object
Exposure adjustment
2 required
HueSaturationAdjustment
object
Array of hue/saturation adjustments. For master channel, LocalRange is not applicable.
4 properties
AutoCropOutputType
string
Output type for the auto crop operation. 'images' returns cropped images with presigned URLs (default). 'boundingBoxes' returns only bounding box coordinates.
CreativeCloudResourceInput
object
Creative Cloud resource input. References a resource via Creative Cloud path.
1 required
ActionsOptions
object
Options configuration for the actions execution. At least one of actions or uxp is required.
6 properties
DeleteLayer
object
Layer for delete operations
1 required
Rgb
object
RGB color values with red, green, and blue components.
3 properties
3 required
SharpenAdjustments
object
Sharpen adjustments for image editing.
3 properties
LightroomResourceInput
object
Lightroom resource input. References a resource via Lightroom path.
1 required
IccProfile
object
ICC profile configuration for color management
1 property
1 required
EditSmartObjectLayer
object
Smart object layer for embedding external files or vector graphics.
1 required
AddTextLayer
object
Text layer for adding text content in the document.
2 required
Skew
object
Skew transformation settings for horizontal and vertical distortion.
2 properties
2 required
AddGroupLayer
object
Group layer for organizing layers hierarchically.
1 required
BrightnessContrastAdjustments
object
Brightness and contrast adjustment
2 required
Text
object
Text content and formatting settings for text layers.
6 properties
UxpResource
object
UXP plugin script resource. Requires source (external file reference or inline script content).
1 property
1 required
AutoCropRequest
object
6 properties
2 required
EditRequest
object
3 properties
2 required
CreateCompositeRequest
object
4 properties
2 required
ColorAdjustments
object
Color adjustments for image editing.
3 properties
SmartObjectFile
object
File reference for the smart object. Supported file formats: PSD, PNG, JPEG, TIFF, SVG. Optional.
1 property
EditAdjustmentLayer
object
Adjustment layer for applying image adjustments like brightness, contrast, hue/saturation, etc.
1 required
JobAcceptedResponse
object
2 properties
SolidColor
object
Solid color definition using RGB values.
1 property
1 required
HueSaturation
object
Hue/Saturation adjustment settings. When colorize is true, LocalRange cannot be used. When colorize is false, LocalRange can only be used for non-master channe…
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Adobe Suite publishes across the network.