Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Firefly Services Audio and Video Dynamic Graphics Render API

6 actions 6 updates phrasing extends openapi/adobe-suite-dynamic-graphics-render-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 6

$.info
$.paths['/v1/templates/describe'].post
$.paths['/v1/presets'].get
$.paths['/v1/templates/render'].post
$.paths['/v1/cancel/{jobId}'].put
$.paths['/v1/templates/render-jobs'].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 Firefly Services Audio and Video Dynamic Graphics Render API
  version: 1.0.0
extends: openapi/adobe-suite-dynamic-graphics-render-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: 5
- target: $.paths['/v1/templates/describe'].post
  update:
    x-apievangelist-phrasing:
      intent: List the editable controls in a video template
      effect: read
      questions:
      - Which text, fonts, images and audio can I change in a Motion Graphics template?
      - Can I inspect an After Effects project composition to see its editable layers?
      instructions:
      - text: Describe the MOGRT template at {source} and list its editable controls.
        slots:
          source: requestBody.source
      - text: Describe composition {compName} in the {type} project at {source}.
        slots:
          compName: requestBody.compName
          type: requestBody.type
          source: requestBody.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/presets'].get
  update:
    x-apievangelist-phrasing:
      intent: List video rendering presets
      effect: read
      questions:
      - What social-first encoding presets can I render video outputs with?
      - Which built-in export presets are available for template renders?
      instructions:
      - text: List the available video rendering presets.
      - text: Show me the built-in social export presets.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/templates/render'].post
  update:
    x-apievangelist-phrasing:
      intent: Render video variations from a template
      effect: write
      questions:
      - How do I render personalized video versions from a MOGRT with different text or images?
      - How many overrides can I send in one render request?
      - Do I get a download link for the rendered video files?
      instructions:
      - text: 'Render the template at {source} with these variations: {variations}.'
        slots:
          source: requestBody.source
          variations: requestBody.variations
      - text: Render {variations} from template {source} using presets {presets}.
        slots:
          variations: requestBody.variations
          source: requestBody.source
          presets: requestBody.presets
      - text: Render composition {compName} of the After Effects project at {source} with variations {variations}.
        slots:
          compName: requestBody.compName
          source: requestBody.source
          variations: requestBody.variations
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/cancel/{jobId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Cancel a video render job
      effect: destructive
      questions:
      - Can I stop a template render that is still in progress?
      - What status does a render job report after I cancel it?
      instructions:
      - text: Cancel render job {jobId}.
        slots:
          jobId: path.jobId
      - text: Abort the in-flight video render {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/templates/render-jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List my template render jobs
      effect: read
      questions:
      - Which of my video render jobs are still running?
      - Can I see render jobs I submitted in the last week?
      instructions:
      - text: List my render jobs.
      - text: List render jobs matching the filter {filter}.
        slots:
          filter: query.filter
      - text: Show the next {limit} render jobs after cursor {cursor}.
        slots:
          limit: query.limit
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'