Upload Model API

With the Upload Model API, you can upload a 3D model to our server. The API then analyses the model, returns a reference to the model to be used in other APIs, and calculates the dimensions and parameters of the uploaded model, namely,

• X, Y and Z dimensions;
• volume;
• surface area

It also returns ID of your model which can be used In Pricing APIs and Cart APIs.

The Upload Model API is for users who have an application or website that generates instant prices for models to be 3D printed.

If you want to use the Pricing APIs to calculate a price, the dimensions of the model or model ID are required. You can use the Upload Model API to get the dimensions of a specific model.

The returned reference to the uploaded model, the model ID, can be used in other APIs like the Cart Item Creation API.

Do you have questions about how your server should upload a 3D model? Our demo page should be able to help you . This page is connected to our production site and can be also used to test your tool ID.

The demo page of Upload Model API on production server:

https://i.materialise.com/api/demo/upload-model-api.html

Also, we’ve developed a sandbox server, which is an isolated server (not hooked up to a payment system or production environment, allowing you to test the service without getting billed) to try out your code and integration with us. This is different from our demo pages which are used to check if a particular API is working.

The demo page of Upload Model API on sandbox server:

https://imatsandbox.materialise.net/api/demo/upload-model-api.html

The Upload Model API works by posting data to our service.

You can use either XML or JSON formats for posting.

To specify the exact content type which your client can accept and parse, the Accept header in your request has to be set to one of the following content type:

• text/json
• application/json
• text/xml
• application/xml

The tool ID needs to be specified in the tool ID HTTP header. To upload a model and get parameters on production environment, POST request to:

https://i.materialise.com/web-api/tool/<toolID>/model

To use APIs of the sandbox, the POST needs to be submitted to:

https://imatsandbox.materialise.net/web-api/tool/<toolID>/model

Content-Type is multipart/form-data.

Request should consist of two parts:

• File (Content-Disposition: form-data; name=“file”; filename=“12.csv” Content-Type: application/octet-stream)
• File units (Content-Disposition: form-data; name=“fileUnits”)

The server will return a structured response in XML or JSON which your application can parse to retrieve model parameters and model ID.

The request could look like this (parameters names are case-sensitive):

 <Model xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ToolID>418674f3-f8a5-43bd-a06d-e8e95831b2d9</ToolID>
  <ModelID>cb8272c6-14fe-4ebf-bfab-520f6f39af17</ModelID>
  <ModelFileName>Box_inch.stl</ModelFileName>
  <FileUnits>inch</FileUnits>
  <XDimMm>645.1600000000</XDimMm>
  <YDimMm>645.1600000000</YDimMm>
  <ZDimMm>645.1600000000</ZDimMm>
  <VolumeCm3>268536.0000000000</VolumeCm3>
  <SurfaceCm2>24973.9000000000</SurfaceCm2>
  <ModelStatus>Succeeded</ModelStatus>
  <ValidUntil>2014-12-07T00:00:00+02:00</ValidUntil>
</Model>

{
    "toolID":"418674f3-f8a5-43bd-a06d-e8e95831b2d9",
    "modelID":"f2d1a0fe-2942-4db1-a828-0fdf21977b32",
    "modelFileName":"Box.stl",
    "fileUnits":"mm",
    "xDimMm":10,
    "yDimMm":10,
    "zDimMm":10,
    "volumeCm3":1,
    "surfaceCm2":6,
    "modelStatus":"succeeded",
    "validUntil":"2014-12-07T00:00:00+02:00"
} 

 <Model xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ToolID>418674f3-f8a5-43bd-a06d-e8e95831b2d9</ToolID>
  <ModelID>0ab3f316-5df4-4a77-a01d-46210943ac56</ModelID>
  <ModelFileName>2print_bad.stl</ModelFileName>
  <FileUnits>mm</FileUnits>
  <XDimMm>73.7159000000</XDimMm>
  <YDimMm>118.8810000000</YDimMm>
  <ZDimMm>27.3087000000</ZDimMm>
  <VolumeCm3>85.2411000000</VolumeCm3>
  <SurfaceCm2>354.9360000000</SurfaceCm2>
  <ModelStatus>StillNeedsFixing</ModelStatus>
  <ValidUntil>2014-12-07T00:00:00+02:00</ValidUntil>
  <Error>
    <Message>Cannot process the model. For details see Model Status.</Message>
    <Code>109</Code>
  </Error>
</Model>

   {
    "error":{
        "message":"Such toolID doesn’t exist.",
        "code":103
    }
}