API → FileGet CAD file density

Parameters

Name

Type

Req.

  • material_mass

    number
    required
  • material_mass_unit

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

    string
    required
    Possible values
    • lb:ft3:  Pounds per cubic feet.
    • kg:m3:  Kilograms per cubic meter.
  • 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
    • density

      number
      optional
    • error

      string
      optional
    • id

      string / UUID
      optional
    • material_mass

      number
      optional
    • material_mass_unit

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

      string
      optional
      Possible values
      • lb:ft3:  Pounds per cubic feet.
      • kg:m3:  Kilograms per cubic meter.
    • 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
post
/file/density
$ curl -X POST "https://api.zoo.dev/file/density" \
	--header "Authorization: Bearer $TOKEN" \
	--header "Content-Type: application/octet-stream" \
	--data-binary "@path/to/file"
201 Created
Response
{
  "completed_at": "2024-07-12T16:21:38.865Z",
  "created_at": "2024-07-12T16:21:38.865Z",
  "density": 16,
  "error": "045uQL8FE3IUNX51jN5hsnYBXZy4K",
  "id": "35044211-9bda-4ae3-988e-f617af70c52e",
  "material_mass": 17,
  "material_mass_unit": "lb",
  "output_unit": "lb:ft3",
  "src_format": "step",
  "started_at": "2024-07-12T16:21:38.866Z",
  "status": "queued",
  "updated_at": "2024-07-12T16:21:38.866Z",
  "user_id": "0823b272-d2bd-4d62-8c00-85c33df033c1"
}