API → File → Convert CAD file with defaults

Parameters

Name

Type

Req.

output_format
string
required
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)>
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_format
  string
  optional
  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
  oneOf
  optional
  One of
  fbx
  object
  optional
  Object Properties
  storage
  string
  optional
  Possible values
  ascii: ASCII FBX encoding.
  binary: Binary FBX encoding.
  type
  string
  optional
  Possible values
  fbx
  gltf
  object
  optional
  Object Properties
  presentation
  string
  optional
  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.
  storage
  string
  optional
  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.
  type
  string
  optional
  Possible values
  gltf
  obj
  object
  optional
  Object Properties
  coords
  object
  optional
  Object Properties
  forward
  object
  optional
  Object Properties
  axis
  string
  optional
  Possible values
  y: 'Y' axis.
  z: 'Z' axis.
  direction
  string
  optional
  Possible values
  positive: Increasing numbers.
  negative: Decreasing numbers.
  up
  object
  optional
  Object Properties
  axis
  string
  optional
  Possible values
  y: 'Y' axis.
  z: 'Z' axis.
  direction
  string
  optional
  Possible values
  positive: Increasing numbers.
  negative: Decreasing numbers.
  type
  string
  optional
  Possible values
  obj
  units
  string
  optional
  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
  object
  optional
  Object Properties
  coords
  object
  optional
  Object Properties
  forward
  object
  optional
  Object Properties
  axis
  string
  optional
  Possible values
  y: 'Y' axis.
  z: 'Z' axis.
  direction
  string
  optional
  Possible values
  positive: Increasing numbers.
  negative: Decreasing numbers.
  up
  object
  optional
  Object Properties
  axis
  string
  optional
  Possible values
  y: 'Y' axis.
  z: 'Z' axis.
  direction
  string
  optional
  Possible values
  positive: Increasing numbers.
  negative: Decreasing numbers.
  selection
  oneOf
  optional
  One of
  default_scene
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  default_scene
  scene_by_index
  object
  optional
  Object Properties
  index
  integer
  optional
  type
  string
  optional
  Possible values
  scene_by_index
  scene_by_name
  object
  optional
  Object Properties
  name
  string
  optional
  type
  string
  optional
  Possible values
  scene_by_name
  mesh_by_index
  object
  optional
  Object Properties
  index
  integer
  optional
  type
  string
  optional
  Possible values
  mesh_by_index
  mesh_by_name
  object
  optional
  Object Properties
  name
  string
  optional
  type
  string
  optional
  Possible values
  mesh_by_name
  storage
  string
  optional
  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.
  type
  string
  optional
  Possible values
  ply
  units
  string
  optional
  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>
  step
  object
  optional
  Object Properties
  coords
  object
  optional
  Object Properties
  forward
  object
  optional
  Object Properties
  axis
  string
  optional
  Possible values
  y: 'Y' axis.
  z: 'Z' axis.
  direction
  string
  optional
  Possible values
  positive: Increasing numbers.
  negative: Decreasing numbers.
  up
  object
  optional
  Object Properties
  axis
  string
  optional
  Possible values
  y: 'Y' axis.
  z: 'Z' axis.
  direction
  string
  optional
  Possible values
  positive: Increasing numbers.
  negative: Decreasing numbers.
  type
  string
  optional
  Possible values
  step
  stl
  object
  optional
  Object Properties
  coords
  object
  optional
  Object Properties
  forward
  object
  optional
  Object Properties
  axis
  string
  optional
  Possible values
  y: 'Y' axis.
  z: 'Z' axis.
  direction
  string
  optional
  Possible values
  positive: Increasing numbers.
  negative: Decreasing numbers.
  up
  object
  optional
  Object Properties
  axis
  string
  optional
  Possible values
  y: 'Y' axis.
  z: 'Z' axis.
  direction
  string
  optional
  Possible values
  positive: Increasing numbers.
  negative: Decreasing numbers.
  selection
  oneOf
  optional
  One of
  default_scene
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  default_scene
  scene_by_index
  object
  optional
  Object Properties
  index
  integer
  optional
  type
  string
  optional
  Possible values
  scene_by_index
  scene_by_name
  object
  optional
  Object Properties
  name
  string
  optional
  type
  string
  optional
  Possible values
  scene_by_name
  mesh_by_index
  object
  optional
  Object Properties
  index
  integer
  optional
  type
  string
  optional
  Possible values
  mesh_by_index
  mesh_by_name
  object
  optional
  Object Properties
  name
  string
  optional
  type
  string
  optional
  Possible values
  mesh_by_name
  storage
  string
  optional
  Possible values
  ascii: Plaintext encoding.
  binary: Binary STL encoding. This is the default setting.
  type
  string
  optional
  Possible values
  stl
  units
  string
  optional
  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>
- outputs
  object
  optional
- 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)>
- src_format_options
  oneOf
  optional
  One of
  fbx
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  fbx
  gltf
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  gltf
  obj
  object
  optional
  Object Properties
  coords
  object
  optional
  Object Properties
  forward
  object
  optional
  Object Properties
  axis
  string
  optional
  Possible values
  y: 'Y' axis.
  z: 'Z' axis.
  direction
  string
  optional
  Possible values
  positive: Increasing numbers.
  negative: Decreasing numbers.
  up
  object
  optional
  Object Properties
  axis
  string
  optional
  Possible values
  y: 'Y' axis.
  z: 'Z' axis.
  direction
  string
  optional
  Possible values
  positive: Increasing numbers.
  negative: Decreasing numbers.
  type
  string
  optional
  Possible values
  obj
  units
  string
  optional
  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
  object
  optional
  Object Properties
  coords
  object
  optional
  Object Properties
  forward
  object
  optional
  Object Properties
  axis
  string
  optional
  Possible values
  y: 'Y' axis.
  z: 'Z' axis.
  direction
  string
  optional
  Possible values
  positive: Increasing numbers.
  negative: Decreasing numbers.
  up
  object
  optional
  Object Properties
  axis
  string
  optional
  Possible values
  y: 'Y' axis.
  z: 'Z' axis.
  direction
  string
  optional
  Possible values
  positive: Increasing numbers.
  negative: Decreasing numbers.
  type
  string
  optional
  Possible values
  ply
  units
  string
  optional
  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
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  sldprt
  step
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  step
  stl
  object
  optional
  Object Properties
  coords
  object
  optional
  Object Properties
  forward
  object
  optional
  Object Properties
  axis
  string
  optional
  Possible values
  y: 'Y' axis.
  z: 'Z' axis.
  direction
  string
  optional
  Possible values
  positive: Increasing numbers.
  negative: Decreasing numbers.
  up
  object
  optional
  Object Properties
  axis
  string
  optional
  Possible values
  y: 'Y' axis.
  z: 'Z' axis.
  direction
  string
  optional
  Possible values
  positive: Increasing numbers.
  negative: Decreasing numbers.
  type
  string
  optional
  Possible values
  stl
  units
  string
  optional
  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>
- 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/conversion/{src_format}/{output_format}

$ curl -X POST "https://api.zoo.dev/file/conversion/{src_format}/{output_format}" \
	--header "Authorization: Bearer $TOKEN" \
	--header "Content-Type: application/octet-stream" \
	--data-binary "@path/to/file"

201 Created

Response

{
  "completed_at": "2024-04-26T17:01:58.870Z",
  "created_at": "2024-04-26T17:01:58.870Z",
  "error": "OA6d4gQycJ4A02SLpLVAu0JebyhI",
  "id": "954a05ac-b523-43a2-9473-f6fa2be70287",
  "output_format": "ply",
  "output_format_options": {
    "coords": {
      "forward": {
        "axis": "z",
        "direction": "positive"
      },
      "up": {
        "axis": "z",
        "direction": "positive"
      }
    },
    "selection": {
      "type": "default_scene"
    },
    "storage": "ascii",
    "type": "stl",
    "units": "ft"
  },
  "outputs": {},
  "src_format": "fbx",
  "src_format_options": {
    "coords": {
      "forward": {
        "axis": "y",
        "direction": "negative"
      },
      "up": {
        "axis": "z",
        "direction": "negative"
      }
    },
    "type": "stl",
    "units": "m"
  },
  "started_at": "2024-04-26T17:01:58.870Z",
  "status": "completed",
  "updated_at": "2024-04-26T17:01:58.870Z",
  "user_id": "f94f8f77-a509-4549-80f4-1f5efa239b74"
}

API → File → Convert CAD file with defaults

Possible values

Possible values

bodyapplication/octet-stream

201 Created

Object Properties

Possible values

One of

Object Properties

Possible values

Possible values

Object Properties

Possible values

Possible values

Possible values

Object Properties

Object Properties

Object Properties

Possible values

Possible values

Object Properties

Possible values

Possible values

Possible values

Possible values

Object Properties

Object Properties

Object Properties

Possible values

Possible values

Object Properties

Possible values

Possible values

One of

Object Properties

Possible values

Object Properties

Possible values

Object Properties

Possible values

Object Properties

Possible values

Object Properties

Possible values

Possible values

Possible values

Possible values

Object Properties

Object Properties

Object Properties

Possible values

Possible values

Object Properties

Possible values

Possible values

Possible values

Object Properties

Object Properties

Object Properties

Possible values

Possible values

Object Properties

Possible values

Possible values

One of

Object Properties

Possible values

Object Properties

Possible values

Object Properties