Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Illustrator API - Firefly Services Data Merge & Create…

4 actions 4 updates phrasing extends openapi/adobe-suite-data-merge-create-rendition-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/merge-data'].post

$.paths['/v1/create-rendition'].post

$.paths['/v1/status/{jobId}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Illustrator API - Firefly Services Data Merge & Create…
  version: 1.0.0
extends: openapi/adobe-suite-data-merge-create-rendition-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/merge-data'].post
  update:
    x-apievangelist-phrasing:
      intent: Merge CSV data into an Illustrator template
      effect: write
      questions:
      - How do I generate one Illustrator file per row of a CSV spreadsheet?
      - Can I supply custom .ttf or .otf fonts for a data merge?
      - What happens if only some CSV rows merge successfully?
      instructions:
      - text: Merge CSV {data} into Illustrator template {template} and output {output}.
        slots:
          data: requestBody.data
          template: requestBody.template
          output: requestBody.output
      - text: Run a data merge of {data} with template {template} using fonts {fontFiles}, saving as {output}.
        slots:
          data: requestBody.data
          template: requestBody.template
          fontFiles: requestBody.fontFiles
          output: requestBody.output
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/create-rendition'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert an Illustrator file to another format
      effect: write
      questions:
      - Can I convert an .ai document into a web- or print-ready format like PDF or PNG?
      - How do I render an Illustrator file without opening Illustrator?
      instructions:
      - text: Convert Illustrator file {input} to {output}.
        slots:
          input: requestBody.input
          output: requestBody.output
      - text: Create a rendition of {input} as {output} with settings {settings}.
        slots:
          input: requestBody.input
          output: requestBody.output
          settings: requestBody.settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/status/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an Illustrator job's status
      effect: read
      questions:
      - Has my Illustrator data merge or rendition job finished?
      - What statuses can an Illustrator job report, such as partially succeeded?
      instructions:
      - text: Check the status of Illustrator job {jobId}.
        slots:
          jobId: path.jobId
      - text: Poll job {jobId} until it succeeds or fails.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'