Adobe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for PDF Services PDF To Markdown API

3 actions 3 updates phrasing extends openapi/adobe-pdf-to-markdown-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/pdftomarkdown'].post
$.paths['/operation/pdftomarkdown/{jobID}/status'].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 PDF Services PDF To Markdown API
  version: 1.0.0
extends: openapi/adobe-pdf-to-markdown-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/pdftomarkdown'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert a PDF into Markdown
      effect: write
      questions:
      - Can I convert a PDF into Markdown for an LLM pipeline?
      - Is it possible to include figures as base64 images in the Markdown output?
      instructions:
      - text: Convert this PDF to Markdown.
      - text: Turn my PDF into Markdown with its figures embedded.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operation/pdftomarkdown/{jobID}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a PDF-to-Markdown job
      effect: read
      questions:
      - Is my Markdown conversion finished?
      - Where do I get the Markdown once the job is done?
      instructions:
      - text: Check PDF to Markdown job {jobID}.
        slots:
          jobID: path.jobID
      - text: Poll Markdown conversion job {jobID} and return the result.
        slots:
          jobID: path.jobID
      method: generated
      generated: '2026-09-26'