FMOps developer resources

Machine-readable files

Markdown from any page

fmops.ie follows the acceptmarkdown.com convention. Ask any page for text/markdown and you get the page content as markdown from the same URL, with the navigation, styles and scripts stripped out. Browsers are unaffected: they ask for text/html and get the page as normal.

curl -s -H "Accept: text/markdown" https://fmops.ie/automation

Responses carry Content-Type: text/markdown; charset=utf-8 and Vary: Accept, Accept-Encoding, so a cache can never hand you the wrong variant. A request that will accept neither HTML nor markdown gets 406 Not Acceptable. A path that does not exist gets a real 404 with a markdown body that points you at the files above, never a 200 with an app shell.

curl -sI -H "Accept: text/markdown" https://fmops.ie/about
curl -s -o /dev/null -w "%{http_code}\n" https://fmops.ie/no-such-page   # 404

The public API

Three endpoints are open to anyone. No key, no sign-up, and Access-Control-Allow-Origin: * on all of them, so they work from a browser. The full description, including every field, is in /openapi.json. Call the versioned paths: the unversioned form still works and always will, but /api/v1/… is the one to pin.

curl -s https://fmops.ie/api/v1/slots
curl -s https://fmops.ie/api/v1/testimonials

Everything else under /api/ is administrative and needs an X-Admin-Token header. Those endpoints are deliberately undocumented and are not open to the public.

Versioning and deprecation

Every public endpoint is served from a version prefix: /api/v1/…. That is the path to pin. The unversioned form, /api/slots, is a permanent alias of the current major version, kept working for callers written before the prefix existed.

Every API response carries API-Version: 1, so a client can assert on the version it is actually talking to rather than the one it meant to call.

The rules, so you can decide whether this is safe to build on:

• A breaking change gets a new prefix. /api/v2/…. It never changes what an existing prefix means.
• Additive changes happen inside v1. A new field, a new endpoint, a new optional parameter. Ignore fields you do not recognise and nothing will break.
• Nothing is removed without 12 months' notice.

When a version or an endpoint is on its way out, it is announced on the responses themselves, not only in prose:

Nothing is deprecated today, so no response carries those headers yet. An unknown version answers 404 with code: "not_found" and a hint naming the versions that do exist.

curl -sI https://fmops.ie/api/v1/slots | grep -i '^api-version'
curl -s https://fmops.ie/api/v9/slots      # 404, JSON, tells you v1 is what exists

Rate limits

Every response carries its own budget, so you can pace yourself instead of discovering the limit by hitting it. Both the IETF draft headers and the older trio are sent, because clients read one or the other.

The budgets: 600 reads an hour per IP address, and 5 checks an hour per IP address for POST /api/v1/ai-check, because each one asks several AI assistants a set of real questions.

One caveat worth knowing rather than finding out: read endpoints are cached at the edge for 60 to 300 seconds, so on a cache hit the live counters can be that much stale. RateLimit-Policy is always exact.

Errors

Every error is application/json, whatever went wrong — including a request to a path under /api/ that does not exist. You will never get an HTML error page or a bare NOT_FOUND from the hosting platform, because there is nothing useful in either for a program.

{
  "ok": false,
  "code": "not_found",
  "message": "No endpoint at /api/pricing.",
  "error": "No endpoint at /api/pricing.",
  "hint": "Public endpoints are versioned: try /api/v1/pricing. The full list is in https://fmops.ie/openapi.json.",
  "status": 404,
  "docs": "https://fmops.ie/developers",
  "spec": "https://fmops.ie/openapi.json"
}

Branch on code. It is the contract; message is written for a person and may be reworded. hint says what to do next. details appears on invalid_request and names the fields that were wrong.

The command-line tool

@fmops/cli wraps the API above so you do not have to write an integration to script against it. No dependencies, no key, no configuration.

npx @fmops/cli slots
npx @fmops/cli check "Riverside Physiotherapy" physiotherapist Waterford --email you@example.ie
npx @fmops/cli page /automation           # any page, as markdown
npx @fmops/cli doctor                     # reachability and the current rate-limit budget

Everything prints JSON on stdout except page and llms, which print markdown and plain text, so the output pipes into jq or into an agent. A failed request prints the API's own code, message and hint on stderr and exits non-zero. fmops help lists every command.

What FMOps does not publish

Being straight about the gaps saves you the search. There is no MCP server, no webhook subscription API, no OAuth, no SDK for any language beyond the CLI above, and no sandbox. If you need one of those for a real project, say so and I will tell you honestly whether it is worth building.

Terms and contact

Use of these endpoints is covered by the terms of service. Be reasonable with request rates: this is a one-person business on modest hosting. The exact budgets, and the headers that report them, are in Rate limits above.

API and developer questions go to fionn@fmops.ie, or see the contact page for phone and other options. FMOps is run by Fionn Murphy from Waterford, Ireland.