1.0.0 • Published 1 month ago
@adobe/photoshop-apis v1.0.0
@adobe/photoshop-apis
Description
This repository is home to the Firefly Services SDK for JavaScript, designed for Node.js and web environments. It features libraries for various Firefly services, including product libraries for accessing specific product services like Firefly, Lightroom, and Photoshop, and a common library for shared functionalities.
@adobe/photoshop-apis specifically is the Firefly package for accessing the Photoshop product services.
You can refer to Firefly Services Homepage for getting started guides, details about adding these packages to your project and code samples.
Table below shows details on various API service endpoints and the corresponding SDK APIs
SDK to API Reference Mapping
| Photoshop API Endpoint | SDK API Name | Description |
|---|---|---|
| /pie/psdService/photoshopActions | playPhotoshopActions | Executes Photoshop Action file against a PSD, JPEG, PNG, or TIFF. |
| /pie/psdService/actionJSON | playPhotoshopActionsJson | Execute a Photoshop Action with actionJSON format. |
| /sensei/cutout | removeBackground | Isolate subject of interested in an image and remove background. |
| /pie/psdService/documentCreate | createDocument | Create new PSD with layers. |
| /sensei/mask | createMask | Isolate a subject of interest in an image (people, objects, etc) and generate an image mask. |
| /pie/psdService/renditionCreate | createRendition | Create flat image representations of a PSD in multiple formats. |
| /pie/psdService/documentManifest | getDocumentManifest | Extract metadata from PSD document, including general file and layer information. |
| /pie/psdService/documentOperations | modifyDocument | Apply basic layer edits (name, state, etc), add/edit adjustment, pixel, and shape layers. |
| /pie/psdService/smartObject | replaceSmartObject | Replace Smart Object in a PSD. |
| /pie/psdService/actionJsonCreate | convertToActionsJson | Convert .atn file to an actionJSON format. |
| /pie/psdService/artboardCreate | createArtboard | Create artboards from multiple PSD inputs. |
| /pie/psdService/depthBlur | applyDepthBlur | Apply depth blur to an image input. |
| /pie/psdService/productCrop | applyAutoCrop | Smart crop an image keeping the subject of interest in view. |
| /pie/psdService/text | editTextLayer | Change the contents of a text layer in a PSD, eg for localization. |