Overview
/
Developer Tools
/
API Reference
/
File
/
Get CAD file volume.

Get CAD file volume

Query string 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_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"
    //

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,
        //
      • 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"
        //
      }

Examples

post
/file/volume
201 Created
Response