Emboss · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Getemboss Ai Fax API

3 actions 3 updates phrasing extends openapi/getemboss-ai-fax-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 3

$.info
$.paths['/fax'].post
$.paths['/fax/{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 Fax API
  version: 1.0.0
extends: openapi/getemboss-ai-fax-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: 2
- target: $.paths['/fax'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a fax from my account
      effect: write
      questions:
      - How do I fax one or more PDFs to a number from my account?
      - Can I fax a form I already filled without uploading it again?
      - Will retrying a fax request send a duplicate fax?
      instructions:
      - text: Fax {files} to {to}.
        slots:
          files: requestBody.files
          to: requestBody.to
      - text: Fax my form {form_id} to {to}.
        slots:
          form_id: requestBody.form_id
          to: requestBody.to
      - text: Send the result of job {job_id} by fax to {to}.
        slots:
          job_id: requestBody.job_id
          to: requestBody.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/fax/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a fax's delivery status
      effect: read
      questions:
      - Did my fax go through?
      - How many pages of my fax were transmitted?
      instructions:
      - text: Check the status of fax {job_id}.
        slots:
          job_id: path.job_id
      - text: Tell me whether fax job {job_id} was delivered.
        slots:
          job_id: path.job_id
      method: generated
      generated: '2026-10-01'