- Prerelease Program
- Welcome to Lightroom-ACR API's!
- Setup
- General Workflow
- Supported Features
- How to use the APIs
- Current Limitations
- Release Notes
The Lightroom-ACR APIs are made available through the Adobe Prelease program. These APIs are included as part of the Photoshop as a Service pre-release program. For the ability to make these API calls, we invite you to join the program.
Please be aware of some aspects of the program. For example, you will need to agree to the Adobe Prelease agreement and NDA. The APIs are provided for evaluation purposes. The current APIs are subject to change. You can find more information on the Adobe Prerelease page.
If you are not currently a member, please sign up at https://photoshop.adobelanding.com/prerelease-stack/
The Adobe Lightroom-ACR APIs allow you to make Lightroom like automated edits to JPG image files. This page is meant to help you onboard with the service and get you started with some basic usage examples. This is service does not support the storage that Lightroom users have access to, instead, it allows users to use any other form of storage to work on their images. The list of supported storage systems are listed further below in this documentation.
You must pass in an OAuth 2.0 access token with every request. The APIs do not provide any API methods for authentication or authorization. Access tokens are granted by Adobe's IMS service. The APIs need an access token with the scope="openid,creative_sdk", which you pass to the IMS Login Authorization API.
The access token must never be transmitted as a URI parameter. Doing so would expose it to being captured in-the-clear by intermediaries such as proxy server logs. The API does not allow you to send an access token anywhere except the Authorization header field.
There are two scenarios that require different authentication methods:
You will be emailed your Client ID and Client Secret required for the IMS endpoint after you've been accepted to the PreRelease program. Once you've received your email...
-
Do a quick test:
-
Add your Client ID and Client Secret sent in email
-
Enter your Adobe credentials when prompted
-
Use the access token to try the example calls further down this README
Additional instructions regarding the Adobe IMS endpoints can be found at Generating Access Tokens
Additional instructions can be found at Setting up OAuth authentication
Complete examples for OAuth endpoints can be found at OAuth endpoint examples
For service-to-service clients you'll need to set up an Adobe I/O Console Integration and create a JSON Web Token (JWT) to retrieve your access token for API's. It is assumed your organization already has an Adobe IMS Org ID and you have added the required users to it.
The Adobe Lightroom-ACR APIs currently have a limitation that Service clients must store their assets externally to Adobe's Creative Cloud.
This applies to assets stored outside of Adobe's Creative Cloud and accessed via preSigned URL's
-
Browse to https://console.adobe.io/integrations
-
Select New Integration
-
Select
Access an API -
Select
Lightroom -
Select
Service Account integration -
Select
Create new integration
To retrieve your access token see additional instructions at Setting up JWT Authentication
Also known as the client_id. You must pass in your Adobe API key in the x-api-key header field.
-
You should only retry requests that have a 5xx response code. A 5xx error response indicates there was a problem processing the request on the server.
-
You should implement an exponential back-off retry strategy with 3 retry attempts.
-
You should not retry requests for any other response code.
We have not put a throttle limit on requests to the API at this time.
The typical workflow involves specifying an image and the operation to be applied to it. The endpoint is asynchronous so the response will contain the /status endpoint to poll for job status and results
For the time being clients can only use assets stored on EITHER Adobe's Creative Cloud OR external storage (like AWS S3 or Azure Blog Storage). Support for mixing and matching storage types will be added in the future.
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: https://helpx.adobe.com/lightroom-classic/help/supported-file-formats.html
This is a list of currently supported features
- Automatically tone an image to correct exposure/contrast/sharpness/etc
- Apply one or more XMP Lightroom presets to an image.
- Apply one or more Lightroom edits to an image.
curl -X POST \
-H "authorization: Bearer $token" \
-H "Content-Type:application/json" \
-H "x-api-key:$x-api-key" \
-d '{
"inputs": {
"href": "<href>",
"storage": "<storage>"
},
"outputs": [
{
"href": "<href>",
"type": "<type>",
"storage": "<storage>",
"overwrite": <boolean>
}
]
}'
https://image.adobe.io/lrService/autoTone
This initiates an asynchronous job and returns a request body containing the href to poll for job status.
{
"_links": {
"self": {
"href": "https://image.adobe.io/lrService/status/<:jobId>"
}
}
}curl -X POST \
-H "authorization: Bearer $token" \
-H "Content-Type:application/json" \
-H "x-api-key:$x-api-key" \
-d '{
"inputs": {
"source": {
"href": "<href>",
"storage": "<storage>"
},
"presets": [
{
"href": "<href1>",
"storage": "<storage>"
},
{
"href": "<href2>",
"storage": "<storage>"
}
]
},
"outputs": [
{
"href": "<href>",
"type": "<type>",
"storage": "<storage>",
"overwrite": <boolean>
}
]
}'
https://image.adobe.io/lrService/presets
This initiates an asynchronous job and returns a request body containing the href to poll for job status.
{
"_links": {
"self": {
"href": "https://image.adobe.io/lrService/status/<:jobId>"
}
}
}curl -X POST \
-H "authorization: Bearer $token" \
-H "Content-Type:application/json" \
-H "x-api-key:$x-api-key" \
-d '{
"inputs": {
"source": {
"href": "<href>",
"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": "<href>",
"type": "<type>",
"storage": "<storage>",
"overwrite": <boolean>
}
]
}'
https://image.adobe.io/lrService/edit
This initiates an asynchronous job and returns a request body containing the href to poll for job status.
{
"_links": {
"self": {
"href": "https://image.adobe.io/lrService/status/<:jobId>"
}
}
}