Create a catalogue model

Requires a model file URL that the AMFG servers can download: any public or pre-signed HTTPS link to a CAD file (STL, STEP, OBJ, …) — e.g. from your own storage/CDN or an S3/Azure pre-signed URL. Non-public sources can pass auth via modelEndpoint.headers. To reuse a file already in AMFG, take a download URL from GET /model-version?ticketModelId=....

POST/catalogue-model

Authorization

AuthorizationAPI key · headerrequired

The Incoming Secret value (<secretId>.<random>), with or without a Bearer prefix.

Request body

application/json

namestringrequired

Catalogue model name.

customIdstring

Custom catalogue model id.

modelEndpointobjectrequired

Where management-service downloads the model file from.

Show properties

urlstringrequired

Downloadable model file URL.

headersobjectrequired

Headers sent with the download request.

fileNamestring

Explicit name for the downloaded file, e.g. "bracket.stl". Takes precedence over the name derived from the url — set it when the url does not end in a clean file name (download endpoints, long pre-signed urls).

configurationsobject[]required

Production parameter sets the model can be ordered with.

Show properties

Array of object

quantityintegerrequired

Number of units.

productionParametersobjectrequired

Production parameters keyed by parameter name.

productionParameterIdsobjectrequired

Production parameter ids keyed by parameter name.

Responses

200

Created. Returns only the id — fetch the full Catalogue Model (Part Catalogue) with the corresponding GET.

idinteger | stringrequired

Id of the created Catalogue Model (Part Catalogue).

Show properties

One of:

integer

integer

string

string

401

Authentication failed. All causes return this identical response.

codeinteger

messagestring

typestring

default

Downstream errors pass through verbatim; x-error-source names the failing service.

codeinteger

messagestring

typestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X POST 'https://next.amfg.ai/engine-service/public-api/v1/catalogue-model' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "customId": "string",
  "modelEndpoint": {
    "url": "string",
    "headers": {},
    "fileName": "string"
  },
  "configurations": [
    {
      "quantity": 0,
      "productionParameters": {},
      "productionParameterIds": {}
    }
  ]
}'

const response = await fetch("https://next.amfg.ai/engine-service/public-api/v1/catalogue-model", {
  method: "POST",
  headers: {
    "Authorization": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"customId\": \"string\",\n  \"modelEndpoint\": {\n    \"url\": \"string\",\n    \"headers\": {},\n    \"fileName\": \"string\"\n  },\n  \"configurations\": [\n    {\n      \"quantity\": 0,\n      \"productionParameters\": {},\n      \"productionParameterIds\": {}\n    }\n  ]\n}"
});

import requests

response = requests.post(
    "https://next.amfg.ai/engine-service/public-api/v1/catalogue-model",
    headers={
        "Authorization": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"customId\": \"string\",\n  \"modelEndpoint\": {\n    \"url\": \"string\",\n    \"headers\": {},\n    \"fileName\": \"string\"\n  },\n  \"configurations\": [\n    {\n      \"quantity\": 0,\n      \"productionParameters\": {},\n      \"productionParameterIds\": {}\n    }\n  ]\n}",
)

Response

{
  "id": 0
}

{
  "code": 401,
  "message": "Not Authorized"
}

{
  "code": 0,
  "message": "string",
  "type": "string"
}