# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for documentation Photoshop API
  version: 1.0.0
extends: openapi/adobe-suite-photoshop-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 17
- target: $.paths['/sensei/cutout'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove the background from an image
      effect: write
      questions:
      - How do I remove the background from a product photo automatically?
      - Can the Photoshop API return a transparent PNG cutout of the main subject?
      instructions:
      - text: Remove the background from this image and save a PNG cutout.
      - text: Cut out the subject of my photo so it has a transparent background.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sensei/mask'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a subject mask for an image
      effect: write
      questions:
      - Can I get a black and white mask of the main subject instead of a cutout?
      - What does the create mask job output for an image?
      instructions:
      - text: Create a mask PNG of the subject in this image.
      - text: Generate a selection mask for the foreground of my photo.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sensei/status/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a background removal or mask job
      effect: read
      questions:
      - Is my remove-background job finished yet?
      - Where do I find the output of a create-mask job once it completes?
      instructions:
      - text: Check the status of cutout or mask job {job}.
        slots:
          job: path.jobId
      - text: Get the result of background removal job {job}.
        slots:
          job: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pie/psdService/renditionCreate'].post
  update:
    x-apievangelist-phrasing:
      intent: Render a PSD to other image formats
      effect: write
      questions:
      - Can I convert a PSD into JPEG or PNG renditions?
      - Which output formats can I render a Photoshop document to?
      instructions:
      - text: Create JPEG and PNG renditions of this PSD.
      - text: Render my Photoshop file as a flattened PNG.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pie/psdService/actionJSON'].post
  update:
    x-apievangelist-phrasing:
      intent: Play back Photoshop actions in actionJSON
      effect: write
      questions:
      - Can I run Photoshop actions described as actionJSON instead of an .atn file?
      - What is actionJSON playback in the Photoshop API?
      instructions:
      - text: Apply these actionJSON steps to my image.
      - text: Run the actionJSON commands against this PSD and save the output.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pie/psdService/actionJsonCreate'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert an .atn action file to actionJSON
      effect: write
      questions:
      - How can I turn my recorded .atn action file into actionJSON?
      - Is there a way to see the actionJSON equivalent of a Photoshop action set?
      instructions:
      - text: Convert this .atn action file to actionJSON.
      - text: Generate actionJSON from my recorded Photoshop actions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pie/psdService/smartObject'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace a smart object in a PSD
      effect: write
      questions:
      - Can I swap the embedded smart object in a PSD mockup with a new image?
      - How do I batch replace smart objects in templates and export renditions?
      instructions:
      - text: Replace the smart object in this PSD with my new artwork.
      - text: Swap the embedded smart object layer and save a new PSD.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pie/psdService/photoshopActions'].post
  update:
    x-apievangelist-phrasing:
      intent: Run Photoshop .atn actions on an image
      effect: write
      questions:
      - Can I apply my recorded Photoshop actions file to images in the cloud?
      - Which image edits can be automated with an .atn actions file?
      instructions:
      - text: Run my .atn Photoshop actions on this image.
      - text: Apply the recorded action set to the photo and save the result.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pie/psdService/productCrop'].post
  update:
    x-apievangelist-phrasing:
      intent: Crop an image tightly around the product
      effect: write
      questions:
      - Can the API crop product photos around the subject with padding?
      - What does product crop do to an e-commerce image?
      instructions:
      - text: Crop this product photo around the product.
      - text: Run product crop on my image with some padding around the item.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pie/psdService/depthBlur'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a depth blur effect to an image
      effect: write
      questions:
      - Can I blur the background of a photo to simulate depth of field?
      - Is there a neural depth blur filter available through the API?
      instructions:
      - text: Apply depth blur to the background of this image.
      - text: Add a shallow depth-of-field blur to my photo.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pie/psdService/text'].post
  update:
    x-apievangelist-phrasing:
      intent: Edit text layers in a PSD
      effect: write
      questions:
      - Can I change the wording or font of text layers in a PSD?
      - Which text layer properties can be edited through the Photoshop API?
      instructions:
      - text: Change the text in the headline layer of this PSD.
      - text: Update the text layers in my template and export a PNG.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pie/psdService/documentOperations'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply document and layer edits to a PSD
      effect: write
      questions:
      - Can I add, move or delete layers in an existing PSD?
      - What document-level edits like resize or crop can I apply to a PSD?
      instructions:
      - text: Apply these layer edits to my PSD and save it.
      - text: Resize this Photoshop document and add a new layer.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pie/psdService/documentCreate'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new PSD document
      effect: write
      questions:
      - Can I create a blank PSD from scratch with layers through the API?
      - What canvas settings can I choose for a brand-new Photoshop document?
      instructions:
      - text: Create a new PSD with these layers.
      - text: Make a blank Photoshop document and save it as a PSD.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pie/psdService/artboardCreate'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an artboard in a PSD
      effect: write
      questions:
      - How do I build a PSD with multiple artboards?
      - Can I combine several images into artboards in one document?
      instructions:
      - text: Create an artboard PSD from these images.
      - text: Add artboards to a new Photoshop document.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pie/psdService/status/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a PSD editing job's status
      effect: read
      questions:
      - Has my rendition, smart object or text edit job finished?
      - Where do I get output links for a completed PSD editing job?
      instructions:
      - text: Check the status of PSD job {job}.
        slots:
          job: path.jobId
      - text: Get the outputs of rendition or edit job {job}.
        slots:
          job: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pie/psdService/documentManifest'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a PSD's layer manifest
      effect: read
      questions:
      - What layers and metadata are inside a PSD file?
      - Can I inspect a Photoshop document's layer tree without opening it?
      instructions:
      - text: Get the manifest of this PSD.
      - text: List the layers and document metadata in my Photoshop file.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/pie/psdService/status/{jobid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a PSD manifest job's status
      effect: read
      questions:
      - Is the manifest for my PSD ready yet?
      - Where can I read the layer information once a manifest job completes?
      instructions:
      - text: Check the status of manifest job {job}.
        slots:
          job: path.jobId
      - text: Fetch the finished document manifest for job {job}.
        slots:
          job: path.jobId
      - text: Poll the document manifest job {jobid} until it finishes.
        slots:
          jobid: path.jobid
      method: generated
      generated: '2026-10-01'