官方示例

1 替换智能对象内的图片

url： https://image.adobe.io/pie/psdService/smartObject

The /smartObject endpoint can take an input PSD file with an embedded smartobject and can replace with another smartobject. This API is a simple API developed to ease the smartObject replacement workflow for an user.

This example shows how you can replace an embedded smart object. Sample Code

curl -X POST \
https://image.adobe.io/pie/psdService/smartObject \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
"inputs": [
{
  "href": "<SIGNED_GET_URL>",
   "storage": "<storage>"
 }],
 "options": {
   "layers": [{
     "name": "HeroImage",
     "input": {
       "href": "<SIGNED_GET_URL>",
       "storage": "<storage>"
     }
    }
   ]
 },
 "outputs": [
 {
   "storage": "<storage>",
   "href": "<SIGNED_POST_URL>",
   "type": "vnd.adobe.photoshop"
 }
]}'

Example 2: Creating a SmartObject#

This example shows how you can create an embedded smart object using the /smartObject endpoint.

Copy

curl -X POST \
https://image.adobe.io/pie/psdService/smartObject \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
"inputs": [
{
  "href": "<SIGNED_GET_URL>",
   "storage": "<storage>"
 }],
 "options": {
   "layers": [{
     "name": "New",
     "add": {
       "insertTop": true
     },
     "input": {
       "href": "<SIGNED_GET_URL>",
       "storage": "<storage>"
      }
     }
   ]
 },
 "outputs": [
 {
   "storage": "<storage>",
   "href": "<SIGNED_POST_URL>",
   "type": "vnd.adobe.photoshop"
 }
]}'

A call to this API initiates an asynchronous job and returns a response containing an href. Use the value in the href to poll for the status of the job. This is illustrated in Example 12 and Example 14

Example 3: Making a text layer edit#

This example shows how you can edit a text layer using the /text endpoint. Sample Code

Copy

curl -X POST \
https://image.adobe.io/pie/psdService/text \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
"inputs":[
 {
   "href":"<SIGNED_GET_URL>",
    "storage":"<storage>"
  }
],
"options":{
  "layers":[
    {
      "name": "My Text Layer",
      "text": {
          "content": "CHANGED TO NEW TEXT",
          "orientation": "horizontal",
          "characterStyles": [{
              "size": 15,
              "orientation": "horizontal",
              "color": {
                  "red":255,
                  "green":0,
                  "blue":0
              }
          }],
          "paragraphStyles": [{
            "alignment": "right"
          }]
      }
    }
  ]
},

"outputs":[
    {
      "href":"<SIGNED_POST_URL>",
      "storage":"<storage>",
      "type":"vnd.adobe.photoshop"
    }
  ]
}'

Example 4: Custom font in a text layer#

This will change the font in a text layer named My Text Layer to a custom font VeganStylePersonalUse. Note: the value for the fontName field in the text.characterStyles section is the full postscript name of the custom font.

Copy

curl -X POST \
https://image.adobe.io/pie/psdService/text \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
"inputs":[
  {
    "href":"<SIGNED_GET_URL>",
     "storage":"<storage>"
   }
 ],
 "options":{
   "fonts": {
       "storage": "<storage>",
       "href": "<SIGNED_GET_URL_TO_VeganStylePersonalUse.ttf>"
   },
   "layers":[
     {
       "name": "My Text Layer",
       "text": {
           "content": "CHANGED TO NEW TEXT",
           "orientation": "horizontal",
           "characterStyles": [{
               "size": 15,
               "orientation": "horizontal",
               "color": {
                   "red":255,
                   "green":0,
                   "blue":0
               }
           }],
           "paragraphStyles": [{
             "alignment": "right"
           }]
       }
     }
   ]
 },
 "outputs":[
   {
     "href":"<SIGNED_POST_URL>",
     "storage":"<storage>",
     "type":"vnd.adobe.photoshop"
   }
 ]
}'

Example 5: Dictating actions for missing fonts#

In this request for example, if MySampleFont is not found while processing the request, the system default font (ArialMT) will be used as manageMissingFonts is set to useDefault

Copy

1curl -X POST \
https://image.adobe.io/pie/psdService/text \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
"inputs":[
  {
    "href":"<SIGNED_GET_URL>",
    "storage":"<storage>"
  }
],
"options":{
  "manageMissingFonts": "useDefault",
  "globalFont": "MySampleFont",
  "fonts": {
      "storage": "<storage>",
      "href": "<SIGNED_GET_URL_TO_VeganStylePersonalUse.ttf>"
  },
  "layers":[
    {
      "name": "My Text Layer",
      "text": {
          "content": "CHANGED TO NEW TEXT",
          "orientation": "horizontal",
          "characterStyles": [{
              "size": 15,
              "orientation": "horizontal",
              "color": {
                  "red":255,
                  "green":0,
                  "blue":0
              }
          }],
          "paragraphStyles": [{
            "alignment": "right"
          }]
      }
    }
  ]
},
"outputs":[
  {
    "href":"<SIGNED_POST_URL>",
    "storage":"<storage>",
    "type":"vnd.adobe.photoshop"
  }
]
49}'

Example 6: Making a simple edit#

Copy

1curl -X POST \
https://image.adobe.io/pie/psdService/documentOperations \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
"inputs":[
  {
    "href":"<SIGNED_GET_URL>",
    "storage":"<storage>"
  }
],
"options":{
  "layers":[
    {
      "edit":{},     
      "id":750,
      "index":1,
      "locked":true,
      "name":"HeroImage",
      "type":"smartObject",
      "visible":true
    }
  ]
},
"outputs":[
  {
    "href":"<SIGNED_POST_URL>",
    "storage":"<storage>",
    "type":"vnd.adobe.photoshop"
  }
]
33}'

Example 7: Swapping the image in a smart object layer#

In this example we are replacing the smartobject using documentOperations API

Copy

1curl -X POST \
https://image.adobe.io/pie/psdService/documentOperations \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
"inputs":[
  {
    "href":"<SIGNED_GET_URL>",
    "storage":"<storage>"
  }
],
"options":{
  "layers":[
    {
      "edit":{},     
      "input":{                                       
        "href":"<SIGNED_GET_URL>",  
        "storage":"<storage>"
      },
      "smartObject" : {                
        "type" : "image/png"
      },
      "attributes":{
        "bounds":{
          "height":515,
          "left":-385,
          "top":-21,
          "width":929
        }
      },
      "id":750,
      "index":1,
      "locked":false,
      "name":"HeroImage",
      "type":"smartObject",
      "visible":true
    }
  ]
},
"outputs":[
  {
    "href":"<SIGNED_POST_URL>",
    "storage":"<storage>",
    "type":"vnd.adobe.photoshop"
  }
]
48}'

Example 8: Adding a new adjustment layer#

This example shows how you can add a new brightnessContrast adjustment layer to the top of your PSD.

Copy

1curl -X POST \
https://image.adobe.io/pie/psdService/documentOperations \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
"inputs":[
  {
    "href":"<SIGNED_GET_URL>",
    "storage":"<storage>"
  }
],
"options":{
  "layers":[
    {                                        
      "add":{                              
        "insertAbove": {
          "id": 549
        }                    
      },
      "adjustments":{
        "brightnessContrast":{
          "brightness":25,
          "contrast":-40
        }
      },
      "name":"NewBrightnessContrast",
      "type":"adjustmentLayer"              
    }
  ]
},
"outputs":[
  {
    "href":"<SIGNED_POST_URL>",
    "storage":"<storage>",
    "type":"image/jpeg"
  }
]
39}'

Example 9: Editing a pixel layer#

In this example we want to replace the image in an existing pixel layer, the Hero Image layer in Example.psd.

Copy

1curl -X POST \
https://image.adobe.io/pie/psdService/documentOperations \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
"inputs":[
  {
    "href":"<SIGNED_GET_URL>",
    "storage":"<storage>"
  }
],
"options":{
  "layers":[
    {
      "edit":{},                    
      "input":{                                       
        "href":"<SIGNED_GET_URL>",
        "storage":"<storage>"
      },
      "bounds":{
        "height":405,
        "left":0,
        "top":237,
        "width":300
      },
      "id":751,
      "index":2,
      "locked":false,
      "name":"BackgroundGradient",
      "type":"layer",
      "visible":true
    }
  ]
},
"outputs":[
  {
    "href":"<SIGNED_POST_URL>",
    "storage":"<storage>",
    "type":"vnd.adobe.photoshop"
  }
]
43}
44'

Example 10: Create a document rendition#

Generate multiple output rendition with the Simple API renditionCreate

Copy

1curl -X POST \
https://image.adobe.io/pie/psdService/renditionCreate \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
"inputs":[
  {
    "href":"<SIGNED_GET_URL>",
    "storage":"<storage>"
  }
],
"outputs":[
  {
    "href":"<SIGNED_POST_URL1>",          
    "width": 512,
    "storage":"<storage>",
    "type":"image/jpeg"      
  },
  {
    "href":"<SIGNED_POST_URL2>",
    "storage":"<storage>",
    "type":"image/png"
  }
]
26}'

Example 11: Retrieve a PSD's JSON manifest#

The /documentManifest api can take one input PSD's to generate a JSON manifest file. The JSON manifest is the tree representation of all of the layer objects contained in the PSD document.

Using Example.psd, with the use case of a document stored in your external storage (ie. azure, aws, dropbox), a typical curl call might look like this:

Copy

1curl -X POST \
https://image.adobe.io/pie/psdService/documentManifest \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
"inputs": [
  {
    "href":"<YOUR_PRESIGNED_URL>",
    "storage":"<storage>"
  }
]
13}'

A call to this API initiates an asynchronous job and returns a response containing an href. Use the value in the href to poll for the status of the job and the same response will also contain the JSON manifest. This is illustrated in Example 12 and Example 14

Example 12: Fetch the status of an API#

Each of our Photoshop APIs, when invoked, initiates an asynchronous job and returns a response body that contains the href to poll for status of the job.

Copy

1{
  "_links": {
      "self": {
          "href": "https://image.adobe.io/pie/psdService/status/de2415fb-82c6-47fc-b102-04ad651c5ed4"
      }
  }
7}

Using the job id returned from the response (ass above) of a successfully submitted API call, you can poll on the corresponding value in the href field, to get the status of the job.

Copy

1curl -X GET \
https://image.adobe.io/pie/psdService/status/de2415fb-82c6-47fc-b102-04ad651c5ed4 \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json"

Example 13: Poll for job status for documentManifest#

Once your job completes successfully (no errors/failures reported), the status response will contain your document's JSON manifest along with other metadata about the input document. The JSON Manifest is further described in the api docs

Copy

1{
"jobId":"63c6e812-6cb8-43de-8a60-3681a9ec6feb",
"outputs":[
  {
    "input":"<SIGNED_GET_URL>",
    "status":"succeeded",
    "created":"2018-08-24T23:07:36.8Z",
    "modified":"2018-08-24T23:07:37.688Z",
    "layers":[
      {
        "bounds":{
          "height":64,
          "left":12,
          "top":1,
          "width":39
        },
        "id":549,
        "index":8,
        "locked":false,
        "name":"CompanyLogo",
        "type":"smartObject",
        "visible":true
      },
      {
        "bounds":{
          "height":153,
          "left":31,
          "top":334,
          "width":197
        },
        "children":[
          {
            "bounds":{
              "height":136,
              "left":29,
              "top":326,
              "width":252
            },
            "text": {
              "content":"Reset your customers’ expectations.",
              "paragraphStyles":[
                {   
                  "alignment":"left"
                }
              ],
              "characterStyles":[{
                "fontAvailable":true,
                "fontName":"AdobeClean-Bold",
                "fontSize":36,
                "orientation":"horizontal"
              }]               
            },
            "id":412,
            "index":6,
            "locked":false,
            "name":"Reset your customers’ expectations.",
            "type":"textLayer",
            "visible":true
          },
          {
            "bounds":{
              "height":67,
              "left":30,
              "top":452,
              "width":230
            },
            "text":{
              "content":"Get our retail experience article and infographic.",
              "paragraphStyles":[{
                "alignment":"left"
              }],
              "characterStyles":[{
                "fontAvailable":true,
                "fontName":"AdobeClean-Regular",
                "fontSize":15,
                "orientation":"horizontal"
              }]
            },
            "id":676,
            "index":5,
            "locked":false,
            "name":"Get our retail experience article and infographic.",
            "type":"textLayer",
            "visible":true
          }
        ],
        "id":453,
        "index":7,
        "locked":false,
        "name":"Headline",
        "type":"layerSection",
        "visible":true
      },
      {
        "bounds":{
          "height":34,
          "left":31,
          "top":508,
          "width":99
        },
        "id":762,
        "index":3,
        "locked":false,
        "name":"CallToAction",
        "type":"smartObject",
        "visible":true
      },
      {
        "bounds":{
          "height":405,
          "left":0,
          "top":237,
          "width":300
        },
        "id":751,
        "index":2,
        "locked":false,
        "name":"BackgroundGradient",
        "type":"layer",
        "visible":true
      },
      {
        "bounds":{
          "height":515,
          "left":-385,
          "top":-21,
          "width":929
        },
        "id":750,
        "index":1,
        "locked":false,
        "name":"HeroImage",
        "type":"smartObject",
        "visible":true
      },
      {
        "bounds":{
          "height":600,
          "left":0,
          "top":0,
          "width":300
        },
        "id":557,
        "index":0,
        "locked":false,
        "name":"Background",
        "type":"layer",
        "visible":true
      }
    ],
    "document":{
      "height":600,
      "name":"Example.psd",
      "width":300
    }
  }
],
"_links":{
  "self":{
    "href":"https://image.adobe.io/pie/psdService/status/8ec6e4f5-b580-41ac-b693-a72f150fec59"
  }
}
163}

Example 14: Poll for job status for all Other APIs#

Once your job completes successfully (no errors/failures reported), this will return a response body containing the job status for each requested output. For the /renditionCreate API call in Example 10 as illustrated above, a sample response containing the job status is as shown below:

Copy

1{
"jobId":"de2415fb-82c6-47fc-b102-04ad651c5ed4",
"outputs":[
  {
    "input":"<SIGNED_GET_URL>",
    "status":"succeeded",
    "created":"2018-01-04T12:57:15.12345:Z",
    "modified":"2018-01-04T12:58:36.12345:Z",
    "_links":{
      "renditions":[
        {
          "href":"<SIGNED_GET_URL>",          
          "width": 512,
          "storage":"<storage>",
          "type":"image/jpeg"    
        },
        {
          "href":"<SIGNED_GET_URL>",
          "storage":"<storage>",
          "type":"image/png"
        }
      ]
    }
  }
],
"_links":{
  "self":{
    "href":"https://image.adobe.io/pie/psdService/status/de2415fb-82c6-47fc-b102-04ad651c5ed4"
  }
}
31}

Example 15 : Photoshop Actions - Play ALL actions in .atn file.#

Copy

1curl -X POST \
https://image.adobe.io/pie/psdService/photoshopActions \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
"inputs": [
  {
    "href": "https://as2.ftcdn.net/jpg/02/49/48/49/500_F_249484911_JifPIzjUqzkRhcdMkF9GnsUI9zaqdAsn.jpg",
    "storage": "external"
  }
],
"options": {
  "actions": [
    {
      "href": "https://raw.githubusercontent.com/johnleetran/ps-actions-samples/master/actions/Oil-paint.atn",
      "storage": "external"
    }
  ]
},
"outputs": [
  {
    "storage": "<storage>",
    "type": "image/jpeg",
    "href": "https://some-presigned-url/output.jpeg"
  }
]
28}'

Example 16 : Photoshop Actions Play a specific action#

By default, Photoshop API will attempt to play all actions in an action set. If you would like to only playback a specific action, you can specify actionName and the name of the action you want to invoke (see example below).

Copy

1curl -X POST \
https://image.adobe.io/pie/psdService/photoshopActions \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
"inputs": [
  {
    "href": "https://as2.ftcdn.net/jpg/02/49/48/49/500_F_249484911_JifPIzjUqzkRhcdMkF9GnsUI9zaqdAsn.jpg",
    "storage": "external"
  }
],
"options": {
  "actions": [
    {
      "href": "https://raw.githubusercontent.com/johnleetran/ps-actions-samples/master/actions/Oil-paint.atn",
      "storage": "external",
      "actionName": "Action 51"
    }
  ]
},
"outputs": [
  {
    "storage": "<storage>",
    "type": "image/jpeg",
    "href": "https://some-presigned-url/output.jpeg"
  }
]
29}'

Example 17: Edit Text Layers#

The /text endpoint can take an input PSD file with one or more text layers and can apply edits to it.

This example shows how you can apply edits to two text layers

Copy

1curl -X POST \
https://image.adobe.io/pie/psdService/text \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
"inputs": [
  {
    "href": "<SIGNED_GET_URL>",
    "storage": "<storage>"
  }
],
"options": {
  "fonts": [{
    "storage": "<storage>",
    "href": "<SIGNED_GET_URL>"
  }],
  "layers": [
    {
      "name": "<name_of_text_layer_1_to_edit>",
      "text": {
          "orientation": "horizontal",
          "contents": "New text Contents 1",
          "antiAlias": "antiAliasSharp",
          "characterStyles": [{
            "autoKern": "metricsKern",
            "fontPostScriptName": "<font_postscript_name>",
            "fontCaps": "allCaps",
            "size": 25,
            "leading": 20,
            "tracking": 20,
            "syntheticBold": true,
            "ligature": true,
            "syntheticItalic": true,
            "color": {
              "blue": 100,
              "green": 200,
              "red": 163
            }
          }],
          "paragraphStyles": [{
            "align": "right"
          }]
      }
    },
    {
      "name": "<name_of_text_layer_2_to_edit>",
      "text": {
        "contents": "New text Contents 2",
        "characterStyles": [{
            "size": 45,
            "stylisticAlternates": true,
            "leading": 100,
            "tracking": 100,
            "baseline": "subScript",
            "strikethrough": true,
            "underline": true,
            "verticalScale": 150,
            "horizontalScale": 200,
            "color": {
              "blue": 300,
              "green": 100,
              "red": 63
            }
          }]
      }
    }
  ]
},
"outputs": [
  {
    "href": "<SIGNED_POST_URL>",
    "type": "vnd.adobe.photoshop",
    "storage": "<storage>"
  }
]
77}'

Example 18 : Applying Product Crop#

The productCrop endpoint can take an input file and apply right crop to it. We don't support multilayered PSD.

This example shows how you can apply the crop with required padding to an input file

Copy

1curl -X POST \
https://image.adobe.io/pie/psdService/productCrop \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
"inputs": [
  {
    "href": "<SIGNED_GET_URL>",
    "storage": "<storage>"
  }
],
"options": {
  {
    "unit": "Pixels",
    "width": 10,
    "height": 10
  }
},
"outputs": [
  {
    "storage": "<storage>",
    "type": "image/jpeg",
    "href": "<SIGNED_POST_URL>"
  }
]
27}'

Example 19 : Applying Depth Blur Neural Filter#

The depthBlur endpoint can take an input file and apply the depth blur neural filter.

This example shows how you can apply depth blur with the appropriate parameters.

Copy

1curl -X POST \
https://image.adobe.io/pie/psdService/depthBlur \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
"inputs": [
  {
    "href": "<SIGNED_GET_URL>",
    "storage": "<storage>"
  }
],
"options": {
  "haze": 25,
  "blurStrength": 30,
  "focalSelector": {
      "x": 0.22,
      "y": 0.33
  }
},
"outputs": [
  {
    "storage": "<storage>",
    "type": "image/jpeg",
    "href": "<SIGNED_POST_URL>"
  }
]
28}'

Lightroom#

Example 1: Autotone an image#

Copy

1curl -X POST \
https://image.adobe.io/lrService/autoTone \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
  "inputs": {
      "href": "<SIGNED_GET_URL>",
      "storage": "<storage>"
  },
  "outputs": [
      {
          "href": "<SIGNED_POST_URL>",
          "type": "<type>",
          "storage": "<storage>"
      }
  ]
18}'

This initiates an asynchronous job and returns a request body containing the href to poll for job status.

Copy

1{
  "_links": {
      "self": {
          "href": "https://image.adobe.io/lrService/status/<:jobId>"
      }
  }
7}

To check the status of the job completion, use the /status API. An example usage of the API can be found here.

Example 2: Autostraighten an image#

Copy

1curl -X POST \
https://image.adobe.io/lrService/autoStraighten \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
  "inputs": {
      "href": "<SIGNED_GET_URL>",
      "storage": "<storage>"
  },
  "outputs": [
      {
          "href": "<SIGNED_POST_URL>",
          "type": "<type>",
          "storage": "<storage>"
      }
  ]
18}'

This initiates an asynchronous job and returns a request body containing the href to poll for job status.

Copy

1{
  "_links": {
      "self": {
          "href": "https://image.adobe.io/lrService/status/<:jobId>"
      }
  }
7}

To check the status of the job completion, use the /status API. An example usage of the API can be found here.

Example 3 : Apply presets to an image#

Copy

1curl -X POST \
https://image.adobe.io/lrService/presets \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
  "inputs": {
      "source": {
          "href": "<SIGNED_GET_URL>",
          "storage": "<storage>"
      },
      "presets": [
          {
              "href": "<SIGNED_GET_URL>",
              "storage": "<storage>"
          },
          {
              "href": "<SIGNED_GET_URL>",
              "storage": "<storage>"
          }
      ]
  },
  "outputs": [
      {
          "href": "<SIGNED_POST_URL>",
          "type": "<type>",
          "storage": "<storage>"
      }
  ]
30}'

This initiates an asynchronous job and returns a request body containing the href to poll for job status.

Copy

1{
  "_links": {
      "self": {
          "href": "https://image.adobe.io/lrService/status/<:jobId>"
      }
  }
7}

To check the status of the job completion, use the /status API. An example usage of the API can be found here.

Example 4: Apply edits to an image#

Copy

1curl -X POST \
https://image.adobe.io/lrService/edit \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
  "inputs": {
      "source": {
          "href": "<SIGNED_GET_URL>",
          "storage": "<storage>"
      }
  },
  "options": {
      "Exposure": -5.00 to 5.00,
      "Contrast": -100 to 100,
      "Sharpness": 0 10 150,
      "WhiteBalance": <"As Shot", "Auto", "Cloudy", "Custom", "Daylight", "Flash", "Fluorescent", "Shade", "Tungsten">
      "Saturation": -100 to 100,
      "ColorNoiseReduction": 0 to 100,
      "NoiseReduction": 0 to 100,
      "VignetteAmount": -100 to 100,
      "Vibrance": -100 to 100,
      "Highlights": -100 to 100,
      "Shadows": -100 to 100,
      "Whites": -100 to 100,
      "Blacks": -100 to 100,
      "Clarity": -100 to 100,
      "Dehaze": -100 to +100,
      "SharpenRadius": 0.5 to 3.0,
      "SharpenDetail": 0 to 100,
      "SharpenEdgeMasking": 0 to 100,
      "Texture": -100 t0 100
  },
  "outputs": [
      {
          "href": "<SIGNED_POST_URL>",
          "type": "<type>",
          "storage": "<storage>"
      }
  ]
41}'

This initiates an asynchronous job and returns a request body containing the href to poll for job status.

Copy

1{
  "_links": {
      "self": {
          "href": "https://image.adobe.io/lrService/status/<:jobId>"
      }
  }
7}

To check the status of the job completion, use the /status API. An example usage of the API can be found here.

Example 5: Apply xmp to an image#

Copy

1curl -X POST \
https://image.adobe.io/lrService/xmp \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
  "inputs": {
      "href": "<SIGNED_GET_URL>",
      "storage": "<storage>"
  },
  "options": {
      "xmp": "<xmp>",
      "orientation": "<orientation>"
  },
  "outputs": [
      {
          "href": "<SIGNED_POST_URL>",
          "storage": "<storage>",
          "type": "<type>"
      }
  ]
22}'

This initiates an asynchronous job and returns a request body containing the href to poll for job status.

Copy

1{
  "_links": {
      "self": {
          "href": "https://image.adobe.io/lrService/status/<:jobId>"
      }
  }
7}

To check the status of the job completion, use the /status API. An example usage of the API can be found here.

Example 6: Poll for status and results#

Use the JobID to poll on the href that is returned in the response from one of the Lightroom APIs.

Upon successful job completion, the output file will be available at the specified output href.
If the job failed due to an error, the errorDetails field in the response will contain the details of the failure.

Copy

1curl -X GET \
https://image.adobe.io/lrService/status/<jobId> \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \

And this will return a request body containing the job status for each requested output and eventually either errors or the hrefs to the requested outputs

Copy

1{
"jobId":"<jobId>",
"created":"2018-01-04T12:57:15.12345:Z",
"modified":"2018-01-04T12:58:36.12345:Z",
"outputs":[
{
    "input":"<input_file_href>",
    "status":"succeeded",
    "_links":{
      "self":
      {
        "href":"<output_file_href>",
        "storage":"<storage>"
      }
    }
  }
],
"_links":{
  "self":{
    "href":"https://image.adobe.io/lrService/status/<jobId>"
  }
}
23}

Sensei#

First be sure to follow the instructions in the Authentication section to get your token.

Example 1: Generate image cutout#

The /cutout api takes a single input image to generate your mask or cutout from. Using Example.jpg, a typical curl call might look like this:

Copy

1curl -X POST \
https://image.adobe.io/sensei/cutout \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-d '{
 "input":{
    "storage":"<storage>",
    "href":"<SIGNED_GET_URL>"
 },
 "output":{
    "storage":"<storage>",
    "href":"<SIGNED_POST_URL>",
    "mask":{
       "format":"soft"
    }
 }
18}'

This initiates an asynchronous job and returns a response containing the href to poll for job status and the JSON manifest.

Copy

1{
  "_links": {
      "self": {
          "href": "https://image.adobe.io/sensei/status/e3a13d81-a462-4b71-9964-28b2ef34aca7"
      }
  }
7}

Using the job id returned from the previous call you can poll on the returned /status href to get the job status

Copy

1curl -X GET \
https://image.adobe.io/sensei/status/e3a13d81-a462-4b71-9964-28b2ef34aca7 \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json"

Once the job is complete your successful /status response will look similar to the response below; The output will have been placed in your requested location. In the event of failure the errors will be shown instead

Copy

1{
  "jobID": "e3a13d81-a462-4b71-9964-28b2ef34aca7",
  "status": "succeeded",
  "created": "2020-02-11T21:08:43.789Z",
  "modified": "2020-02-11T21:08:48.492Z",
  "input": "<SIGNED_GET_URL>",
  "_links": {
      "self": {
          "href": "https://image.adobe.io/sensei/status/e3a13d81-a462-4b71-9964-28b2ef34aca7"
      }
  },
  "output": {
      "storage": "<storage>",
      "href": "<SIGNED_POST_URL>",
      "mask": {
          "format": "soft"
      }
  }
19}

Example 2: Generate image mask#

The workflow is exactly the same as creating an image cutout except you use the /mask endpoint instead of /cutout.

Customized Workflow#

Example 1: Generate cutout result as Photoshop path#

This workflow is ONLY for users who'd like to generate cutout result as Photoshop path instead of regular mask or cutout in above example 1 and example 2. You will need to chain API calls to ImageCutOut service and Photoshop Service to achieve this goal.

Sample Input/Output#

Sample input from here. Sample output from here (Note: you will need to open result in Photoshop Desktop application so that you will see the path in path panel)

Instructions#

Download the make-file.atn file from here (this file will be used in the Photoshop action API call)
Make the first API call to ImageCutOut service to generate intermediate result as RGBA cutout
Make the second API call to Photoshop action service to use above intermediate result as well as the make-file.atn file to generate final JPEG format result with desired PS path embedded
Open the final result with Photoshop Desktop app to check generated path in path panel

Sample Code#

You can download the sample end-to-end bash script here and then follow the comments to try it out this customized workflow.

Triggering an Event from the API's#

In order to start receiving the events in your Webhook Application, the additional thing that needs to be done is to pass in your IMS ORG ID in a header: x-gw-ims-org-id: <YOUR_IMS_ORG_ID>, when you make an API call to initiate a job. Please have a look at the examples below that demonstrates the usage of the new header and a sample event received for that job.

Example 1: Retrieving a PSD manifest from the Photoshop API#

Step 1: Initiate a job to retrieve a PSD's JSON manifest#

The /documentManifest api can take one or more input PSD's to generate JSON manifest files from. The JSON manifest is the tree representation of all of the layer objects contained in the PSD document. Using Example.psd, with the use case of a document stored in your external storage, a typical curl call might look like this:

Copy

1curl -X POST \
https://image.adobe.io/pie/psdService/documentManifest \
-H "Authorization: Bearer $token"  \
-H "x-api-key: $apiKey" \
-H "Content-Type: application/json" \
-H 'x-gw-ims-org-id: <YOUR_IMS_ORG_ID>' \
-d '{
"inputs": [
  {
    "href":"<SIGNED_GET_URL>",
    "storage":"<storage>"
  }
]
14}'

This initiates an asynchronous job and returns a response containing the href to poll for job status and the JSON manifest.

Copy

1{
  "_links": {
      "self": {
          "href": "https://image.adobe.io/pie/psdService/status/63c6e812-6cb8-43de-8a60-3681a9ec6feb"
      }
  }
7}

Step 2: Receive the Job's status on the Webhook application when the job is complete#

The value in the key body inside the event JSON contains the result of the job. Here is a sample event received from the job initiated above:

Copy

1{
"event_id": "b412a90e-8bc0-4f0d-931e-9e9b8d24993d",
"event": {
  "header": {
    "msgType": "JOB_COMPLETION_STATUS",
    "msgId": "8afa1a46-2733-406c-a646-e1c1acdee333",
    "imsOrgId": "<YOUR_IMS_ORG_ID>",
    "eventCode": "photoshop-job-status",
    "_pipelineMeta": {
      "pipelineMessageId": "1586288145511:631472:VA7_A1:142:0"
    },
    "_smarts": {
      "definitionId": "3ee6c9056a9d72fc40e09ddf5fdbb0af752e8e49",
      "runningSmartId": "psmart-yw6wosjksniuuathenny"
    },
    "_adobeio": {
      "imsOrgId": "<YOUR_IMS_ORG_ID>",
      "providerMetadata": "di_event_code",
      "eventCode": "photoshop-job-status"
    }
  },
  "body": {
    "jobId": "63c6e812-6cb8-43de-8a60-3681a9ec6feb",
    "outputs": [
      {
        "status": "succeeded",
        "layers": [
          {
            "id": 2,
            "index": 0,
            "type": "layer",
            "name": "Layer",
            "locked": false,
            "visible": true,
            "bounds": {
              "top": 0,
              "left": 0,
              "width": 100,
              "height": 100
            },
            "blendOptions": {
              "opacity": 100,
              "mode": "normal"
            }
          }
        ],
        "document": {
          "name": "test.psd",
          "width": 1000,
          "height": 1000,
          "bitDepth": 8,
          "imageMode": "rgb",
          "photoshopBuild": "Adobe Creative Imaging Service"
        }
      }
    ],
    "_links":{
      "self":{
        "href":"https://image.adobe.io/pie/psdService/status/8ec6e4f5-b580-41ac-b693-a72f150fec59"
      }
    }
  }
}
64}

Example 2: Auto tone an image through the Lightroom API#

Step 1: Initiate a job to auto tone an image#

Copy

1curl -X POST \
https://image.adobe.io/lrService/autoTone \
-H "Authorization: Bearer $token" \
-H "Content-Type: application/json" \
-H "x-api-key: <YOUR_API_KEY>" \
-H 'x-gw-ims-org-id: <YOUR_IMS_ORG_ID>' \
-d '{
  "inputs": {
    "href": "<SIGNED_GET_URL>",
    "storage": "<storage>"
  },
  "outputs": [
  {
    "href": "<SIGNED_POST_URL>",
    "type": "<type>",
    "storage": "<storage>"
  }
]
19}'

This initiates an asynchronous job and returns a request body containing the href to poll for job status.

Copy

1{
  "_links": {
      "self": {
          "href": "https://image.adobe.io/lrService/status/eb4a9211-eb8a-4e88-b853-b9c08ba47427"
      }
  }
7}

Step 2: Receive the Job's status on the Webhook application when the job is complete#

The value in the key body inside the event JSON contains the result of the job. Here is a sample event received from the job initiated above:

Copy

1{
"event_id": "7b59cc70-88d7-4895-b204-87f5350a0cce",
"event": {
  "header": {
    "msgType": "JOB_COMPLETION_STATUS",
    "msgId": "eb4a9211-eb8a-4e88-b853-b9c08ba47427",
    "imsOrgId": "<YOUR_IMS_ORG_ID>",
    "eventCode": "lightroom-job-status",
    "_pipelineMeta": {
      "pipelineMessageId": "1586290300876:944289:VA7_A1:149:0"
    },
    "_smarts": {
      "definitionId": "3ee6c9056a9d72fc40e09ddf5fdbb0af752e8e49",
      "runningSmartId": "psmart-yw6wosjksniuuathenny"
    },
    "_adobeio": {
      "imsOrgId": "<YOUR_IMS_ORG_ID>",
      "providerMetadata": "di_event_code",
      "eventCode": "lightroom-job-status"
    }
  },
  "body": {
    "jobId": "eb4a9211-eb8a-4e88-b853-b9c08ba47427",
    "outputs": [
      {
        "input": "<SIGNED_GET_URL>",
        "status": "succeeded",
        "_links": {
          "self": [
            {
              "href": "<SIGNED_POST_URL>",
              "storage": "<storage>"
            }
          ]
        }
      }
    ],
    "_links": {
      "self": {
        "href": "https://image.adobe.io/lrService/status/eb4a9211-eb8a-4e88-b853-b9c08ba47427"
      }
    }
  }
}
45}

1 替换智能对象内的图片​

Example 2: Creating a SmartObject#​

Example 3: Making a text layer edit#​

Example 4: Custom font in a text layer#​

Example 5: Dictating actions for missing fonts#​

Example 6: Making a simple edit#​

Example 7: Swapping the image in a smart object layer#​

Example 8: Adding a new adjustment layer#​

Example 9: Editing a pixel layer#​

Example 10: Create a document rendition#​

Example 11: Retrieve a PSD's JSON manifest#​

Example 12: Fetch the status of an API#​

Example 13: Poll for job status for documentManifest#​

Example 14: Poll for job status for all Other APIs#​

Example 15 : Photoshop Actions - Play ALL actions in .atn file.#​

Example 16 : Photoshop Actions Play a specific action#​

Example 17: Edit Text Layers#​

Example 18 : Applying Product Crop#​

Example 19 : Applying Depth Blur Neural Filter#​

Lightroom#​

Example 1: Autotone an image#​

Example 2: Autostraighten an image#​

Example 3 : Apply presets to an image#​

Example 4: Apply edits to an image#​

Example 5: Apply xmp to an image#​

Example 6: Poll for status and results#​

Sensei#​

Example 1: Generate image cutout#​

Example 2: Generate image mask#​

Customized Workflow#​

Example 1: Generate cutout result as Photoshop path#​

Sample Input/Output#​

Instructions#​

Sample Code#​

Triggering an Event from the API's#​

Example 1: Retrieving a PSD manifest from the Photoshop API#​

Step 1: Initiate a job to retrieve a PSD's JSON manifest#​

Step 2: Receive the Job's status on the Webhook application when the job is complete#​

Example 2: Auto tone an image through the Lightroom API#​

Step 1: Initiate a job to auto tone an image#​

Step 2: Receive the Job's status on the Webhook application when the job is complete#​

1 替换智能对象内的图片

Example 2: Creating a SmartObject#

Example 3: Making a text layer edit#

Example 4: Custom font in a text layer#

Example 5: Dictating actions for missing fonts#

Example 6: Making a simple edit#

Example 7: Swapping the image in a smart object layer#

Example 8: Adding a new adjustment layer#

Example 9: Editing a pixel layer#

Example 10: Create a document rendition#

Example 11: Retrieve a PSD's JSON manifest#

Example 12: Fetch the status of an API#

Example 13: Poll for job status for documentManifest#

Example 14: Poll for job status for all Other APIs#

Example 15 : Photoshop Actions - Play ALL actions in .atn file.#

Example 16 : Photoshop Actions Play a specific action#

Example 17: Edit Text Layers#

Example 18 : Applying Product Crop#

Example 19 : Applying Depth Blur Neural Filter#

Lightroom#

Example 1: Autotone an image#

Example 2: Autostraighten an image#

Example 3 : Apply presets to an image#

Example 4: Apply edits to an image#

Example 5: Apply xmp to an image#

Example 6: Poll for status and results#

Sensei#

Example 1: Generate image cutout#

Example 2: Generate image mask#

Customized Workflow#

Example 1: Generate cutout result as Photoshop path#

Sample Input/Output#

Instructions#

Sample Code#

Triggering an Event from the API's#

Example 1: Retrieving a PSD manifest from the Photoshop API#

Step 1: Initiate a job to retrieve a PSD's JSON manifest#

Step 2: Receive the Job's status on the Webhook application when the job is complete#

Example 2: Auto tone an image through the Lightroom API#

Step 1: Initiate a job to auto tone an image#

Step 2: Receive the Job's status on the Webhook application when the job is complete#