Adobe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for PDF Services Export PDF Form Data API

3 actions 3 updates phrasing extends openapi/adobe-export-pdf-form-data-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Adobe's API. It is a proposal applied on top of the contract, not a document Adobe publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/operation/getformdata'].post

$.paths['/operation/getformdata/{jobID}/status'].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 PDF Services Export PDF Form Data API
  version: 1.0.0
extends: openapi/adobe-export-pdf-form-data-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['/operation/getformdata'].post
  update:
    x-apievangelist-phrasing:
      intent: Read the filled-in data from a PDF form
      effect: read
      questions:
      - How do I pull the values someone typed into a PDF form as JSON?
      - What does the exported form data look like, are field names the keys?
      instructions:
      - text: Extract the form field values from this PDF as JSON.
      - text: Get the filled-in data from my PDF form.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operation/getformdata/{jobID}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a form data export job
      effect: read
      questions:
      - Is the JSON from my PDF form export ready?
      - When can I download the extracted form field values?
      instructions:
      - text: Check form data export job {jobID}.
        slots:
          jobID: path.jobID
      - text: Poll get-form-data job {jobID} and return the JSON.
        slots:
          jobID: path.jobID
      method: generated
      generated: '2026-09-26'