Emboss · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Getemboss Ai Pay API

8 actions 8 updates phrasing extends openapi/getemboss-ai-pay-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Emboss's API. It is a proposal applied on top of the contract, not a document Emboss publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/pay'].get
$.paths['/pay/openapi.json'].get
$.paths['/pay/llms.txt'].get
$.paths['/pay/pricing'].get
$.paths['/pay/quote'].post
$.paths['/pay/{op}'].post
$.paths['/pay/jobs/{job_id}'].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 Getemboss Ai Pay API
  version: 1.0.0
extends: openapi/getemboss-ai-pay-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/pay'].get
  update:
    x-apievangelist-phrasing:
      intent: List the paid operations and their docs
      effect: read
      questions:
      - Which pay-per-use operations are available and where are their docs?
      - Is there a discovery index an agent can read for the paid door?
      instructions:
      - text: Show the index of paid operations.
      - text: List every pay-per-use op with a link to its docs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pay/openapi.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the pay manifest at its legacy /pay path
      effect: read
      questions:
      - Does the older /pay/openapi.json link still serve the pay manifest?
      - Can I fetch the MPP manifest from under the /pay path instead of the root?
      instructions:
      - text: Fetch the pay manifest from the /pay/openapi.json alias.
      - text: Download the legacy-path copy of the pay-per-use OpenAPI manifest.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pay/llms.txt'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the llms.txt for the pay door
      effect: read
      questions:
      - Is there an llms.txt that tells agents the starting prices for paid ops?
      - Where can an LLM read a short summary of the pay-per-use door?
      instructions:
      - text: Fetch the pay door llms.txt.
      - text: Read the agent-facing llms.txt with from-prices and links.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pay/pricing'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the public price list under /pay
      effect: read
      questions:
      - What does each pay-per-use operation cost, listed next to the quote endpoint?
      - Is the /pay/pricing list the same as the main price list?
      instructions:
      - text: Show the price list at /pay/pricing.
      - text: Get the pay door's public prices.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pay/quote'].post
  update:
    x-apievangelist-phrasing:
      intent: Inspect a PDF's exact price before paying
      effect: read
      questions:
      - How many pages does my PDF have and is it already fillable, before I pay?
      - Is the pay quote throttled per IP address?
      instructions:
      - text: Inspect {file} and quote the price of every op.
        slots:
          file: requestBody.file
      - text: Quote a structured fill of {file} with values {values}.
        slots:
          file: requestBody.file
          values: requestBody.values
      - text: Price a context fill of {file} using the pages at {context_urls}.
        slots:
          file: requestBody.file
          context_urls: requestBody.context_urls
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pay/{op}'].post
  update:
    x-apievangelist-phrasing:
      intent: Pay for and run a named PDF operation
      effect: write
      questions:
      - How do I pay for and run one operation, like fill or fax, by its name?
      - What error format comes back when a paid operation is rejected?
      - What happens if I call the pay door with an op name that doesn't exist?
      instructions:
      - text: Pay for and run op {op} on {file}.
        slots:
          op: path.op
          file: requestBody.file
      - text: Run paid op {op} on {file} with values {values}.
        slots:
          op: path.op
          file: requestBody.file
          values: requestBody.values
      - text: Pay to run {op} and send the result to fax number {to}.
        slots:
          op: path.op
          to: requestBody.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pay/jobs/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Poll a paid job's status for free
      effect: read
      questions:
      - How do I check on a paid job without paying again or having an account?
      - Which token do I need to poll a pay-door job?
      instructions:
      - text: Poll paid job {job_id} with token {token}.
        slots:
          job_id: path.job_id
          token: query.token
      - text: Check whether pay-door job {job_id} has finished.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-10-01'