Migration to v2 Overview

This overview helps you understand the general changes and how to prepare for the migration from the legacy v1 Photoshop and Lightroom APIs to the new unified v2 API.

What's different?

The Photoshop and Lightroom API v2 represents a significant improvement over v1.

For all the details about the new architecture and powerful new service improvements, see the Key Improvements and Architecture with v2 page.

Unified architecture

Improved capabilities

Better performance

What are the breaking changes?

The v2 API introduces some breaking changes:

Base URL change

Request payload structure changes

Output format changes

Response format modifications

Different output configuration options - New destination object structure, with an optional storageType.

Deprecated fields

Review the detailed migration guides for each endpoint type to understand the specific impacts to your integration and how to migrate.

What about authentication?

Authentication remains unchanged. Continue using your existing OAuth Server-to-Server credentials with the new v2 endpoints. See the Authentication Guide for more information.

How should I begin migrating?

  1. Read the Kye Improvements and Architecture with v2 to understand the architectural changes

  2. Review storage options in the enhanced storage solutions guide

  3. Choose your migration path based on the endpoints you currently use (see the reference table below):

  4. Test your migration with non-production workloads

  5. Update your production systems once testing is complete

Service migration reference

Use this table to quickly find the v2 equivalent for your v1 endpoints:

V1 Endpoint
V2 Endpoint
Guide
/lrService/autoTone
/v2/edit
Edit Operations
/lrService/autoStraighten
/v2/edit
Edit Operations
/lrService/presets
/v2/edit
Edit Operations
/lrService/xmp
/v2/edit
Edit Operations
/lrService/edit
/v2/edit
Edit Operations
/pie/psdService/renditionCreate
/v2/create-composite
Format Conversion
/pie/psdService/documentCreate
/v2/create-composite
Document Creation
/pie/psdService/documentOperations
/v2/create-composite
Document Operations
Layer operations
/v2/create-composite
Layer Operations (see sub-guides)
/pie/psdService/photoshopActions
/v2/execute-actions
Actions Migration
/pie/psdService/actionJSON
/v2/execute-actions
Actions Migration
/pie/psdService/productCrop
/v2/execute-actions
Product Crop
/pie/psdService/splitView
/v2/execute-actions
Split View
/pie/psdService/sideBySide
/v2/execute-actions
Side by Side
/pie/psdService/artboardCreate
/v2/create-artboard
Artboard Migration
/pie/psdService/documentManifest
/v2/generate-manifest
Manifest Migration
/pie/psdService/status/{jobId}
/v2/status/{jobId}
Status Migration
/lrService/status/{jobId}
/v2/status/{jobId}
Status Migration
Sensei PSDC Engine
/v2/create-composite
Format Conversion

Need help?

If you encounter issues during migration: