Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Photoshop v2 API endpoints Photoshop APIs API

7 actions 7 updates phrasing extends openapi/adobe-suite-photoshop-apis-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v1/auto-crop'].post
$.paths['/v2/create-artboard'].post
$.paths['/v2/create-composite'].post
$.paths['/v2/edit'].post
$.paths['/v2/execute-actions'].post
$.paths['/v2/generate-manifest'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Photoshop v2 API endpoints Photoshop APIs API
  version: 1.0.0
extends: openapi/adobe-suite-photoshop-apis-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v1/auto-crop'].post
  update:
    x-apievangelist-phrasing:
      intent: Smart-crop an image and detect subjects
      effect: write
      questions:
      - How do I automatically crop an image around its subject?
      - Can I get subject bounding boxes and detected objects for a photo?
      - Can auto crop target a specific aspect ratio?
      instructions:
      - text: Auto-crop {image} using mode {mode}.
        slots:
          image: requestBody.image
          mode: requestBody.mode
      - text: Smart-crop {image} in {mode} mode to aspect ratio {aspectRatio}.
        slots:
          image: requestBody.image
          mode: requestBody.mode
          aspectRatio: requestBody.aspectRatio
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/create-artboard'].post
  update:
    x-apievangelist-phrasing:
      intent: Combine images into an artboard document
      effect: write
      questions:
      - How do I lay several images out as artboards in one Photoshop document?
      - Can I control the spacing between artboards?
      instructions:
      - text: Create an artboard from {images} and save to {outputs}.
        slots:
          images: requestBody.images
          outputs: requestBody.outputs
      - text: Build artboards from {images} with spacing {artboardSpacing}, output to {outputs}.
        slots:
          images: requestBody.images
          artboardSpacing: requestBody.artboardSpacing
          outputs: requestBody.outputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/create-composite'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or edit a layered composite
      effect: write
      questions:
      - How do I build a composite PSD by adding or editing layers?
      - Can I supply custom fonts when editing text layers in a composite?
      instructions:
      - text: Create a composite from {image} and write it to {outputs}.
        slots:
          image: requestBody.image
          outputs: requestBody.outputs
      - text: Apply layer edits {edits} to composite {image}, saving to {outputs}.
        slots:
          edits: requestBody.edits
          image: requestBody.image
          outputs: requestBody.outputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/edit'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply adjustments to an image
      effect: write
      questions:
      - How do I apply image adjustments like exposure or color changes via the Photoshop API?
      - Can I edit a photo and export it to cloud storage?
      instructions:
      - text: Apply adjustments {edits} to {image} and save to {outputs}.
        slots:
          edits: requestBody.edits
          image: requestBody.image
          outputs: requestBody.outputs
      - text: Edit image {image} and export the result to {outputs}.
        slots:
          image: requestBody.image
          outputs: requestBody.outputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/execute-actions'].post
  update:
    x-apievangelist-phrasing:
      intent: Run Photoshop actions or scripts on an image
      effect: write
      questions:
      - Can I run a recorded Photoshop action or script against an image in the cloud?
      - How do I batch-apply a Photoshop action file?
      instructions:
      - text: Run actions {options} on {image} and save to {outputs}.
        slots:
          options: requestBody.options
          image: requestBody.image
          outputs: requestBody.outputs
      - text: Execute my Photoshop script against {image}, writing results to {outputs}.
        slots:
          image: requestBody.image
          outputs: requestBody.outputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/generate-manifest'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a PSD's layer manifest
      effect: read
      questions:
      - How do I read the layer structure of a PSD file?
      - Can the manifest include layer thumbnails and XMP metadata?
      instructions:
      - text: Generate a layer manifest for {image} to {outputs}.
        slots:
          image: requestBody.image
          outputs: requestBody.outputs
      - text: Generate a manifest of {image} with layer thumbnails set to {includeLayerThumbnails}, output to {outputs}.
        slots:
          image: requestBody.image
          includeLayerThumbnails: requestBody.includeLayerThumbnails
          outputs: requestBody.outputs
      method: generated
      generated: '2026-09-26'