API → API Calls → Get an async operation
Parameters
Name
Type
Req.
Returns
- 200 OK
successful operation
Name
Type
Req.
body
oneOfoptionalOne of
file_conversion
objectoptionalObject Properties
Possible values
fbx
: Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>glb
: 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.gltf
: 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.obj
: 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.ply
: The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>step
: The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>stl
: The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
output_format_options
oneOfoptionalOne of
gltf
objectoptionalObject Properties
Possible values
compact
: Condense the JSON into the smallest possible size.pretty
: Expand the JSON into a more human readable format. This is the default setting.
Possible values
binary
: Binary glTF 2.0. This is a single binary with .glb extension.standard
: Standard glTF 2.0. This is a JSON file with .gltf extension paired with a separate binary blob file with .bin extension.embedded
: Embedded glTF 2.0. Single JSON file with .gltf extension binary data encoded as base64 data URIs. This is the default setting.
Possible values
gltf
obj
objectoptionalObject Properties
coords
objectoptionalObject Properties
Possible values
obj
Possible values
cm
: Centimeters <https://en.wikipedia.org/wiki/Centimeter>ft
: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>in
: Inches <https://en.wikipedia.org/wiki/Inch>m
: Meters <https://en.wikipedia.org/wiki/Meter>mm
: Millimeters <https://en.wikipedia.org/wiki/Millimeter>yd
: Yards <https://en.wikipedia.org/wiki/Yard>
ply
objectoptionalObject Properties
coords
objectoptionalObject Properties
selection
oneOfoptionalOne of
default_scene
objectoptionalObject Properties
Possible values
default_scene
scene_by_index
objectoptionalscene_by_name
objectoptionalmesh_by_index
objectoptionalmesh_by_name
objectoptional
Possible values
ascii
: Write numbers in their ascii representation (e.g. -13, 6.28, etc.). Properties are separated by spaces and elements are separated by line breaks.binary_little_endian
: Encode payload as binary using little endian.binary_big_endian
: Encode payload as binary using big endian.
Possible values
ply
Possible values
cm
: Centimeters <https://en.wikipedia.org/wiki/Centimeter>ft
: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>in
: Inches <https://en.wikipedia.org/wiki/Inch>m
: Meters <https://en.wikipedia.org/wiki/Meter>mm
: Millimeters <https://en.wikipedia.org/wiki/Millimeter>yd
: Yards <https://en.wikipedia.org/wiki/Yard>
stl
objectoptionalObject Properties
coords
objectoptionalObject Properties
selection
oneOfoptionalOne of
default_scene
objectoptionalObject Properties
Possible values
default_scene
scene_by_index
objectoptionalscene_by_name
objectoptionalmesh_by_index
objectoptionalmesh_by_name
objectoptional
Possible values
ascii
: Plaintext encoding.binary
: Binary STL encoding. This is the default setting.
Possible values
stl
Possible values
cm
: Centimeters <https://en.wikipedia.org/wiki/Centimeter>ft
: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>in
: Inches <https://en.wikipedia.org/wiki/Inch>m
: Meters <https://en.wikipedia.org/wiki/Meter>mm
: Millimeters <https://en.wikipedia.org/wiki/Millimeter>yd
: Yards <https://en.wikipedia.org/wiki/Yard>
Possible values
fbx
: Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>gltf
: glTF 2.0.obj
: 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.ply
: The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>sldprt
: SolidWorks part (SLDPRT) format.step
: The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>stl
: The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
src_format_options
oneOfoptionalOne of
obj
objectoptionalObject Properties
coords
objectoptionalObject Properties
Possible values
obj
Possible values
cm
: Centimeters <https://en.wikipedia.org/wiki/Centimeter>ft
: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>in
: Inches <https://en.wikipedia.org/wiki/Inch>m
: Meters <https://en.wikipedia.org/wiki/Meter>mm
: Millimeters <https://en.wikipedia.org/wiki/Millimeter>yd
: Yards <https://en.wikipedia.org/wiki/Yard>
ply
objectoptionalObject Properties
coords
objectoptionalObject Properties
Possible values
ply
Possible values
cm
: Centimeters <https://en.wikipedia.org/wiki/Centimeter>ft
: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>in
: Inches <https://en.wikipedia.org/wiki/Inch>m
: Meters <https://en.wikipedia.org/wiki/Meter>mm
: Millimeters <https://en.wikipedia.org/wiki/Millimeter>yd
: Yards <https://en.wikipedia.org/wiki/Yard>
sldprt
objectoptionalObject Properties
Possible values
sldprt
step
objectoptionalObject Properties
Possible values
step
stl
objectoptionalObject Properties
coords
objectoptionalObject Properties
Possible values
stl
Possible values
cm
: Centimeters <https://en.wikipedia.org/wiki/Centimeter>ft
: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>in
: Inches <https://en.wikipedia.org/wiki/Inch>m
: Meters <https://en.wikipedia.org/wiki/Meter>mm
: Millimeters <https://en.wikipedia.org/wiki/Millimeter>yd
: Yards <https://en.wikipedia.org/wiki/Yard>
Possible values
queued
: The async API call is queued.uploaded
: The async API call was uploaded to be converted.in_progress
: The async API call is in progress.completed
: The async API call has completed.failed
: The async API call has failed.
Possible values
file_conversion
file_center_of_mass
objectoptionalObject Properties
center_of_mass
objectoptionalPossible values
cm
: Centimeters <https://en.wikipedia.org/wiki/Centimeter>ft
: Feet <https://en.wikipedia.org/wiki/Foot_(unit)>in
: Inches <https://en.wikipedia.org/wiki/Inch>m
: Meters <https://en.wikipedia.org/wiki/Meter>mm
: Millimeters <https://en.wikipedia.org/wiki/Millimeter>yd
: Yards <https://en.wikipedia.org/wiki/Yard>
Possible values
fbx
: Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>gltf
: glTF 2.0.obj
: 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.ply
: The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>sldprt
: SolidWorks part (SLDPRT) format.step
: The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>stl
: The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
Possible values
queued
: The async API call is queued.uploaded
: The async API call was uploaded to be converted.in_progress
: The async API call is in progress.completed
: The async API call has completed.failed
: The async API call has failed.
Possible values
file_center_of_mass
file_mass
objectoptionalObject Properties
Possible values
lb:ft3
: Pounds per cubic feet.kg:m3
: Kilograms per cubic meter.
Possible values
g
: Grams <https://en.wikipedia.org/wiki/Gram>kg
: Kilograms <https://en.wikipedia.org/wiki/Kilogram>lb
: Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>
Possible values
fbx
: Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>gltf
: glTF 2.0.obj
: 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.ply
: The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>sldprt
: SolidWorks part (SLDPRT) format.step
: The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>stl
: The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
Possible values
queued
: The async API call is queued.uploaded
: The async API call was uploaded to be converted.in_progress
: The async API call is in progress.completed
: The async API call has completed.failed
: The async API call has failed.
Possible values
file_mass
file_volume
objectoptionalObject Properties
Possible values
cm3
: Cubic centimeters (cc or cm³) <https://en.wikipedia.org/wiki/Cubic_centimeter>ft3
: Cubic feet (ft³) <https://en.wikipedia.org/wiki/Cubic_foot>in3
: Cubic inches (cu in or in³) <https://en.wikipedia.org/wiki/Cubic_inch>m3
: Cubic meters (m³) <https://en.wikipedia.org/wiki/Cubic_meter>yd3
: Cubic yards (yd³) <https://en.wikipedia.org/wiki/Cubic_yard>usfloz
: US Fluid Ounces (fl oz) <https://en.wikipedia.org/wiki/Fluid_ounce>usgal
: US Gallons (gal US) <https://en.wikipedia.org/wiki/Gallon>l
: Liters (l) <https://en.wikipedia.org/wiki/Litre>ml
: Milliliters (ml) <https://en.wikipedia.org/wiki/Litre>
Possible values
fbx
: Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>gltf
: glTF 2.0.obj
: 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.ply
: The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>sldprt
: SolidWorks part (SLDPRT) format.step
: The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>stl
: The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
Possible values
queued
: The async API call is queued.uploaded
: The async API call was uploaded to be converted.in_progress
: The async API call is in progress.completed
: The async API call has completed.failed
: The async API call has failed.
Possible values
file_volume
file_density
objectoptionalObject Properties
Possible values
g
: Grams <https://en.wikipedia.org/wiki/Gram>kg
: Kilograms <https://en.wikipedia.org/wiki/Kilogram>lb
: Pounds <https://en.wikipedia.org/wiki/Pound_(mass)>
Possible values
lb:ft3
: Pounds per cubic feet.kg:m3
: Kilograms per cubic meter.
Possible values
fbx
: Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>gltf
: glTF 2.0.obj
: 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.ply
: The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>sldprt
: SolidWorks part (SLDPRT) format.step
: The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>stl
: The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
Possible values
queued
: The async API call is queued.uploaded
: The async API call was uploaded to be converted.in_progress
: The async API call is in progress.completed
: The async API call has completed.failed
: The async API call has failed.
Possible values
file_density
file_surface_area
objectoptionalObject Properties
Possible values
cm2
: Square centimeters <https://en.wikipedia.org/wiki/Square_centimeter>dm2
: Square decimeters <https://en.wikipedia.org/wiki/Square_decimeter>ft2
: Square feet <https://en.wikipedia.org/wiki/Square_foot>in2
: Square inches <https://en.wikipedia.org/wiki/Square_inch>km2
: Square kilometers <https://en.wikipedia.org/wiki/Square_kilometer>m2
: Square meters <https://en.wikipedia.org/wiki/Square_meter>mm2
: Square millimeters <https://en.wikipedia.org/wiki/Square_millimeter>yd2
: Square yards <https://en.wikipedia.org/wiki/Square_mile>
Possible values
fbx
: Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>gltf
: glTF 2.0.obj
: 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.ply
: The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>sldprt
: SolidWorks part (SLDPRT) format.step
: The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>stl
: The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
Possible values
queued
: The async API call is queued.uploaded
: The async API call was uploaded to be converted.in_progress
: The async API call is in progress.completed
: The async API call has completed.failed
: The async API call has failed.
Possible values
file_surface_area
text_to_cad
objectoptionalObject Properties
Possible values
thumbs_up
: Thumbs up.thumbs_down
: Thumbs down.accepted
: Accepted.rejected
: Rejected.
Possible values
cad
: CAD.kcl
: KCL.kcl_iteration
: KCL iteration.
Possible values
fbx
: Autodesk Filmbox (FBX) format. <https://en.wikipedia.org/wiki/FBX>glb
: 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.gltf
: 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.obj
: 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.ply
: The PLY file format. <https://en.wikipedia.org/wiki/PLY_(file_format)>step
: The STEP file format. <https://en.wikipedia.org/wiki/ISO_10303-21>stl
: The STL file format. <https://en.wikipedia.org/wiki/STL_(file_format)>
Possible values
queued
: The async API call is queued.uploaded
: The async API call was uploaded to be converted.in_progress
: The async API call is in progress.completed
: The async API call has completed.failed
: The async API call has failed.
Possible values
text_to_cad
text_to_cad_iteration
objectoptionalObject Properties
Possible values
thumbs_up
: Thumbs up.thumbs_down
: Thumbs down.accepted
: Accepted.rejected
: Rejected.
Possible values
cad
: CAD.kcl
: KCL.kcl_iteration
: KCL iteration.
Possible values
queued
: The async API call is queued.uploaded
: The async API call was uploaded to be converted.in_progress
: The async API call is in progress.completed
: The async API call has completed.failed
: The async API call has failed.
Possible values
text_to_cad_iteration
get
/async/operations/{id}$ curl "https://api.zoo.dev/async/operations/{id}" \
--header "Authorization: Bearer $TOKEN"
200 OK
Response{
"completed_at": "2024-09-07T21:56:22.584Z",
"created_at": "2024-09-07T21:56:22.584Z",
"error": "cO1QORWeryPYN3KvLH9sxl",
"id": "b338b6d9-b170-4050-bded-69b330061317",
"output_format": "gltf",
"output_format_options": {
"presentation": "compact",
"storage": "standard",
"type": "gltf"
},
"outputs": {},
"src_format": "stl",
"src_format_options": {
"type": "fbx"
},
"started_at": "2024-09-07T21:56:22.584Z",
"status": "queued",
"type": "file_conversion",
"updated_at": "2024-09-07T21:56:22.584Z",
"user_id": "73734f3e-bfe3-43b0-af92-f0595f0daa6b"
}