Convert CAD file with defaults
Path parameters
/{src_format}
"acis"+12▾- //ACIS part format.
"acis" - //CATIA part format.
"catia" - //PTC Creo part format.
"creo" - //Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>
"fbx" - //glTF 2.0.
"gltf" - //Autodesk Inventor part format.
"inventor" - //Siemens NX part format.
"nx" - //The OBJ file format. <https://en.wikipedia.org/wiki/Wavefront_.obj_file> It may or may not have an an attached material (mtl // mtllib) within the file, but we interact with it as if it does not.
"obj" - //Parasolid part format.
"parasolid" - //The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>
"ply" - //SolidWorks part (SLDPRT) format.
"sldprt" - //The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>
"step" - //The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
"stl"
///{output_format}
"fbx"+6▾- //Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>
"fbx" - //Binary glTF 2.0. This is a single binary with .glb extension. This is better if you want a compressed format as opposed to the human readable glTF that lacks compression.
"glb" - //glTF 2.0. Embedded glTF 2.0 (pretty printed). Single JSON file with .gltf extension binary data encoded as base64 data URIs. The JSON contents are pretty printed. It is human readable, single file, and you can view the diff easily in a git commit.
"gltf" - //The OBJ file format. <https://en.wikipedia.org/wiki/Wavefront_.obj_file> It may or may not have an an attached material (mtl // mtllib) within the file, but we interact with it as if it does not.
"obj" - //The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>
"ply" - //The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>
"step" - //The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
"stl"
//
HTTP Request
HTTP BodyBinary
Content-Type:application/octet
Response
- 201 Created
- //
completed_at:
stringISO-8601,//created_at:
stringISO-8601,//error:
string,//id:
stringUUID,//started_at:
stringISO-8601,//updated_at:
stringISO-8601,//user_id:
stringUUID,//output_format:
,"fbx"+6▾- //Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>
"fbx" - //Binary glTF 2.0. This is a single binary with .glb extension. This is better if you want a compressed format as opposed to the human readable glTF that lacks compression.
"glb" - //glTF 2.0. Embedded glTF 2.0 (pretty printed). Single JSON file with .gltf extension binary data encoded as base64 data URIs. The JSON contents are pretty printed. It is human readable, single file, and you can view the diff easily in a git commit.
"gltf" - //The OBJ file format. <https://en.wikipedia.org/wiki/Wavefront_.obj_file> It may or may not have an an attached material (mtl // mtllib) within the file, but we interact with it as if it does not.
"obj" - //The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>
"ply" - //The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>
"step" - //The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
"stl"
//:
,//- //
{
type:
"fbx",created:
stringISO-8601,//storage:
"ascii"+1▾- //ASCII FBX encoding.
"ascii" - //Binary FBX encoding.
"binary"
//
}
- //
{
type:
"gltf",presentation:
,"compact"+1▾- //Condense the JSON into the smallest possible size.
"compact" - //Expand the JSON into a more human readable format. This is the default setting.
"pretty"
//storage:
"binary"+2▾- //Binary glTF 2.0. This is a single binary with .glb extension.
"binary" - //Standard glTF 2.0. This is a JSON file with .gltf extension paired with a separate binary blob file with .bin extension.
"standard" - //Embedded glTF 2.0. Single JSON file with .gltf extension binary data encoded as base64 data URIs. This is the default setting.
"embedded"
//
}
- //
{
type:
"obj",:
{{ ... },//:
{{ ... },//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
:
{{ ... }//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
}
units:
"cm"+5▾- //Centimeters <https://en.wikipedia.org/wiki/Centimeter>
"cm" - //Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
"ft" - //Inches <https://en.wikipedia.org/wiki/Inch>
"in" - //Meters <https://en.wikipedia.org/wiki/Meter>
"m" - //Millimeters <https://en.wikipedia.org/wiki/Millimeter>
"mm" - //Yards <https://en.wikipedia.org/wiki/Yard>
"yd"
//
}
- //
{
type:
"ply",:
{{ ... },//:
{{ ... },//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
:
{{ ... }//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
}
:
,//- //
{
type:
"default_scene"
}
- //
{
type:
"mesh_by_index",index:
numberuint//
}
- //
{
type:
"mesh_by_name",name:
string//
}
- //
{
type:
"scene_by_index",index:
numberuint//
}
- //
{
type:
"scene_by_name",name:
string//
}
storage:
,"ascii"+2▾- //Write numbers in their ascii representation (e.g. -13, 6.28, etc.). Properties are separated by spaces and elements are separated by line breaks.
"ascii" - //Encode payload as binary using little endian.
"binary_little_endian" - //Encode payload as binary using big endian.
"binary_big_endian"
//units:
"cm"+5▾- //Centimeters <https://en.wikipedia.org/wiki/Centimeter>
"cm" - //Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
"ft" - //Inches <https://en.wikipedia.org/wiki/Inch>
"in" - //Meters <https://en.wikipedia.org/wiki/Meter>
"m" - //Millimeters <https://en.wikipedia.org/wiki/Millimeter>
"mm" - //Yards <https://en.wikipedia.org/wiki/Yard>
"yd"
//
}
- //
{
type:
"step",created:
stringISO-8601,//:
{{ ... },//:
{{ ... },//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
:
{{ ... }//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
}
presentation:
,"compact"+1▾- //Condenses the text to reduce the size of the file.
"compact" - //Add extra spaces to make the text more easily readable. This is the default setting.
"pretty"
//units:
"cm"+5▾- //Centimeters <https://en.wikipedia.org/wiki/Centimeter>
"cm" - //Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
"ft" - //Inches <https://en.wikipedia.org/wiki/Inch>
"in" - //Meters <https://en.wikipedia.org/wiki/Meter>
"m" - //Millimeters <https://en.wikipedia.org/wiki/Millimeter>
"mm" - //Yards <https://en.wikipedia.org/wiki/Yard>
"yd"
//
}
- //
{
type:
"stl",:
{{ ... },//:
{{ ... },//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
:
{{ ... }//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
}
:
,//- //
{
type:
"default_scene"
}
- //
{
type:
"mesh_by_index",index:
numberuint//
}
- //
{
type:
"mesh_by_name",name:
string//
}
- //
{
type:
"scene_by_index",index:
numberuint//
}
- //
{
type:
"scene_by_name",name:
string//
}
storage:
,"ascii"+1▾- //Plaintext encoding.
"ascii" - //Binary STL encoding. This is the default setting.
"binary"
//units:
"cm"+5▾- //Centimeters <https://en.wikipedia.org/wiki/Centimeter>
"cm" - //Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
"ft" - //Inches <https://en.wikipedia.org/wiki/Inch>
"in" - //Meters <https://en.wikipedia.org/wiki/Meter>
"m" - //Millimeters <https://en.wikipedia.org/wiki/Millimeter>
"mm" - //Yards <https://en.wikipedia.org/wiki/Yard>
"yd"
//
}
:
{{ ... },//[key]:
stringBASE64
}
src_format:
,"acis"+12▾- //ACIS part format.
"acis" - //CATIA part format.
"catia" - //PTC Creo part format.
"creo" - //Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>
"fbx" - //glTF 2.0.
"gltf" - //Autodesk Inventor part format.
"inventor" - //Siemens NX part format.
"nx" - //The OBJ file format. <https://en.wikipedia.org/wiki/Wavefront_.obj_file> It may or may not have an an attached material (mtl // mtllib) within the file, but we interact with it as if it does not.
"obj" - //Parasolid part format.
"parasolid" - //The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>
"ply" - //SolidWorks part (SLDPRT) format.
"sldprt" - //The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>
"step" - //The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
"stl"
//:
,//- //
{
type:
"acis",split_closed_faces:
boolean,//:
{{ ... }//:
{{ ... },//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
:
{{ ... }//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
}
}
- //
{
type:
"catia",split_closed_faces:
boolean,//:
{{ ... }//:
{{ ... },//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
:
{{ ... }//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
}
}
- //
{
type:
"creo",split_closed_faces:
boolean,//:
{{ ... }//:
{{ ... },//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
:
{{ ... }//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
}
}
- //
{
type:
"fbx"
}
- //
{
type:
"gltf"
}
- //
{
type:
"inventor",split_closed_faces:
boolean,//:
{{ ... }//:
{{ ... },//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
:
{{ ... }//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
}
}
- //
{
type:
"nx",split_closed_faces:
boolean,//:
{{ ... }//:
{{ ... },//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
:
{{ ... }//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
}
}
- //
{
type:
"obj",:
{{ ... },//:
{{ ... },//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
:
{{ ... }//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
}
units:
"cm"+5▾- //Centimeters <https://en.wikipedia.org/wiki/Centimeter>
"cm" - //Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
"ft" - //Inches <https://en.wikipedia.org/wiki/Inch>
"in" - //Meters <https://en.wikipedia.org/wiki/Meter>
"m" - //Millimeters <https://en.wikipedia.org/wiki/Millimeter>
"mm" - //Yards <https://en.wikipedia.org/wiki/Yard>
"yd"
//
}
- //
{
type:
"parasolid",split_closed_faces:
boolean,//:
{{ ... }//:
{{ ... },//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
:
{{ ... }//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
}
}
- //
{
type:
"ply",:
{{ ... },//:
{{ ... },//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
:
{{ ... }//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
}
units:
"cm"+5▾- //Centimeters <https://en.wikipedia.org/wiki/Centimeter>
"cm" - //Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
"ft" - //Inches <https://en.wikipedia.org/wiki/Inch>
"in" - //Meters <https://en.wikipedia.org/wiki/Meter>
"m" - //Millimeters <https://en.wikipedia.org/wiki/Millimeter>
"mm" - //Yards <https://en.wikipedia.org/wiki/Yard>
"yd"
//
}
- //
{
type:
"sldprt",split_closed_faces:
boolean,//:
{{ ... }//:
{{ ... },//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
:
{{ ... }//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
}
}
- //
{
type:
"step",split_closed_faces:
boolean,//:
{{ ... }//:
{{ ... },//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
:
{{ ... }//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
}
}
- //
{
type:
"stl",:
{{ ... },//:
{{ ... },//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
:
{{ ... }//axis:
,"y"+1▾- //'Y' axis.
"y" - //'Z' axis.
"z"
//direction:
"positive"+1▾- //Increasing numbers.
"positive" - //Decreasing numbers.
"negative"
//
}
}
units:
"cm"+5▾- //Centimeters <https://en.wikipedia.org/wiki/Centimeter>
"cm" - //Feet <https://en.wikipedia.org/wiki/Foot_(unit)>
"ft" - //Inches <https://en.wikipedia.org/wiki/Inch>
"in" - //Meters <https://en.wikipedia.org/wiki/Meter>
"m" - //Millimeters <https://en.wikipedia.org/wiki/Millimeter>
"mm" - //Yards <https://en.wikipedia.org/wiki/Yard>
"yd"
//
}
status:
"queued"+4▾- //The async API call is queued.
"queued" - //The async API call was uploaded to be converted.
"uploaded" - //The async API call is in progress.
"in_progress" - //The async API call has completed.
"completed" - //The async API call has failed.
"failed"
//
}
Examples
post
/file/conversion/{src_format}/{output_format}201 Created
Response