Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Firefly Services Audio and Video Reframe API

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

$.info
$.paths['/v1/reframe'].post
$.paths['/v2/reframe'].post
$.paths['/v2/status/{jobId}'].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 Reframe API
  version: 1.0.0
extends: openapi/adobe-suite-reframe-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: 3
- target: $.paths['/v1/reframe'].post
  update:
    x-apievangelist-phrasing:
      intent: Reframe a video with the older v1 endpoint
      effect: write
      questions:
      - Is there still a v1 way to reframe a video for a new aspect ratio?
      - Can the older reframe endpoint detect scene edits and add overlays?
      instructions:
      - text: Reframe video {video} using the v1 endpoint with output settings {output}.
        slots:
          video: requestBody.video
          output: requestBody.outputConfig
      - text: Use the legacy reframe API on {video} with scene edit detection {scenes}.
        slots:
          video: requestBody.video
          scenes: requestBody.sceneEditDetection
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reframe'].post
  update:
    x-apievangelist-phrasing:
      intent: Reframe a video for a new aspect ratio
      effect: write
      questions:
      - How do I use AI to reframe a landscape video into vertical or square formats?
      - Can I control analysis and composition when reframing a video?
      instructions:
      - text: Reframe video {video} into the output format {output}.
        slots:
          video: requestBody.video
          output: requestBody.output
      - text: Reframe {video} with composition settings {composition} and output {output}.
        slots:
          video: requestBody.video
          composition: requestBody.composition
          output: requestBody.output
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/status/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of a reframe job
      effect: read
      questions:
      - How do I check whether my reframed video is ready?
      - Where do I get the output video once a reframe job completes?
      instructions:
      - text: Get the result of reframe job {job}.
        slots:
          job: path.jobId
      - text: Check if reframing job {job} has finished.
        slots:
          job: path.jobId
      method: generated
      generated: '2026-09-26'