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

Get a model version

GET/model-version/{id}
Authorization
AuthorizationAPI key · headerrequired

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

Path parameters
idstringrequired
Responses
200

OK. A missing id returns 200 with an empty body — check for an id in the response.

idstring

Model version ID

appIdstring

Application ID

ticketModelIdstring

Ticket model ID

versionnumber

Version number

downloadLinkstring

Download link for the model file

fileNamestring

Model file name

ticketIdstring

Ticket ID; presented only for MC pricing calculation

widthnumber

Model width

heightnumber

Model height

depthnumber

Model depth

volumenumber

Model volume

surfacenumber

Model surface area

shellsCountnumber

Number of shells

isBadOrientationboolean

Whether the model has bad orientation

isClosedboolean

Whether the model mesh is closed

intersectionsnumber

Number of intersections

openEdgesnumber

Number of open edges

sharpEdgesnumber

Number of sharp edges

shrinkWrapVolumenumber

Resolved only after engine.modelVersionFieldsResolve; otherwise may be null

supportVolumenumber

Resolved only after engine.modelVersionFieldsResolve; otherwise may be null

supportZMinimisedVolumenumber

Resolved only after engine.modelVersionFieldsResolve; otherwise may be null

minimisedBoundingBoxVolumenumber

Resolved only after engine.modelVersionFieldsResolve; otherwise may be null

featuresany[]

Recognized model features (objects with id, cls, type, boundary, blendTop, blendBottom, reference, productionTime, productionTimeError)

productionParameterIdsobject

Production parameter IDs keyed by parameter name, e.g. Technology, Machine, Material, Resolution, Post Processing Services, Colour

confidencenumber

Percentage (min 0, max 100)

geometricSupportVolumenumber

Raw volume of generated supports without the volume of the model itself

surfacesWithoutFeaturesAreanumber

Area of the model surface without any feature/surface type recognized

surfacesWithoutFeaturesAreaPercentagenumber

Percent of the model surface without any feature/surface type recognized

totalUniqueDirectionsnumber

Number of unique cross products (machining directions) across all feature types

turnabilityScorenumber

Suitability for turning: < 0.4 not turnable, < 0.7 mill-turn, >= 0.7 turning

turningAxisstring

"X", "Y", "Z" or "N/A" (if model is not turnable)

uniqueDirectionsChamfernumber

Unique machining directions across all chamfers

uniqueDirectionsCounterborednumber

Unique machining directions across all counterbored holes

uniqueDirectionsCountersinknumber

Unique machining directions across all countersink holes

uniqueDirectionsDrillednumber

Unique machining directions across all drilled holes

uniqueDirectionsFilletnumber

Unique machining directions across all fillets

uniqueDirectionsHolenumber

Unique machining directions across all regular holes

uniqueDirectionsPlanenumber

Unique machining directions across all planes

uniqueDirectionsPocketnumber

Unique machining directions across all pockets

uniqueDirectionsSlotnumber

Unique machining directions across all slots

serviceSuggeststring

Most suitable machining service: "turning", "mill_turn_hybrid", "3_axis_milling", "4_axis_milling", "5_axis_milling" or "N/A"

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
Authorization
Parameters
Request
curl -X GET 'https://next.amfg.ai/engine-service/public-api/v1/model-version/string' \
  -H 'Authorization: YOUR_API_KEY'
Response
{
  "id": 1000,
  "appId": 1677,
  "ticketModelId": 1000,
  "version": 1,
  "downloadLink": "http://dev.com/storage-service/api/v1/node/99/download?token=...",
  "ticketId": 1024,
  "fileName": "10x20x40.stl",
  "width": 6.98077321052551,
  "height": 2.57206296920776,
  "depth": 11.3494510650635,
  "volume": 48.9682761570541,
  "surface": 137.06684728091,
  "shellsCount": 1,
  "isBadOrientation": false,
  "isClosed": true,
  "intersections": 0,
  "openEdges": 0,
  "sharpEdges": 619,
  "shrinkWrapVolume": null,
  "supportVolume": null,
  "supportZMinimisedVolume": null,
  "minimisedBoundingBoxVolume": null,
  "features": [
    {
      "id": 1,
      "cls": "machine",
      "type": "plane",
      "blendTop": {
        "type": "none"
      },
      "boundary": {
        "type": "profile",
        "xAxis": [
          0.9995616518113103,
          0,
          0.029605814095293313
        ],
        "yAxis": [
          -0.0005499994128993887,
          0.9998274249863216,
          0.018569268856564347
        ],
        "origin": [
          -0.2333089255724967,
          -0.1464247593588291,
          7.877055982211335
        ],
        "profile": {
          "arcs": 0,
          "area": 10.703771359995272,
          "edges": 4,
          "closed": 1,
          "length": 16.640544921409745,
          "numLoops": 1
        }
      },
      "reference": [
        -0.02960070487152085,
        -0.018577412231566597,
        0.9993891524455764
      ],
      "blendBottom": {
        "type": "none"
      },
      "productionTime": 10,
      "productionTimeError": null
    }
  ]
}