Get an async operation
Path parameters
/{id}
stringUUID//
Response
- 200 OK
- //
{
type:
"file_center_of_mass",completed_at:
stringISO-8601,//created_at:
stringISO-8601,//error:
string,//id:
stringUUID,//started_at:
stringISO-8601,//updated_at:
stringISO-8601,//user_id:
stringUUID,//:
{{ ... },//x:
numberfloat,y:
numberfloat,z:
numberfloat
}
output_unit:
,"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"
//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"
//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"
//
}
- //
{
type:
"file_conversion",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"
//
}
- //
{
type:
"file_density",completed_at:
stringISO-8601,//created_at:
stringISO-8601,//density:
numberdouble,//error:
string,//id:
stringUUID,//material_mass:
numberdouble,//started_at:
stringISO-8601,//updated_at:
stringISO-8601,//user_id:
stringUUID,//material_mass_unit:
,"g"+2▾- //Grams <https://en.wikipedia.org/wiki/Gram>
"g" - //Kilograms <https://en.wikipedia.org/wiki/Kilogram>
"kg" - //Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>
"lb"
//output_unit:
,"lb:ft3"+1▾- //Pounds per cubic feet.
"lb:ft3" - //Kilograms per cubic meter.
"kg:m3"
//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"
//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"
//
}
- //
{
type:
"file_mass",completed_at:
stringISO-8601,//created_at:
stringISO-8601,//error:
string,//id:
stringUUID,//mass:
numberdouble,//material_density:
numberdouble,//started_at:
stringISO-8601,//updated_at:
stringISO-8601,//user_id:
stringUUID,//material_density_unit:
,"lb:ft3"+1▾- //Pounds per cubic feet.
"lb:ft3" - //Kilograms per cubic meter.
"kg:m3"
//output_unit:
,"g"+2▾- //Grams <https://en.wikipedia.org/wiki/Gram>
"g" - //Kilograms <https://en.wikipedia.org/wiki/Kilogram>
"kg" - //Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>
"lb"
//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"
//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"
//
}
- //
{
type:
"file_surface_area",completed_at:
stringISO-8601,//created_at:
stringISO-8601,//error:
string,//id:
stringUUID,//started_at:
stringISO-8601,//surface_area:
numberdouble,//updated_at:
stringISO-8601,//user_id:
stringUUID,//output_unit:
,"cm2"+7▾- //Square centimeters <https://en.wikipedia.org/wiki/Square_centimeter>
"cm2" - //Square decimeters <https://en.wikipedia.org/wiki/Square_decimeter>
"dm2" - //Square feet <https://en.wikipedia.org/wiki/Square_foot>
"ft2" - //Square inches <https://en.wikipedia.org/wiki/Square_inch>
"in2" - //Square kilometers <https://en.wikipedia.org/wiki/Square_kilometer>
"km2" - //Square meters <https://en.wikipedia.org/wiki/Square_meter>
"m2" - //Square millimeters <https://en.wikipedia.org/wiki/Square_millimeter>
"mm2" - //Square yards <https://en.wikipedia.org/wiki/Square_mile>
"yd2"
//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"
//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"
//
}
- //
{
type:
"file_volume",completed_at:
stringISO-8601,//created_at:
stringISO-8601,//error:
string,//id:
stringUUID,//started_at:
stringISO-8601,//updated_at:
stringISO-8601,//user_id:
stringUUID,//volume:
numberdouble,//output_unit:
,"mm3"+9▾- //Cubic millimeters (mm³)
"mm3" - //Cubic centimeters (cc or cm³) <https://en.wikipedia.org/wiki/Cubic_centimeter>
"cm3" - //Cubic feet (ft³) <https://en.wikipedia.org/wiki/Cubic_foot>
"ft3" - //Cubic inches (cu in or in³) <https://en.wikipedia.org/wiki/Cubic_inch>
"in3" - //Cubic meters (m³) <https://en.wikipedia.org/wiki/Cubic_meter>
"m3" - //Cubic yards (yd³) <https://en.wikipedia.org/wiki/Cubic_yard>
"yd3" - //US Fluid Ounces (fl oz) <https://en.wikipedia.org/wiki/Fluid_ounce>
"usfloz" - //US Gallons (gal US) <https://en.wikipedia.org/wiki/Gallon>
"usgal" - //Liters (l) <https://en.wikipedia.org/wiki/Litre>
"l" - //Milliliters (ml) <https://en.wikipedia.org/wiki/Litre>
"ml"
//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"
//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"
//
}
- //
{
type:
"text_to_cad",code:
string,//completed_at:
stringISO-8601,//conversation_id:
stringUUID,//created_at:
stringISO-8601,//error:
string,//id:
stringUUID,//kcl_version:
string,//model_version:
string,//prompt:
string,//started_at:
stringISO-8601,//updated_at:
stringISO-8601,//user_id:
stringUUID,//feedback:
,"thumbs_up"+3▾- //Thumbs up.
"thumbs_up" - //Thumbs down.
"thumbs_down" - //Accepted.
"accepted" - //Rejected.
"rejected"
//model:
,"cad"+2▾- //CAD.
"cad" - //KCL.
"kcl" - //KCL iteration.
"kcl_iteration"
//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"
//:
{{ ... },//[key]:
stringBASE64
}
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"
//
}
- //
{
type:
"text_to_cad_iteration",code:
string,//completed_at:
stringISO-8601,//conversation_id:
stringUUID,//created_at:
stringISO-8601,//error:
string,//id:
stringUUID,//model_version:
string,//original_source_code:
string,//prompt:
string,//started_at:
stringISO-8601,//updated_at:
stringISO-8601,//user_id:
stringUUID,//feedback:
,"thumbs_up"+3▾- //Thumbs up.
"thumbs_up" - //Thumbs down.
"thumbs_down" - //Accepted.
"accepted" - //Rejected.
"rejected"
//model:
,"cad"+2▾- //CAD.
"cad" - //KCL.
"kcl" - //KCL iteration.
"kcl_iteration"
//:
[[ ... ],//- //
file:
string,//prompt:
string,//:
{{ ... }//:
{{ ... },//column:
numberuint32,//line:
numberuint32//
}
:
{{ ... }//column:
numberuint32,//line:
numberuint32//
}
}
}
]
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"
//
}
- //
{
type:
"text_to_cad_multi_file_iteration",completed_at:
stringISO-8601,//conversation_id:
stringUUID,//created_at:
stringISO-8601,//error:
string,//id:
stringUUID,//kcl_version:
string,//model_version:
string,//project_name:
string,//prompt:
string,//started_at:
stringISO-8601,//updated_at:
stringISO-8601,//user_id:
stringUUID,//feedback:
,"thumbs_up"+3▾- //Thumbs up.
"thumbs_up" - //Thumbs down.
"thumbs_down" - //Accepted.
"accepted" - //Rejected.
"rejected"
//model:
,"cad"+2▾- //CAD.
"cad" - //KCL.
"kcl" - //KCL iteration.
"kcl_iteration"
//:
{{ ... },//[key]:
string
}
:
[[ ... ],//- //
file:
string,//prompt:
string,//:
{{ ... }//:
{{ ... },//column:
numberuint32,//line:
numberuint32//
}
:
{{ ... }//column:
numberuint32,//line:
numberuint32//
}
}
}
]
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
get
/async/operations/{id}200 OK
Response