etherFAX · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for etherfax-rest-api-30 Devices API
9 actions
9 updates
phrasing
extends
openapi/etherfax-devices-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.
What the actions change
x-apievangelist-phrasing
Targets 9
$.info
$.paths['/devices/pkinfo'].post
$.paths['/devices?a=actionreset'].get
$.paths['/devices?a=list'].get
$.paths['/devices?a=register'].get
$.paths['/devices?a=setaddr'].get
$.paths['/devices?a=setconfig'].get
$.paths['/devices?a=status'].get
$.paths['/devices?a=unread'].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 etherfax-rest-api-30 Devices API
version: 1.0.0
extends: openapi/etherfax-devices-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: 8
- target: $.paths['/devices/pkinfo'].post
update:
x-apievangelist-phrasing:
intent: Set a device's public key
effect: write
questions:
- How do I register a public key for my device?
- Can I upload a PEM-encoded public key for a device?
instructions:
- text: Set the public key on this device to {PublicKey}.
slots:
PublicKey: requestBody.PublicKey
- text: Register the device's PEM public key {PublicKey}.
slots:
PublicKey: requestBody.PublicKey
method: generated
generated: '2026-11-19'
- target: $.paths['/devices?a=actionreset'].get
update:
x-apievangelist-phrasing:
intent: Reset a device's action state
effect: write
questions:
- How do I clear the action state of a device?
- Can I reset a device's action state explicitly?
instructions:
- text: Reset the action state of this device.
- text: Clear the device's action state using action {a}.
slots:
a: query.a
method: generated
generated: '2026-11-19'
- target: $.paths['/devices?a=list'].get
update:
x-apievangelist-phrasing:
intent: List unread faxes for a device
effect: read
questions:
- Which faxes are waiting for my device?
- How do I see unread faxes on a device?
instructions:
- text: List unread faxes for this device.
- text: Show the faxes waiting for the device using action {a}.
slots:
a: query.a
method: generated
generated: '2026-11-19'
- target: $.paths['/devices?a=register'].get
update:
x-apievangelist-phrasing:
intent: Register a device with the network
effect: write
questions:
- How do I register a device with the etherFAX network?
- What do I need to register a device, a serial number and a token?
instructions:
- text: Register device {id} with token {token}.
slots:
id: query.id
token: query.token
- text: Register device {id} with token {token} using profile {profile}.
slots:
id: query.id
token: query.token
profile: query.profile
method: generated
generated: '2026-11-19'
- target: $.paths['/devices?a=setaddr'].get
update:
x-apievangelist-phrasing:
intent: Set a device's local IP address
effect: write
questions:
- How do I report my device's local IP address?
- Can I set the IP address shown for a device?
instructions:
- text: Set this device's IP address to {addr}.
slots:
addr: query.addr
- text: Report the local IP address {addr} for the device.
slots:
addr: query.addr
method: generated
generated: '2026-11-19'
- target: $.paths['/devices?a=setconfig'].get
update:
x-apievangelist-phrasing:
intent: Set device configuration options
effect: write
questions:
- How do I change a device's configuration settings?
- Can I enable or disable features on a device remotely?
instructions:
- text: Set device configuration options {options}.
slots:
options: query.options
- text: Change the device's settings to {options}.
slots:
options: query.options
method: generated
generated: '2026-11-19'
- target: $.paths['/devices?a=status'].get
update:
x-apievangelist-phrasing:
intent: Get a device's status and settings
effect: read
questions:
- What is the current status of my device?
- Which settings does the authenticated device have?
instructions:
- text: Show the status of this device.
- text: Get the device's status using action {a}.
slots:
a: query.a
method: generated
generated: '2026-11-19'
- target: $.paths['/devices?a=unread'].get
update:
x-apievangelist-phrasing:
intent: Count unread faxes on a device
effect: read
questions:
- How many faxes are waiting for my device?
- Can I wait for a new fax to arrive on a device?
instructions:
- text: Count the unread faxes on this device.
- text: Wait {wait} seconds for a new fax on the device.
slots:
wait: query.wait
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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/etherfax-devices-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.