Create Artboard — Complete V1 Migration Reference

This page is the authoritative single-page field-level reference for migrating from the V1 /pie/psdService/artboardCreate endpoint to /v2/create-artboard.

For a guided walkthrough with examples and best practices, see Artboard Migration.

1. Endpoint and base URL

2. Request envelope

data-variant=warning

data-slots=text

V1:

{
  "options": {
    "artboard": [
      {"href": "<IMAGE_1_URL>", "storage": "external"},
      {"href": "<IMAGE_2_URL>", "storage": "external"}
    ]
  },
  "outputs": [...]
}

V2:

{
  "images": [
    {"source": {"url": "<IMAGE_1_URL>"}},
    {"source": {"url": "<IMAGE_2_URL>"}}
  ],
  "artboardSpacing": 50,
  "outputs": [...]
}

3. Input image fields

Field mapping

Array constraints

data-variant=warning

data-slots=text

Storage to source mapping examples

External presigned URL (S3, Frame.io, Google Drive):

// V1
{"href": "<PRESIGNED_URL>", "storage": "external"}

// V2
{"source": {"url": "<PRESIGNED_URL>"}}

Creative Cloud path:

// V1
{"href": "/path/to/image.jpg", "storage": "adobe"}

// V2 — note: no leading slash in V2
{"source": {"creativeCloudPath": "path/to/image.jpg"}}

Creative Cloud file ID:

// V1
{"href": "urn:aaid:sc:US:...", "storage": "adobe"}

// V2
{"source": {"creativeCloudFileId": "urn:aaid:sc:US:..."}}

4. Artboard spacing

Images are arranged horizontally left-to-right. The spacing applies between each pair of adjacent artboards. Total output width = sum of image widths + (spacing × (image count − 1)).

5. Output fields

data-variant=warning

data-slots=text

Output array constraints

Both V1 and V2 require 1–25 outputs per request.

6. JPEG quality mapping

data-variant=info

data-slots=text

7. PNG compression mapping

8. Supported output formats

9. Destination types (V2 new capability)

V1 used href + storage enum. V2 uses a typed destination union:

Destination mapping from V1 storage

data-variant=info

data-slots=text

10. Crop mode (replaces V1 trim booleans)

V1 had two separate boolean flags on outputs. V2 consolidates into a single enum:

11. Status response changes

The V2 status response structure is substantially different from V1:

See Status Migration for the full status response reference.

12. Complete V1 → V2 request example

V1:

curl -X POST \
  https://image.adobe.io/pie/psdService/artboardCreate \
  -H "Authorization: Bearer $token" \
  -H "x-api-key: $apiKey" \
  -H "Content-Type: application/json" \
  -d '{
  "options": {
    "artboard": [
      {"href": "<IMAGE_1_URL>", "storage": "external"},
      {"href": "<IMAGE_2_URL>", "storage": "external"}
    ]
  },
  "outputs": [
    {
      "href": "<SIGNED_POST_URL>",
      "storage": "external",
      "type": "image/vnd.adobe.photoshop"
    },
    {
      "href": "<JPEG_URL>",
      "storage": "external",
      "type": "image/jpeg",
      "quality": 7,
      "width": 2000
    }
  ]
}'

V2:

curl -X POST \
  https://photoshop-api.adobe.io/v2/create-artboard \
  -H "Authorization: Bearer $token" \
  -H "x-api-key: $apiKey" \
  -H "Content-Type: application/json" \
  -d '{
  "images": [
    {"source": {"url": "<IMAGE_1_URL>"}},
    {"source": {"url": "<IMAGE_2_URL>"}}
  ],
  "artboardSpacing": 50,
  "outputs": [
    {
      "destination": {"url": "<SIGNED_POST_URL>"},
      "mediaType": "image/vnd.adobe.photoshop"
    },
    {
      "destination": {"url": "<JPEG_URL>"},
      "mediaType": "image/jpeg",
      "quality": "maximum",
      "width": 2000
    }
  ]
}'

Key transformation summary:

1. options.artboard[] → images[] (remove options wrapper)
2. href + storage → source.url (on inputs)
3. href + storage → destination.url (on outputs; storageType only for Azure/Dropbox)
4. type → mediaType
5. quality: 7 → quality: "maximum"
6. Add artboardSpacing if custom spacing needed (default is 50)

13. Migration checklist

• Change options.artboard[] to top-level images[]
• Change href + storage → source.url on each image (or source.creativeCloudPath / source.creativeCloudFileId for CC)
• Change outputs[].href → outputs[].destination.url
• Remove outputs[].storage (only add destination.storageType for Azure or Dropbox)
• Change outputs[].type → outputs[].mediaType
• Change JPEG quality from numeric (1–7) to string enum ("maximum", "high", etc.)
• Change PNG compression from small/medium/large to V2 enum ("maximum", "medium", "low", etc.)
• Replace overwrite with shouldOverwrite
• Replace trimToCanvas/trimToLayer booleans with cropMode enum
• Add artboardSpacing if your V1 workflow needed specific spacing
• Update status polling: outputs[n].status → top-level status; outputs[n]._links.renditions[m].href → result.outputs[n].destination.url
• Verify image count ≤ 25 (V2 enforces this limit)
• No leading slash on Creative Cloud paths

See also

• Artboard Migration — Guided walkthrough with examples and best practices
• Output Types Migration — JPEG, PNG, TIFF, PSD output format details
• ICC Profile Migration — Color management options
• Status Migration — Job status response format