etherFAX · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for etherfax-rest-api-30 Inbox API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/inbox?a=get'].get
$.paths['/inbox?a=getnext'].get
$.paths['/inbox?a=list'].get
$.paths['/inbox?a=received'].get
$.paths['/inbox?a=unread'].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 etherfax-rest-api-30 Inbox API
  version: 1.0.0
extends: openapi/etherfax-inbox-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-19'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/inbox?a=get'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a received fax
      effect: read
      questions:
      - How do I download the image of a fax I already received?
      - Can I fetch a received fax with its image included?
      instructions:
      - text: Download fax {id}.
        slots:
          id: query.id
      - text: Get received fax {id} with image {download}.
        slots:
          id: query.id
          download: query.download
      method: generated
      generated: '2026-11-19'
- target: $.paths['/inbox?a=getnext'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the next unread fax
      effect: read
      questions:
      - How do I grab the next unread fax from the inbox?
      - Can I download the next unread fax and mark it as received?
      instructions:
      - text: Get the next unread fax.
      - text: Download the next unread fax with image {download}.
        slots:
          download: query.download
      method: generated
      generated: '2026-11-19'
- target: $.paths['/inbox?a=list'].get
  update:
    x-apievangelist-phrasing:
      intent: List unread faxes
      effect: read
      questions:
      - Which faxes on my account are still unread?
      - Can I limit how many unread faxes come back?
      instructions:
      - text: List unread faxes.
      - text: List the first {count} unread faxes.
        slots:
          count: query.count
      method: generated
      generated: '2026-11-19'
- target: $.paths['/inbox?a=received'].get
  update:
    x-apievangelist-phrasing:
      intent: Mark a fax as received
      effect: write
      questions:
      - How do I mark a received fax as read so its image is removed?
      - Can I report a fax as received with a result code?
      instructions:
      - text: Mark fax {id} as received.
        slots:
          id: query.id
      - text: Mark fax {id} as received with result {res}.
        slots:
          id: query.id
          res: query.res
      method: generated
      generated: '2026-11-19'
- target: $.paths['/inbox?a=unread'].get
  update:
    x-apievangelist-phrasing:
      intent: Count unread faxes
      effect: read
      questions:
      - How many faxes are waiting for me to read?
      - Can I wait for a new fax to arrive before counting?
      instructions:
      - text: Count unread faxes.
      - text: Tell me how many unread faxes there are.
      method: generated
      generated: '2026-11-19'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/etherfax-inbox-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.