Adobe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe OCR API

3 actions 3 updates phrasing extends openapi/adobe-ocr-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/ocr'].post

$.paths['/operation/ocr/{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 Adobe OCR API
  version: 1.0.0
extends: openapi/adobe-ocr-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/ocr'].post
  update:
    x-apievangelist-phrasing:
      intent: Make a scanned PDF searchable with OCR
      effect: write
      questions:
      - How do I make text in a scanned PDF searchable?
      - Can I choose the language used for OCR on a PDF?
      instructions:
      - text: Run OCR on this scanned PDF.
      - text: Make my scanned PDF searchable using German text recognition.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/operation/ocr/{jobID}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of an OCR job
      effect: read
      questions:
      - Has my OCR job finished?
      - Where do I get the searchable PDF after OCR?
      instructions:
      - text: Check OCR job {jobID}.
        slots:
          jobID: path.jobID
      - text: Poll text recognition job {jobID} and return the searchable PDF.
        slots:
          jobID: path.jobID
      method: generated
      generated: '2026-09-26'