Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Firefly Services - InDesign Document Info API

3 actions 3 updates phrasing extends openapi/adobe-suite-document-info-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 3

$.info

$.paths['/v3/document-info'].post

$.paths['/v3/status/{document-info_job_id}'].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 Firefly Services - InDesign Document Info API
  version: 1.0.0
extends: openapi/adobe-suite-document-info-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: 2
- target: $.paths['/v3/document-info'].post
  update:
    x-apievangelist-phrasing:
      intent: Extract information from an InDesign document
      effect: read
      questions:
      - How do I find out which fonts, links and pages an InDesign file uses?
      - Can I extract text stories and page items from an INDD or IDML document?
      instructions:
      - text: Get document information for the InDesign file {assets}.
        slots:
          assets: requestBody.assets
      - text: Extract fonts and links from {assets} using options {params}.
        slots:
          assets: requestBody.assets
          params: requestBody.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/status/{document-info_job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a document info job and get results
      effect: read
      questions:
      - How do I know when my InDesign document analysis is done?
      - Where do I pick up the extracted pages, fonts and text once the job finishes?
      instructions:
      - text: Check the status of document info job {job}.
        slots:
          job: path.document-info_job_id
      - text: Get the extracted document details from job {job}.
        slots:
          job: path.document-info_job_id
      method: generated
      generated: '2026-09-26'