# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Firefly Common Operations API
  version: 1.0.0
extends: openapi/adobe-suite-common-operations-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: 8
- target: $.paths['/v3/images/generate-async'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate images from a text prompt
      effect: write
      questions:
      - How do I generate images from a text prompt with Firefly?
      - Can I give a reference image so the results mimic its colors and layout?
      - Is there a way to tell the generator what to leave out of the image?
      instructions:
      - text: Generate images of {prompt}.
        slots:
          prompt: requestBody.prompt
      - text: Generate {numVariations} images of {prompt} without {negativePrompt}.
        slots:
          numVariations: requestBody.numVariations
          prompt: requestBody.prompt
          negativePrompt: requestBody.negativePrompt
      - text: Generate a {contentClass} image of {prompt} in the style {style}.
        slots:
          contentClass: requestBody.contentClass
          prompt: requestBody.prompt
          style: requestBody.style
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v4/images/generate-async'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate images with the Image5 model
      effect: write
      questions:
      - Can I generate images with the newer Firefly Image5 model?
      - What aspect ratio should I use with Image5 when I include reference images?
      instructions:
      - text: Use Image5 to generate {prompt}.
        slots:
          prompt: requestBody.prompt
      - text: Generate {prompt} with Image5 at aspect ratio {aspectRatio}.
        slots:
          prompt: requestBody.prompt
          aspectRatio: requestBody.aspectRatio
      - text: Create an Image5 picture of {prompt} guided by references {referenceBlobs}.
        slots:
          prompt: requestBody.prompt
          referenceBlobs: requestBody.referenceBlobs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/images/generate-similar-async'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate images similar to a reference
      effect: write
      questions:
      - Can I get variations that look like an image I already have?
      - How many similar images can I ask for from one reference?
      instructions:
      - text: Generate images similar to {image}.
        slots:
          image: requestBody.image
      - text: Make {numVariations} look-alike variations of {image}.
        slots:
          numVariations: requestBody.numVariations
          image: requestBody.image
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/images/expand-async'].post
  update:
    x-apievangelist-phrasing:
      intent: Expand an image to a new size or ratio
      effect: write
      questions:
      - How do I extend an image beyond its borders to change its aspect ratio?
      - Can I describe what should fill the expanded area?
      instructions:
      - text: Expand {image} to size {size}.
        slots:
          image: requestBody.image
          size: requestBody.size
      - text: Outpaint {image} and fill the new area with {prompt}.
        slots:
          image: requestBody.image
          prompt: requestBody.prompt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/images/fill-async'].post
  update:
    x-apievangelist-phrasing:
      intent: Fill a masked area of an image
      effect: write
      questions:
      - How do I replace part of an image using a mask and a prompt?
      - What does the mask control when filling an image?
      instructions:
      - text: Fill the area of {image} under mask {mask}.
        slots:
          image: requestBody.image
          mask: requestBody.mask
      - text: Fill the masked region {mask} of {image} with {prompt}.
        slots:
          mask: requestBody.mask
          image: requestBody.image
          prompt: requestBody.prompt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/videos/generate'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a short video from a prompt
      effect: write
      questions:
      - Can Firefly make a five second video from a text prompt?
      - Is it possible to start a generated video from an image?
      instructions:
      - text: Generate a five second video of {prompt}.
        slots:
          prompt: requestBody.prompt
      - text: Make a short video of {prompt} starting from image {image}.
        slots:
          prompt: requestBody.prompt
          image: requestBody.image
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/custom-models'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's custom models
      effect: read
      questions:
      - Which custom models do I have available for generation?
      - Can I filter my custom models by published state?
      instructions:
      - text: List my custom models.
      - text: Show my custom models that are {publishedState}, sorted by {sortBy}.
        slots:
          publishedState: query.publishedState
          sortBy: query.sortBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/storage/image'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a source image or mask
      effect: write
      questions:
      - How do I upload an image to use in fill, expand or upscale?
      - What do I get back after uploading a mask or source image?
      instructions:
      - text: Upload this image so I can use it in a fill.
      - text: Store my mask file and give me its upload ID.
      method: generated
      generated: '2026-09-26'