Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Suite Assets API

13 actions 13 updates phrasing extends openapi/adobe-suite-assets-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 13

$.info
$.paths['/v2/catalogs/{catalog_id}/assets/{asset_id}'].get
$.paths['/v2/catalogs/{catalog_id}/assets/{asset_id}'].put
$.paths['/v2/catalogs/{catalog_id}/assets'].get
$.paths['/v2/catalogs/{catalog_id}/assets/{asset_id}/master'].put
$.paths['/v2/catalogs/{catalog_id}/assets/{asset_id}/renditions'].post
$.paths['/v2/catalogs/{catalog_id}/assets/{asset_id}/renditions/{rendition_type}'].get
$.paths['/v2/catalogs/{catalog_id}/assets/{asset_id}/xmp/develop'].get
$.paths['/v2/catalogs/{catalog_id}/assets/{asset_id}/xmp/develop'].put
$.paths['/assets'].post
$.paths['/assets/{assetId}'].get
$.paths['/assets/{assetId}'].delete
$.paths['/assets/{assetId}/metadata'].get

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 Adobe Suite Assets API
  version: 1.0.0
extends: openapi/adobe-suite-assets-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: 12
- target: $.paths['/v2/catalogs/{catalog_id}/assets/{asset_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Lightroom catalog asset
      effect: read
      questions:
      - How do I read the details of one photo in my Lightroom catalog?
      - Can I tell whether an asset's renditions are invalid because it was edited?
      instructions:
      - text: Show asset {asset_id} from catalog {catalog_id}.
        slots:
          asset_id: path.asset_id
          catalog_id: path.catalog_id
      - text: Check if the renditions for Lightroom asset {asset_id} in {catalog_id} are still valid.
        slots:
          asset_id: path.asset_id
          catalog_id: path.catalog_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/catalogs/{catalog_id}/assets/{asset_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a Lightroom asset with initial metadata
      effect: write
      questions:
      - What's the first step to add a new photo to a Lightroom catalog through the API?
      - Can I choose the asset ID myself when creating a Lightroom asset?
      instructions:
      - text: Create asset {asset_id} in catalog {catalog_id} with import metadata {payload}.
        slots:
          asset_id: path.asset_id
          catalog_id: path.catalog_id
          payload: requestBody.payload
      - text: Create a {subtype} asset {asset_id} in Lightroom catalog {catalog_id}.
        slots:
          subtype: requestBody.subtype
          asset_id: path.asset_id
          catalog_id: path.catalog_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/catalogs/{catalog_id}/assets'].get
  update:
    x-apievangelist-phrasing:
      intent: List assets in a Lightroom catalog
      effect: read
      questions:
      - Which photos in my Lightroom catalog were captured within a certain date range?
      - Can I find catalog assets by the SHA256 hash of the original file?
      - What's the maximum number of assets I can list in one Lightroom page?
      instructions:
      - text: List assets in catalog {catalog_id} captured after {captured_after}.
        slots:
          catalog_id: path.catalog_id
          captured_after: query.captured_after
      - text: Find assets in {catalog_id} whose original has hash {sha256}.
        slots:
          catalog_id: path.catalog_id
          sha256: query.sha256
      - text: Show {limit} assets from catalog {catalog_id} changed since {updated_since}.
        slots:
          limit: query.limit
          catalog_id: path.catalog_id
          updated_since: query.updated_since
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/catalogs/{catalog_id}/assets/{asset_id}/master'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload an asset's original file
      effect: write
      questions:
      - How do I upload the original image file for a Lightroom asset?
      - Can I upload a file larger than 200 MB in parts using Content-Range?
      instructions:
      - text: Upload the original file for asset {asset_id} in catalog {catalog_id}.
        slots:
          asset_id: path.asset_id
          catalog_id: path.catalog_id
      - text: Upload byte range {range} of the original for asset {asset_id} in {catalog_id}.
        slots:
          range: header.Content-Range
          asset_id: path.asset_id
          catalog_id: path.catalog_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/catalogs/{catalog_id}/assets/{asset_id}/renditions'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate renditions for a Lightroom asset
      effect: write
      questions:
      - How can I get Lightroom to regenerate a fullsize or 2560 rendition after an edit?
      - How long do generated renditions stick around before they're deleted?
      instructions:
      - text: Generate {types} renditions for asset {asset_id} in catalog {catalog_id}.
        slots:
          types: header.X-Generate-Renditions
          asset_id: path.asset_id
          catalog_id: path.catalog_id
      - text: Kick off a fullsize rendition build for Lightroom asset {asset_id} in {catalog_id}; types {types}.
        slots:
          asset_id: path.asset_id
          catalog_id: path.catalog_id
          types: header.X-Generate-Renditions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/catalogs/{catalog_id}/assets/{asset_id}/renditions/{rendition_type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an asset rendition
      effect: read
      questions:
      - Can I download a thumbnail or fullsize rendition of a Lightroom photo?
      - Why would fetching a 2560 rendition return 404?
      instructions:
      - text: Download the {rendition_type} rendition of asset {asset_id} in catalog {catalog_id}.
        slots:
          rendition_type: path.rendition_type
          asset_id: path.asset_id
          catalog_id: path.catalog_id
      - text: Get the latest thumbnail for asset {asset_id} in {catalog_id} as rendition {rendition_type}.
        slots:
          asset_id: path.asset_id
          catalog_id: path.catalog_id
          rendition_type: path.rendition_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/catalogs/{catalog_id}/assets/{asset_id}/xmp/develop'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an asset's XMP develop settings
      effect: read
      questions:
      - Where can I read the external XMP develop settings file for a Lightroom asset?
      - Can I fetch the latest develop settings saved for a photo?
      instructions:
      - text: Download the XMP develop settings for asset {asset_id} in catalog {catalog_id}.
        slots:
          asset_id: path.asset_id
          catalog_id: path.catalog_id
      - text: Get the latest develop settings file of {asset_id} from {catalog_id}.
        slots:
          asset_id: path.asset_id
          catalog_id: path.catalog_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/catalogs/{catalog_id}/assets/{asset_id}/xmp/develop'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload or copy XMP develop settings for an asset
      effect: write
      questions:
      - How do I attach an XMP develop settings file to a Lightroom asset?
      - Can I copy the develop settings from one asset to another?
      instructions:
      - text: Upload an XMP develop settings file for asset {asset_id} in catalog {catalog_id}.
        slots:
          asset_id: path.asset_id
          catalog_id: path.catalog_id
      - text: Copy develop settings from {file_href} onto asset {asset_id} in {catalog_id}.
        slots:
          file_href: requestBody.file_href
          asset_id: path.asset_id
          catalog_id: path.catalog_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assets'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a pre-signed URL to upload a PDF Services asset
      effect: write
      questions:
      - How do I upload a document to PDF Services before running an operation on it?
      - How long is the pre-signed upload URL valid?
      instructions:
      - text: Get a pre-signed upload URL for a {mediaType} file.
        slots:
          mediaType: requestBody.mediaType
      - text: Create a new PDF Services asset and give me the URL to upload its content.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/assets/{assetId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a pre-signed URL to download an asset
      effect: read
      questions:
      - How do I download the output file of a PDF Services job?
      - Can I get a direct download link for a stored asset?
      instructions:
      - text: Give me a download link for PDF Services asset {assetId}.
        slots:
          assetId: path.assetId
      - text: Fetch the one-hour pre-signed download URL for stored asset {assetId}.
        slots:
          assetId: path.assetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/assets/{assetId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a stored PDF Services asset
      effect: destructive
      questions:
      - Can I remove an uploaded document from PDF Services storage before it expires?
      - How do I delete a temporary asset from storage?
      instructions:
      - text: Delete PDF Services asset {assetId} from storage.
        slots:
          assetId: path.assetId
      - text: Remove uploaded asset {assetId} from the cloud storage before it expires.
        slots:
          assetId: path.assetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/assets/{assetId}/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metadata for a stored asset
      effect: read
      questions:
      - What metadata does PDF Services keep about a temporary asset I stored?
      - Can I check a stored asset's size or type without downloading it?
      instructions:
      - text: Show the metadata of stored PDF Services asset {assetId}.
        slots:
          assetId: path.assetId
      - text: Get the size and type metadata for temporary asset {assetId}.
        slots:
          assetId: path.assetId
      method: generated
      generated: '2026-10-01'