Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Express Beta API

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

$.info
$.paths['/beta/tagged-documents'].get
$.paths['/beta/tagged-documents/{documentId}'].get
$.paths['/beta/generate-variation'].post
$.paths['/beta/export-rendition'].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 Express Beta API
  version: 1.0.0
extends: openapi/adobe-suite-beta-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: 4
- target: $.paths['/beta/tagged-documents'].get
  update:
    x-apievangelist-phrasing:
      intent: List tagged Adobe Express documents
      effect: read
      questions:
      - Which tagged Adobe Express documents can I access, including ones shared with me?
      - What's the most tagged documents I can pull per page?
      instructions:
      - text: List my tagged Express documents.
      - text: List tagged documents starting at {start}, {limit} per page, sorted by {sortBy}.
        slots:
          start: query.start
          limit: query.limit
          sortBy: query.sortBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/beta/tagged-documents/{documentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get pages and tagged elements of a document
      effect: read
      questions:
      - How do I see the pages and tagged elements inside one Express document?
      - Can I get the size and position of each tagged element on a page?
      instructions:
      - text: Get the tagged element details for document {documentId}.
        slots:
          documentId: path.documentId
      - text: Show pages of document {documentId} starting from page {start}.
        slots:
          documentId: path.documentId
          start: query.start
      method: generated
      generated: '2026-09-26'
- target: $.paths['/beta/generate-variation'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a variation of a tagged document
      effect: write
      questions:
      - How do I create a new version of an Express template with different text or images?
      - How long does a generated document variation stay available?
      instructions:
      - text: Generate a variation of tagged document {id} using {variationDetails}.
        slots:
          id: requestBody.id
          variationDetails: requestBody.variationDetails
      - text: 'Create a variant of template {id} with these replacements: {variationDetails}.'
        slots:
          id: requestBody.id
          variationDetails: requestBody.variationDetails
      method: generated
      generated: '2026-09-26'
- target: $.paths['/beta/export-rendition'].post
  update:
    x-apievangelist-phrasing:
      intent: Export Express pages as images, video or PDF
      effect: write
      questions:
      - How do I export pages of an Adobe Express document as PNG or PDF?
      - Can I render only a range of pages to MP4 or JPG?
      - How long do the rendition download links stay valid?
      instructions:
      - text: Export document {id} with rendition options {options}.
        slots:
          id: requestBody.id
          options: requestBody.options
      - text: Render pages {pages} of document {id} using {options}.
        slots:
          pages: requestBody.pages
          id: requestBody.id
          options: requestBody.options
      method: generated
      generated: '2026-09-26'