API → FileGet CAD file surface area

Parameters

Name

Type

Req.

  • output_unit

    string
    required
    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>
  • 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
      • 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>
    • 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.
    • surface_area

      number
      optional
    • updated_at

      string / ISO-8601
      optional
    • user_id

      string / UUID
      optional
post
/file/surface-area
$ curl -X POST "https://api.zoo.dev/file/surface-area" \
	--header "Authorization: Bearer $TOKEN" \
	--header "Content-Type: application/octet-stream" \
	--data-binary "@path/to/file"
201 Created
Response
{
  "completed_at": "2024-07-19T17:28:11.299Z",
  "created_at": "2024-07-19T17:28:11.299Z",
  "error": "waD0",
  "id": "4d3f1379-a8d2-488c-8d84-199207117c53",
  "output_unit": "mm2",
  "src_format": "obj",
  "started_at": "2024-07-19T17:28:11.300Z",
  "status": "uploaded",
  "surface_area": 24,
  "updated_at": "2024-07-19T17:28:11.300Z",
  "user_id": "3fb42cc4-bd38-4238-a88a-3f80a6be47e7"
}