Skip to main content

Supported Features

This is a list of currently supported features. Please also see the for a list of newly added featuresRelease Notes

Photoshop#​

The APIs are documented at Photoshop API

SmartObject#​

The Photoshop APIs currently support creating and editing of Embedded Smart Objects. Support for Linked Smart Objects is forthcoming.

  • In order to update an embedded smart object that is referenced by multiple layers you need to update each of those layers, then only the effect will be reflected in all layers referencing the same smart object.
  • The replaced smart object is placed within the bounding box of the original image. If the new image is bigger or smaller than the original image, it fits into the original bounding box maintaining the aspect ratio. You can change the bounds of the replaced image by passing bounds parameters in the API call.
  • If your document contains transparent pixels (e.g some .png) for the smart object layer, you may not get consistent bounds.

The APIs are documented . We also have an example of replacing a Smart Object within a layer. . For better performance, we rasterize our smart objects that are bigger than 2000 pixels * 2000 pixels. For optimal processing, please make sure the embedded smart object that you want to replace only contains alphanumeric characters in it's name.hereSmart Object Example Code

Text()New!#​

The Photoshop /text API supports editing one or more text layers from a Photoshop document. The APIs are documented here

It enables user to

  • Format text properties such as antialias, orientation and be able to edit text contents. (Note: Changing only the text properties will not change any character/paragraph styling)
  • Some of the key character properties that can be formatted include (but not limited to):
    • Text treatments such as strikethrough, underline, fontCaps
    • Character size and color
    • Line and character spacing through leading, tracking, autoKern settings
  • All the paragraph properties are supported
  • Use custom fonts when specified through the options.fonts section in the API request body

Usage Recommendations#​

Known Limitations#​

The following are known limitations for the Alpha release

  • The API cannot automatically detect missing fonts in the layers. To prevent potential missing fonts from being replaced, please provide a href to the font(s) in the options.fonts section of the API. For more details on specifying custom fonts, please refer to the example section below.

Here is a code example.

ProductCrop()New!#​

The ProductCrop API supports applying smart crop to your image. The APIs are documented here

It enables user to

  • Identify the product and get it cropped smartly.
  • Enter the required padding they need in their cropped image.

Known Limitations#​

  • The current model is trained to return a crop that respects the salient object within an image. There is a current known issue that when a person or portrait is contained within a salient object, the model will crop with the person as the focal area rather than the salient object that contains it. This is problematic in the case of an item where an image of a person is contained within a design (i.e. a t-shirt, collectible or art). Rather than crop to the intended item, the service will crop to the person within the item. We intend to correct this issue in future releases.

Here is a code example.

DepthBlur()New!#​

The DepthBlur API supports applying depth blur to your image. The APIs are documented here

Depth Blur is part of the Neural Filters gallery in Photoshop. It allows you to target the area and range of blur in photos, creating wide-aperture depth of field blur effects. You may choose different focal points or remove the focal point and control the depth blur through manipulating the focal range slider. Setting focusSubject to true will select the most prominent subject in the image and apply depth blur around that subject.

Here is a code example.

Photoshop Actions()New!#​

Execute Photoshop Actions#​

Adobe Photoshop APIs supports playing back Photoshop Actions recorded from Photoshop. The APIs are documented here

An action is a series of tasks that you play back on a single file or a batch of files—menu commands, panel options, tool actions, and so on. For example, you can create an action that changes the size of an image, applies an effect to the image, and then saves the file in the desired format.

For more information on how to create Photoshop Actions, see Adobe Help Center

Usage Recommendations#​

  • Create actions that do not open any operating system dialogs. All Photoshop dialogs are supported, but not operating system dialogs.
  • It is recommended to create Actions that do not require user interactions.
  • Input and Output file format should be any of PSD, JPEG, PNG, or TIFF.
  • Make sure to test your actions on Photoshop, with several different input/images. If it has any errors on Photoshop, it won't run successfully on our servers either.

Known Limitations#​

The following are known limitations for the Alpha release

  • Not supported, 3D and Video features
  • Custom presets (for example color swatches and brushes)
  • The action should operate on one document. Multiple documents support will be in a future release

Here are examples of submitting and executing Photoshop Actions. and Execute Photoshop Actions with all actionsExecute Photoshop Actions with a specific action

Rendering / Conversions#​

  • Create a new PSD document
  • Create a JPEG, TIFF or PNG rendition of various sizes
  • Request thumbnail previews of all renderable layers
  • Convert between any of the supported filetypes (PSD, JPEG, TIFF, PNG)

Here is an example of creating JPEG and PNG rendtions of a PSD document. Render PSD document

Layer level edits#​

  • General layer edits

    • Edit the layer name
    • Toggle the layer locked state
    • Toggle layer visibility
    • Move or resize the layer via it's bounds
    • Delete layers

  • Adjustment layers ()

    Pre-Release Feature!!
    • Add or edit an adjustment layer. The following types of adjustment layers are currently supported:
    • Brightness and Contrast
    • Exposure
    • Hue and Saturation
    • Color Balance

  • Image/Pixel layers ()

    Pre-Release Feature!!
    • Add a new pixel layer, with optional image
    • Swap the image in an existing pixel layer

  • Shape layers ()

    Pre-Release Feature!!
    • Resize a shape layer via it's bounds

The add, edit and delete objects#​

The API should primarily be used to make layer and/or document level edits to your PSD and then generate new renditions with the changes. You can pass in a flat array of only the layers that you wish to act upon, in the argument of the request body. The layer name (or the layer id) will be used by the service to identify the correct layer to operation upon in your PSD./documentOperations``options.layers

The , , and blocks indicate the action you would like to be taken on a particular layer object. Any layer block passed into the API that is missing one of these attributes will be ignored. The and blocks must also supply one of the attributes , , , or to indicate where you want to move the layer to. More details on this can be found in the API documentation.add``edit``move``delete``add``move``insertAbove``insertBelow``insertInto``insertTop``insertBottom

Note: Adding a new layer does not require the ID to be included, the service will generate a new layer id for you.

Here are some examples of making various layer level edits.

Text layers Edits#​

The Photoshop API currently support creating and editing of Text Layer with different fonts, character styles and paragraph styles. The set of text attributes that can be edited is listed below:

  • Edit the text contents
  • Change the font (See the section for more info)Fonts
  • Edit the font size
  • Change the font color in the following formats: rgb, cmyk, gray, lab
  • Edit the text orientation (horizontal/vertical)
  • Edit the paragraph alignment (left, center, right, justify, justifyLeft, justifyCenter, justifyRight)

The APIs are documented here

We also have an example of making a simple text layer edit.

Text layer Example Code

Font handling#​

In order to be able to correctly operate on text layers in the PSD, the corresponding fonts needed for these layers will need to be available when the server is processing the PSD. These include fonts from the following cases:

  1. The font that is in the text layer being edited, but the font itself is not being changed
  2. If the font in a text layer is being changed to a new font

While referencing fonts in the API request, please ensure that the correct Postscript name for that font is used. Referencing to that font with any other name will result in the API treating this as a missing font.

The Photoshop APIs supports using the following category of fonts:

  • Currently Installed Fonts on the server listed here

  • Fonts that you are authorized to access via . Currently only available for OAuth tokens, JWT service token support is forthcoming.Adobe FontsNote:

  • Custom/Other Fonts: These are the fonts that are either owned by you or the ones that only you are authorized to use. To use a custom font you must include an href to the font in your request. Look at the

section of the API docs for more information. For including an href to the font in your request, please ensure the font file name to be in this format:

, when it is being uploaded in your choice of storage. A sample

section will look like so:

This also applies to any other font present in the document which is not to be found in the first 2 categories above.

options.fonts
<font_postscript_name>.<ext>
options.fonts

Copy

1{
2  "storage": "external",
3  "href": "<Storage URL to OpenSansCondensed-Light.ttf>"
4}

Note:

Here is an example usage of a custom font Custom font

Handle missing fonts in the document.#​

The API provides two options to control the behavior when there are missing fonts, as the request is being processed:

  • Specify a global font which would act as a default font for the current request: The field in the section of the request can be used to specify the full postscript name of this font. For any textLayer edit/add operation, if the font used specifically for that layer is missing, this font will be used as the default. If the global font itself is missing, then the action to be taken will be dictated by the options as explained here in the next bullet point.globalFont``options``manageMissingFonts

Note: If using an OAuth integration, Adobe Fonts can be used as a global font as well. If the global font is a custom font, please upload the font to one of the cloud storage types that is supported and specify the href and storage type in the options.fonts section of the request.

  • Specify the action to be taken if one or more fonts required for the add/edit operation(s) are missing: The

field in the

section of the request can be used to specify this action. It can accept one of the following 2 values:

manageMissingFonts
options
  • fail to force the request/job to fail
  • useDefault to use our system designated default font, which is: ArialMT

Here is an example usage of and . manageMissingFonts``globalFontHandle missing fonts

Limitations#​
  • Most of the text attributes retain their respective original values. There are some attributes however that do not retain their original values. For example (and not limited to): tracking, leading, kerning

Document level edits#​

  • Crop a PSD
  • Resize a PSD

Artboards#​

  • Show artboard information in the JSON Manifest
  • Create a new artboard from multiple input psd's

Lightroom#​

The APIs are documented at . Any input image format that is supported by Lightroom is also supported by the APIs. To look at the list of these formats in more detail, please refer to: Lightroom APIhttps://helpx.adobe.com/lightroom-classic/help/supported-file-formats.html

At this point the output formats supported are JPG, DNG and PNG.

AutoTone#​

Automatically tone an image to correct exposure/contrast/sharpness/etc. Code example here

AutoStraighten#​

Applies the Auto Upright transformation on an image. Code example here

Presets#​

Apply one or more XMP Lightroom presets to an image, by referencing preset file(s) stored on cloud. Code example The preset file can be created by editing an image in lightroom and exporting it as a file. The details on how to create a preset can be found . If the use case would be to be able to create an file from a set of slider values obtained directly from a user, there are 2 ways to achieve this workflow:here.xmphere.xmp

  1. Start with the empty file from and add the corresponding slider values.xmphere
  2. Or please look ahead in this documentation page at the /edit API

Edit#​

Apply one or more Lightroom edits to an image. Code example here

XMP#​

Apply a Lightroom preset to an image, by passing in the preset XMP contents inline through the API. Code example here

Sensei#​

These are the APIs powered by Sensei, Adobe’s Artificial Intelligence Technology, and Photoshop. The APIs can identify the main subject of an image and produce two types of outputs. You can create a greyscale png file that you can composite onto the original image (or any other). You can also create a cutout where the mask has already composited onto your original image so that everything except the main subject has been removed.mask

ORIGINALMASKCUTOUT
alt imagealt imagealt image

The APIs are documented at Sensei API Reference

Image Cutout#​

Initiate a job to create an image cutout. Code example .here

Image Mask#​

Initiate a job to create an image mask. Code example .here

Customized Workflow#​

You can make a 'customized workflow' by chaining different APIs. Example of which can be found here

Using Webhooks through Adobe I/O Events ()Pre-Release Feature!!#​

Adobe I/O Events offers the possibility to build an event-driven application, based on events originating from Photoshop and Lightroom APIs. To start listening for events, your application needs to register a webhook URL, specifying the Event Types to receive. Whenever a matching event gets triggered, your application is notified through an HTTP POST request to the webhook URL. The Event Provider for Photoshop and Lightroom APIs is . This event provider has two event types:Imaging API Events

  1. Photoshop API events
  2. Lightroom API events

As the names indicate, these event types represent events triggered by the individual APIs.

Registering your application to our Event Provider#​

Prerequisites needed to use the Event Provider#​

  1. Only supported for a : You will have to create your own JWT Integration, please refer to section of the document for details on how to create a Service Integration.JWT Integrationthis
  2. Make sure that the integration is created under your own Organization Role in and this will ensure that you have a unique . A typical ID would look something like this: and can be found in the overview section of the details of the integration.https://developer.adobe.com/console`Organization ID`ABCDEF123B6CCB7B0A495E2E@AdobeOrg
  3. Create a Webhook application. page gives all the details of what the skeleton of a basic application would look like. You can find a sample NodeJS application Thishere

Registering the Webhook#​

Once the above prerequisites are met, you can now proceed to register the webhook to the service integration. The steps to do that can be found . After the webhook has been successfully registered, you will start to receive the events for any submitted job that either succeeded or failed, from the Event Types selected. This eliminates the need for your application to poll for the status of the job using the jobID. Examples can be found herehere