Sign up

API → File → Get CAD file volume

Parameters

Name

Type

Req.

  • output_unit

    string
    required
    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>

  • src_format

    string
    required
    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)>

  • bodyapplication/octet-stream

    string / BINARY
    optional

Returns

  • 201 Created

    successful creation

    Name

    Type

    Req.

    body

    object
    optional
    Object Properties

    • completed_at

      string / ISO-8601
      optional

    • created_at

      string / ISO-8601
      optional

    • error

      string
      optional

    • id

      string / UUID
      optional

    • output_unit

      string
      optional
      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>

    • src_format

      string
      optional
      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)>

    • started_at

      string / ISO-8601
      optional

    • status

      string
      optional
      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.

    • updated_at

      string / ISO-8601
      optional

    • user_id

      string / UUID
      optional

    • volume

      number
      optional
post
/file/volume
$ curl -X POST "https://api.zoo.dev/file/volume" \
	--header "Authorization: Bearer $TOKEN" \
	--header "Content-Type: application/octet-stream" \
	--data-binary "@path/to/file"
201 Created
Response
{
  "completed_at": "2024-07-27T01:15:39.133Z",
  "created_at": "2024-07-27T01:15:39.133Z",
  "error": "1eWfSxsPjKgVPkswojpnJ",
  "id": "ffc8bf74-df84-4fd1-b899-fdcc81ce690a",
  "output_unit": "in3",
  "src_format": "ply",
  "started_at": "2024-07-27T01:15:39.133Z",
  "status": "in_progress",
  "updated_at": "2024-07-27T01:15:39.133Z",
  "user_id": "2c8f0c7c-98fe-4644-b9c8-8e1921b48b49",
  "volume": 21
}