Skip to content
Public API
Esc
↑↓navigate↵open⌘Jpreview
On this page

AMFG Public API

REST surface exposing the AMFG Engine entities to external integrations.

Authentication

One header, one credential — an Incoming Secret created through the console (Settings → API Keys) or POST /api/v1/secret. The value (<secretId>.<random>) is shown once on create and sent on every call:

Authorization: <secret>          # a "Bearer " prefix is also accepted

Every authentication failure returns an identical 401 {"code":401,"message":"Not Authorized"} with no distinction of cause. Secrets created before the Public API shipped cannot authenticate here — regenerate them.

Conventions

  • Retrieves are filtered lists: a missing id returns 200 with an empty body, not 404 — check for an id in the response.
  • List filters are query parameters; repeatable parameters build arrays (?ids=1&ids=2). Date filters accept a single date or a range (?createdAt[from]=…&createdAt[to]=…).
  • Updates are whole-record, not patches — omitting a field the schema requires is a 400 naming it.
  • Downstream errors pass through verbatim (status, code, message, type), and x-error-source / x-error-source-request-id headers name the failing service — quote them in support tickets.
  • Every authenticated call is metered.

Field-level entity semantics: AMFG Engine API Reference.

MCP

The same operations for quotes, tickets and parts are exposed as 9 MCP tools at POST /mcp (Model Context Protocol, 2026-07-28 spec, same Authorization header) — see the MCP tag.

Version 1.0.0
Base URLhttps://next.amfg.ai/engine-service/public-api/v1

Apps

Blanks

Catalogue Models

Catalogues

Colours

Currencys

Customers

Items

MCP

Machine Groups

Machines

Material Series

Materials

Meeting Notes

Model Versions

PPS

Parts (ticket models)

Production Notes

Production Parameter Fields

Projects (orders)

Quotation Form Regions

Quotation Forms

Quotes

Reels

Report Metricss

Service jobs

Services

Suppliers

Technologies

Tickets

Users