Midgard Industrial

API reference

Endpoints

Base URL https://midgardindustrial.aramous.com. JSON in and out. Errors are {"error": {"code", "message"}} with an HTTP status. The same calls as OpenAPI 3.1.

Search and page through the directory

GET /api/v1/suppliers

The website's directory search: keywords and filters, a page at a time. A search that finds nothing is run again with misspelt words put right; searched_for then shows the spelling used.

No key needed. MCP tool: search_suppliers.

Parameters

  • q query, stringWords to search for.
  • site query, "science" | "industrial"Defaults to the site this address serves.
  • category query, stringA category slug of that site.
  • region query, stringA state or province code as listings give it, e.g. CA or OH.
  • cert query, stringA certificate or standard, e.g. ISO 9001.
  • po query, "1"Only suppliers that take purchase orders.
  • page query, integer 1 to 1000Default 1.
  • per_page query, integer 1 to 100Default 50.
Example
curl "https://midgardindustrial.aramous.com/api/v1/suppliers?category=cnc-machining&per_page=5"
Answer, 200
{
  "object": "list",
  "total": 1,
  "page": 1,
  "per_page": 5,
  "data": [
    {
      "slug": "example-machine-works",
      "name": "Example Machine Works",
      "website": "https://shop.example.com",
      "description": "CNC machining and finishing shop.",
      "location": {
        "city": "Dayton",
        "region": "OH",
        "country": "US"
      },
      "sites": [
        "industrial"
      ],
      "categories": [
        "cnc-machining"
      ],
      "capabilities": [],
      "certifications": [
        "ISO 9001"
      ],
      "logo_url": null,
      "claimed": false,
      "verified": false,
      "badges": [],
      "services": [
        {
          "category": "cnc-machining",
          "name": "CNC machining",
          "price_from": null,
          "price_to": null,
          "currency": "USD",
          "price_unit": null,
          "turnaround_days": [
            null,
            null
          ],
          "accepts_po": null
        }
      ]
    }
  ]
}

Errors

  • 400invalid_requestpage or per_page out of range; unknown site; a category of another site.

One supplier

GET /api/v1/suppliers/{slug}

A listing in full: profile, services and listed prices, standards, public records (GLP, ownership, FDA FEI, CLIA where known), shared contact mailboxes with the page each is on, and ways to continue. A person's own address is never given.

No key needed. MCP tool: get_supplier.

Parameters

  • slug path, string, requiredFrom a search.
Example
curl https://midgardindustrial.aramous.com/api/v1/suppliers/example-machine-works
Answer, 200
{
  "object": "supplier",
  "slug": "example-machine-works",
  "name": "Example Machine Works",
  "website": "https://shop.example.com",
  "description": "CNC machining and finishing shop.",
  "location": {
    "city": "Dayton",
    "region": "OH",
    "country": "US",
    "address": null
  },
  "sites": [
    "industrial"
  ],
  "categories": [
    "cnc-machining"
  ],
  "capabilities": [],
  "certifications": [
    "ISO 9001"
  ],
  "logo_url": null,
  "claimed": false,
  "verified": false,
  "badges": [],
  "services": [
    {
      "category": "cnc-machining",
      "name": "CNC machining",
      "price_from": null,
      "price_to": null,
      "currency": "USD",
      "price_unit": null,
      "turnaround_days": [
        null,
        null
      ],
      "accepts_po": null
    }
  ],
  "url": "https://midgardindustrial.aramous.com/s/example-machine-works",
  "company_type": null,
  "founded": null,
  "team": null,
  "partner": false,
  "standards": [
    "ISO 9001"
  ],
  "offers": [
    {
      "name": "CNC machining",
      "description": null
    }
  ],
  "scope": {},
  "ordering": {},
  "quality": [],
  "sites_listed": [],
  "regions_served": [],
  "order_route": null,
  "contacts": [
    {
      "email": "info@example.com",
      "source_url": "https://shop.example.com/contact"
    }
  ],
  "ways": [
    {
      "way": "midgard",
      "title": "Through Midgard",
      "label": "Request a quote through Midgard",
      "note": "Midgard sends your request to the shop and keeps the order's messages, papers and payments in one place. Free to ask. 1% platform fee if you keep the order on Midgard.",
      "request": {
        "method": "POST",
        "path": "/api/v1/requests",
        "body": {
          "suppliers": [
            "example-machine-works"
          ]
        }
      }
    }
  ],
  "records": {
    "glp": null,
    "ownership": null,
    "fda_fei": null,
    "clia": null
  }
}

A listing with its own form, email or ordering service also has an own or provider way, listed first.

Errors

  • 404not_foundNo listed supplier with that slug on this site.

Sites, categories and request fields

GET /api/v1/categories

Each site, its categories and the spec fields a request in each takes, with required marked. Read it before creating a request.

No key needed. MCP tool: list_categories.

Example
curl https://midgardindustrial.aramous.com/api/v1/categories
Answer, 200
{
  "object": "list",
  "data": [
    {
      "site": "industrial",
      "name": "Midgard Industrial",
      "categories": [
        {
          "slug": "cnc-machining",
          "name": "CNC machining",
          "unit": "parts",
          "spec": [
            {
              "key": "material",
              "label": "Material",
              "type": "text",
              "required": true
            },
            {
              "key": "finish",
              "label": "Finish",
              "type": "text",
              "required": false
            }
          ]
        }
      ]
    }
  ]
}

Shortened to one category and two fields.

Email a sign-in code

POST /api/v1/auth/code

Mails a six-digit code to trade for a key. The answer is the same whether or not the address has been seen before. The code works once, for 10 minutes, with 5 tries; the two newest codes work.

No key needed. MCP tool: sign_in.

Parameters

  • email body, string, requiredThe address the key will act for.
Example
curl -X POST https://midgardindustrial.aramous.com/api/v1/auth/code \
  -H "Content-Type: application/json" \
  -d '{"email": "you@company.com"}'
Answer, 200
{
  "sent": true,
  "email": "you@company.com",
  "expires_in": 600,
  "message": "Check you@company.com for a six-digit code."
}

Errors

  • 400invalid_requestNot an email address.
  • 429rate_limitedToo many codes from this network, or for this address.

Limits: 10 codes an hour per network address, with lower limits per email address.

Trade the code for a key

POST /api/v1/auth/token

Returns an API key (mg_...) for the email. It is shown once; only its hash is kept. Anyone with it can order as that email.

No key needed. MCP tool: verify_code.

Parameters

  • email body, string, requiredThe same address.
  • code body, string, requiredThe six digits from the email.
  • label body, string, up to 80 charactersA name for the key, e.g. the tool that uses it.
Example
curl -X POST https://midgardindustrial.aramous.com/api/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{"email": "you@company.com", "code": "123456", "label": "ERP"}'
Answer, 201
{
  "object": "api_key",
  "key": "mg_…",
  "key_id": "key_Pc5uF3nJ8hV2",
  "prefix": "mg_ab12cd",
  "email": "you@company.com"
}

Errors

  • 400invalid_requestNo email or no code.
  • 400invalid_codeThe code is wrong.
  • 400code_expiredThe code has expired or was used; ask for a new one.
  • 429too_many_triesToo many wrong codes for this address; try again tomorrow.
  • 429rate_limitedMore than 30 tries an hour from this network.

Limits: 30 tries an hour per network address.

Who the key acts for

GET /api/v1/me

The email, the key in use and its webhook address.

Needs a key: Authorization: Bearer mg_... MCP tool: whoami.

Example
curl https://midgardindustrial.aramous.com/api/v1/me -H "Authorization: Bearer $KEY"
Answer, 200
{
  "object": "me",
  "email": "you@company.com",
  "key": {
    "id": "key_Pc5uF3nJ8hV2",
    "prefix": "mg_ab12cd",
    "label": "ERP",
    "created_at": "2026-11-17T09:00:00.000Z",
    "last_used_at": "2026-11-17T09:00:00.000Z"
  },
  "webhook_url": null
}

Errors

  • 401unauthorizedNo key, or a key that is wrong or revoked.
  • 429rate_limitedMore than 120 calls a minute with this key.

Limits: 120 calls a minute per key, shared by every keyed endpoint.

List keys

GET /api/v1/keys

The working keys for this email, newest first, by prefix and label. current marks the key in use.

Needs a key: Authorization: Bearer mg_...

Example
curl https://midgardindustrial.aramous.com/api/v1/keys -H "Authorization: Bearer $KEY"
Answer, 200
{
  "object": "list",
  "data": [
    {
      "object": "api_key",
      "id": "key_Pc5uF3nJ8hV2",
      "prefix": "mg_ab12cd",
      "label": "ERP",
      "created_at": "2026-11-17T09:00:00.000Z",
      "last_used_at": "2026-11-17T09:00:00.000Z",
      "current": true
    }
  ]
}

Errors

  • 401unauthorizedNo key, or a key that is wrong or revoked.
  • 429rate_limitedMore than 120 calls a minute with this key.

Limits: 120 calls a minute per key, shared by every keyed endpoint.

Revoke a key

DELETE /api/v1/keys/{id}

Revokes one of this email's keys, the one in use included.

Needs a key: Authorization: Bearer mg_...

Parameters

  • id path, string, requiredA key id from GET /api/v1/keys.
Example
curl -X DELETE https://midgardindustrial.aramous.com/api/v1/keys/key_Pc5uF3nJ8hV2 -H "Authorization: Bearer $KEY"
Answer, 200
{
  "object": "api_key",
  "id": "key_Pc5uF3nJ8hV2",
  "revoked": true
}

Errors

  • 401unauthorizedNo key, or a key that is wrong or revoked.
  • 429rate_limitedMore than 120 calls a minute with this key.
  • 404not_foundNo key with that id for this email.

Limits: 120 calls a minute per key, shared by every keyed endpoint.

Upload a file

POST /api/v1/uploads

A drawing, CAD file, sequence file, sample sheet or protocol. Put the returned url in a request's spec field.

Needs a key: Authorization: Bearer mg_...

Parameters

  • file form, file, up to 50 MB, requiredmultipart/form-data field file.
Example
curl -X POST https://midgardindustrial.aramous.com/api/v1/uploads -H "Authorization: Bearer $KEY" \
  -F "file=@drawing.pdf"
Answer, 201
{
  "object": "upload",
  "id": "upl_Lm2nB7vC4xZ9",
  "filename": "drawing.pdf",
  "size": 182044,
  "url": "https://midgardindustrial.aramous.com/f/…",
  "expires_at": "2026-12-17T09:00:00.000Z"
}

Errors

  • 401unauthorizedNo key, or a key that is wrong or revoked.
  • 429rate_limitedMore than 120 calls a minute with this key.
  • 400invalid_requestNo file field.
  • 400invalid_fileEmpty, larger than 50 MB, or a type that is not accepted.

Limits: 120 calls a minute per key, shared by every keyed endpoint.

Create a request

POST /api/v1/requests

A request for quotes, placed for the key's email. It starts as new with suggestions; nothing goes to any supplier until you confirm them with the confirm_labs action. Slugs named in suppliers are pre-selected (listed first) but are not asked until confirm_labs; a slug this site does not list is refused with a 400. status_url is a page a person can open. Spec values must be real: placeholders such as ... or TBD are refused.

Needs a key: Authorization: Bearer mg_... MCP tool: create_request.

Parameters

  • site body, "science" | "industrial", requiredThe site.
  • category body, string, requiredA category slug of that site.
  • title body, string, up to 160 characters, requiredA short title for the work.
  • spec body, objectThe category's spec fields, key to value. See GET /api/v1/categories.
  • quantity body, integerCounted in the category's unit (parts for CNC machining).
  • details body, stringAnything else suppliers should know.
  • needed_by body, stringA date, e.g. 2027-01-15.
  • supplier body, stringOne preferred supplier slug.
  • suppliers body, array of up to 20 slugsPre-select these suppliers. They are asked only when you run confirm_labs. An unknown slug is refused.
  • organization, country, budget, contact_name body, stringOptional details for suppliers.
  • Idempotency-Key header, stringA retry with the same value returns the request already created.
Example
curl -X POST https://midgardindustrial.aramous.com/api/v1/requests -H "Authorization: Bearer $KEY" \
  -H "Idempotency-Key: my-order-123" \
  -H "Content-Type: application/json" \
  -d '{"site":"industrial","category":"cnc-machining","title":"50 anodized 6061 aluminum brackets","spec":{"material":"6061-T6 aluminum","finish":"anodized black","export_control":"No controlled data"},"quantity":50,"needed_by":"2027-01-15"}'
Answer, 201
{
  "id": "req_Xq3v9KpL2aB7",
  "object": "request",
  "site": "industrial",
  "category": "cnc-machining",
  "title": "50 anodized 6061 aluminum brackets",
  "spec": {
    "material": "6061-T6 aluminum",
    "finish": "anodized black",
    "export_control": "No controlled data"
  },
  "quantity": 50,
  "details": null,
  "needed_by": "2027-01-15",
  "status": "new",
  "created_at": "2026-11-17T09:00:00.000Z",
  "updated_at": "2026-11-17T09:00:00.000Z",
  "quotes": [],
  "status_url": "https://midgardindustrial.aramous.com/r/req_Xq3v9KpL2aB7?t=…"
}

Errors

  • 401unauthorizedNo key, or a key that is wrong or revoked.
  • 429rate_limitedMore than 120 calls a minute with this key.
  • 400invalid_jsonThe body is not a JSON object.
  • 400invalid_requestAn unknown site or category, a missing required field, a placeholder value, or an email other than the key's. The message names the field.
  • 500server_errorThe request could not be created; retry with the same Idempotency-Key.

Limits: 120 calls a minute per key, shared by every keyed endpoint.

List your requests

GET /api/v1/requests

Requests placed with this key's email, newest first, including those placed on the website. Page with starting_after.

Needs a key: Authorization: Bearer mg_... MCP tool: list_requests.

Parameters

  • status query, stringOne status or several, comma-separated: new, sourcing, quoted, accepted, paid, in_progress, delivered, closed, cancelled, introduced.
  • site query, stringOnly this site's requests.
  • limit query, integer 1 to 100Default 100.
  • starting_after query, stringThe last id of the previous page.
Example
curl "https://midgardindustrial.aramous.com/api/v1/requests?status=quoted,delivered&limit=20" -H "Authorization: Bearer $KEY"
Answer, 200
{
  "object": "list",
  "data": [
    {
      "id": "req_Xq3v9KpL2aB7",
      "object": "request",
      "site": "industrial",
      "category": "cnc-machining",
      "title": "50 anodized 6061 aluminum brackets",
      "spec": {
        "material": "6061-T6 aluminum",
        "finish": "anodized black",
        "export_control": "No controlled data"
      },
      "quantity": 50,
      "details": null,
      "needed_by": "2027-01-15",
      "status": "quoted",
      "created_at": "2026-11-17T09:00:00.000Z",
      "updated_at": "2026-11-17T09:00:00.000Z",
      "quotes": []
    }
  ],
  "has_more": false,
  "next_starting_after": null
}

Errors

  • 401unauthorizedNo key, or a key that is wrong or revoked.
  • 429rate_limitedMore than 120 calls a minute with this key.
  • 400invalid_requestAn unknown status or site, limit out of range, or a starting_after id that is not yours.

Limits: 120 calls a minute per key, shared by every keyed endpoint.

One request

GET /api/v1/requests/{id}

Status, suggested suppliers (supplier_id for confirm_labs), the suppliers asked, quotes with the ways you can continue with each, milestones, change orders, payments, shipments, files and the timeline. A file the supplier delivered has from: "supplier".

Needs a key: Authorization: Bearer mg_... MCP tool: get_request.

Parameters

  • id path, string, requiredreq_...
Example
curl https://midgardindustrial.aramous.com/api/v1/requests/req_Xq3v9KpL2aB7 -H "Authorization: Bearer $KEY"
Answer, 200
{
  "id": "req_Xq3v9KpL2aB7",
  "object": "request",
  "site": "industrial",
  "category": "cnc-machining",
  "title": "50 anodized 6061 aluminum brackets",
  "spec": {
    "material": "6061-T6 aluminum",
    "finish": "anodized black",
    "export_control": "No controlled data"
  },
  "quantity": 50,
  "details": null,
  "needed_by": "2027-01-15",
  "status": "quoted",
  "created_at": "2026-11-17T09:00:00.000Z",
  "updated_at": "2026-11-17T09:00:00.000Z",
  "quotes": [
    {
      "id": "qt_Hn4sD8wQ1zR6",
      "object": "quote",
      "price": 4800,
      "currency": "USD",
      "turnaround_days": 15,
      "valid_until": "2026-12-17T00:00:00.000Z",
      "terms": null,
      "status": "sent",
      "payment_url": null,
      "paid": false,
      "lab": {
        "slug": "example-machine-works",
        "name": "Example Machine Works"
      },
      "lab_price": 4800,
      "fee": null,
      "shipping": null,
      "schedule": null,
      "ways": [
        {
          "way": "own",
          "accept": {
            "method": "POST",
            "path": "/api/v1/quotes/qt_Hn4sD8wQ1zR6/accept",
            "body": {
              "continue": "own"
            }
          }
        }
      ]
    }
  ],
  "mode": null,
  "scope_of_work": [],
  "suggestions": [
    {
      "supplier_id": "sup_Tb6yE2mC9kW1",
      "slug": "example-machine-works",
      "name": "Example Machine Works",
      "reasons": [
        "Its profile lists this service."
      ],
      "picked": true
    }
  ],
  "labs": [
    {
      "rfq_id": "rfq_Gd8kM1sP5tY3",
      "slug": "example-machine-works",
      "name": "Example Machine Works",
      "status": "quoted",
      "state": "quoted",
      "sent_at": "2026-11-17T09:00:00.000Z"
    }
  ],
  "milestones": [],
  "change_orders": [],
  "payments": [],
  "shipments": [],
  "files": [],
  "events": [
    {
      "type": "status",
      "status": "quoted",
      "message": "Quoted",
      "created_at": "2026-11-17T09:00:00.000Z"
    }
  ]
}

Shortened: each way also has a title, label and note.

Errors

  • 401unauthorizedNo key, or a key that is wrong or revoked.
  • 429rate_limitedMore than 120 calls a minute with this key.
  • 404not_foundNo request with that id for this key's email.

Limits: 120 calls a minute per key, shared by every keyed endpoint.

The timeline

GET /api/v1/requests/{id}/events

The request's public timeline, oldest first. Poll with since to get only what is new.

Needs a key: Authorization: Bearer mg_...

Parameters

  • id path, string, requiredreq_...
  • since query, date-timeOnly events after this time.
Example
curl "https://midgardindustrial.aramous.com/api/v1/requests/req_Xq3v9KpL2aB7/events?since=2026-11-01T00:00:00Z" -H "Authorization: Bearer $KEY"
Answer, 200
{
  "object": "list",
  "request_status": "quoted",
  "data": [
    {
      "id": "evt_Rw7cN2hK6pQ4",
      "type": "status",
      "status": "quoted",
      "message": "Quoted",
      "created_at": "2026-11-17T09:00:00.000Z"
    }
  ]
}

Errors

  • 401unauthorizedNo key, or a key that is wrong or revoked.
  • 429rate_limitedMore than 120 calls a minute with this key.
  • 404not_foundNo request with that id for this key's email.

Limits: 120 calls a minute per key, shared by every keyed endpoint.

Read the messages

GET /api/v1/requests/{id}/messages

The thread, oldest first: what you sent (from: "you") and the updates and supplier questions passed on to you (from: "midgard").

Needs a key: Authorization: Bearer mg_... MCP tool: get_messages.

Parameters

  • id path, string, requiredreq_...
Example
curl https://midgardindustrial.aramous.com/api/v1/requests/req_Xq3v9KpL2aB7/messages -H "Authorization: Bearer $KEY"
Answer, 200
{
  "object": "list",
  "request_id": "req_Xq3v9KpL2aB7",
  "data": [
    {
      "id": "evt_Ys1fV8bT3mD5",
      "object": "message",
      "from": "you",
      "message": "Samples ship on Monday.",
      "created_at": "2026-11-17T09:00:00.000Z"
    }
  ]
}

Errors

  • 401unauthorizedNo key, or a key that is wrong or revoked.
  • 429rate_limitedMore than 120 calls a minute with this key.
  • 404not_foundNo request with that id for this key's email.

Limits: 120 calls a minute per key, shared by every keyed endpoint.

Send a message

POST /api/v1/requests/{id}/messages

An answer to a supplier's question, or more detail. It is passed on.

Needs a key: Authorization: Bearer mg_... MCP tool: send_message.

Parameters

  • id path, string, requiredreq_...
  • message body, string, up to 4000 characters, requiredThe text.
Example
curl -X POST https://midgardindustrial.aramous.com/api/v1/requests/req_Xq3v9KpL2aB7/messages -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "Samples ship on Monday."}'
Answer, 201
{
  "object": "message",
  "request_id": "req_Xq3v9KpL2aB7",
  "message": "Samples ship on Monday."
}

Errors

  • 401unauthorizedNo key, or a key that is wrong or revoked.
  • 429rate_limitedMore than 120 calls a minute with this key.
  • 404not_foundNo request with that id for this key's email.
  • 400invalid_requestNo message.

Limits: 120 calls a minute per key, shared by every keyed endpoint.

Act on a request

POST /api/v1/requests/{id}/actions

Everything the order page does, one body per action: confirm_labs (status new: send the request to supplierIds from suggestions, or slugs), set_acceptance, answer_question (rfqId, answer), choose_managed and choose_direct (the same as accepting a quote), add_shipment, pay (paymentId: returns a card payment link), decide_change (changeId, approve), accept_results and request_rerun (reason) once delivered, request_release (storage). The OpenAPI description has the schema of each body.

Needs a key: Authorization: Bearer mg_... MCP tool: request_action.

Parameters

  • id path, string, requiredreq_...
  • action body, string, requiredOne of the actions above; the other fields depend on it.
Example
curl -X POST https://midgardindustrial.aramous.com/api/v1/requests/req_Xq3v9KpL2aB7/actions -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"action":"confirm_labs","supplierIds":["sup_Tb6yE2mC9kW1"]}'
Answer, 200
{
  "ok": true,
  "contacted": 1
}

confirm_labs returns contacted; choose_managed and pay return paymentUrl (null when invoiced); choose_direct returns introducedTo.

Errors

  • 401unauthorizedNo key, or a key that is wrong or revoked.
  • 429rate_limitedMore than 120 calls a minute with this key.
  • 404not_foundNo request with that id for this key's email.
  • 400invalid_requestThe action does not fit the request's status, or a field is missing. The message says which.
  • 500server_errorThe action failed; check the request before retrying.

Limits: 120 calls a minute per key, shared by every keyed endpoint.

Accept a quote

POST /api/v1/quotes/{id}/accept

continue: "midgard" keeps the order on the site under the order terms (/terms): terms_name is the name of the person accepting them. The answer carries payment_url for the first card payment, or with po each payment is invoiced. continue: "own" takes the quote to the supplier directly, with no platform fee: your contact details go to the supplier and theirs appear on the timeline.

Needs a key: Authorization: Bearer mg_... MCP tool: accept_quote.

Parameters

  • id path, string, requiredqt_..., from GET /api/v1/requests/{id}.
  • continue body, "midgard" | "own", requiredHow the person continues.
  • terms_name body, stringRequired with "midgard": the name of the person accepting the order terms.
  • po body, stringA purchase order number; payments are then invoiced.
  • billing_email body, stringWhere invoices go, if not the key's email.
  • revision body, stringParts: the file revision the order is built to, e.g. Rev C.
Example
curl -X POST https://midgardindustrial.aramous.com/api/v1/quotes/qt_Hn4sD8wQ1zR6/accept -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"continue": "own"}'
Answer, 200
{
  "id": "qt_Hn4sD8wQ1zR6",
  "object": "quote",
  "price": 4800,
  "currency": "USD",
  "turnaround_days": 15,
  "valid_until": "2026-12-17T00:00:00.000Z",
  "terms": null,
  "status": "sent",
  "payment_url": null,
  "paid": false,
  "continue": "own",
  "supplier": "Example Machine Works"
}

Errors

  • 401unauthorizedNo key, or a key that is wrong or revoked.
  • 429rate_limitedMore than 120 calls a minute with this key.
  • 404not_foundNo quote with that id on this email's requests.
  • 400invalid_requestNo continue, no terms_name for "midgard", or the quote can no longer be accepted.
  • 500server_errorThe quote could not be accepted; check the request before retrying.

Limits: 120 calls a minute per key, shared by every keyed endpoint.

Cancel a request

POST /api/v1/requests/{id}/cancel

Cancels a request that is not yet paid or under way; open quotes are withdrawn. Cancelling a cancelled request returns the same answer.

Needs a key: Authorization: Bearer mg_... MCP tool: cancel_request.

Parameters

  • id path, string, requiredreq_...
  • reason body, stringOptional.
Example
curl -X POST https://midgardindustrial.aramous.com/api/v1/requests/req_Xq3v9KpL2aB7/cancel -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"reason": "Ordered elsewhere"}'
Answer, 200
{
  "object": "request",
  "id": "req_Xq3v9KpL2aB7",
  "status": "cancelled"
}

Errors

  • 401unauthorizedNo key, or a key that is wrong or revoked.
  • 429rate_limitedMore than 120 calls a minute with this key.
  • 404not_foundNo request with that id for this key's email.
  • 409not_cancellableAlready paid or under way.

Limits: 120 calls a minute per key, shared by every keyed endpoint.

Read the webhook address

GET /api/v1/webhook

The callback address set for this key.

Needs a key: Authorization: Bearer mg_...

Example
curl https://midgardindustrial.aramous.com/api/v1/webhook -H "Authorization: Bearer $KEY"
Answer, 200
{
  "object": "webhook",
  "url": null
}

Errors

  • 401unauthorizedNo key, or a key that is wrong or revoked.
  • 429rate_limitedMore than 120 calls a minute with this key.

Limits: 120 calls a minute per key, shared by every keyed endpoint.

Set the webhook address

PUT /api/v1/webhook

Callbacks for requests placed with this key: request.quoted, request.status_changed, request.message. Each is a JSON POST {id, type, created_at, data: {request_id, ...}} with a Webhook-Signature: t=<seconds>,v1=<hex> header, where v1 is HMAC-SHA256 of <t>.<raw body> keyed with the secret. The secret is returned once; setting the address again makes a new one. {"url": null} stops callbacks.

Needs a key: Authorization: Bearer mg_...

Parameters

  • url body, string | null, requiredAn https address on a public host.
Example
curl -X PUT https://midgardindustrial.aramous.com/api/v1/webhook -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/hooks/orders"}'
Answer, 200
{
  "object": "webhook",
  "url": "https://example.com/hooks/orders",
  "secret": "whsec_…"
}

Errors

  • 401unauthorizedNo key, or a key that is wrong or revoked.
  • 429rate_limitedMore than 120 calls a minute with this key.
  • 400invalid_requestNot an https address on a public host.

Limits: 120 calls a minute per key, shared by every keyed endpoint.

Stop callbacks

DELETE /api/v1/webhook

Removes the address and its secret.

Needs a key: Authorization: Bearer mg_...

Example
curl -X DELETE https://midgardindustrial.aramous.com/api/v1/webhook -H "Authorization: Bearer $KEY"
Answer, 200
{
  "object": "webhook",
  "url": null
}

Errors

  • 401unauthorizedNo key, or a key that is wrong or revoked.
  • 429rate_limitedMore than 120 calls a minute with this key.

Limits: 120 calls a minute per key, shared by every keyed endpoint.

OpenAPI description

GET /api/v1/openapi.json

OpenAPI 3.1 for every endpoint here, with a schema for each body. Also listed at /.well-known/api-catalog.

No key needed.

Example
curl https://midgardindustrial.aramous.com/api/v1/openapi.json
Answer, 200
{
  "openapi": "3.1.0",
  "info": {
    "title": "Ordering API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://midgardindustrial.aramous.com"
    }
  ],
  "paths": {}
}

Shortened.

API reference · Midgard Industrial