API → File → Convert CAD file with defaults

Parameters

output_format
stringrequired
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
stringrequired
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)>
body
application/octet-streamstringBINARYoptional

Returns

201 Created

successful creation

object

Object

completed_at
stringISO-8601optional
created_at
stringISO-8601optional
error
stringoptional
id
stringUUIDoptional
output_format
stringoptional
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
oneOfoptional
One of
- fbx
  objectoptional
  Object
  - storage
    stringoptional
    Possible values
    - ascii: ASCII FBX encoding.
    - binary: Binary FBX encoding.
  - type
    stringoptional
    Possible values
    - fbx
- gltf
  objectoptional
  Object
  - presentation
    stringoptional
    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
    stringoptional
    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
    stringoptional
    Possible values
    - gltf
- obj
  objectoptional
  Object
  - coords
    objectoptional
    Object
    - forward
      objectoptional
      Object
      - axis
        stringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - direction
        stringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
    - up
      objectoptional
      Object
      - axis
        stringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - direction
        stringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
  - type
    stringoptional
    Possible values
    - obj
  - units
    stringoptional
    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
  objectoptional
  Object
  - coords
    objectoptional
    Object
    - forward
      objectoptional
      Object
      - axis
        stringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - direction
        stringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
    - up
      objectoptional
      Object
      - axis
        stringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - direction
        stringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
  - selection
    oneOfoptional
    One of
    - default_scene
      objectoptional
      Object
      - type
        stringoptional
        Possible values
        default_scene
    - scene_by_index
      objectoptional
      Object
      - index
        integeroptional
      - type
        stringoptional
        Possible values
        scene_by_index
    - scene_by_name
      objectoptional
      Object
      - name
        stringoptional
      - type
        stringoptional
        Possible values
        scene_by_name
    - mesh_by_index
      objectoptional
      Object
      - index
        integeroptional
      - type
        stringoptional
        Possible values
        mesh_by_index
    - mesh_by_name
      objectoptional
      Object
      - name
        stringoptional
      - type
        stringoptional
        Possible values
        mesh_by_name
  - storage
    stringoptional
    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
    stringoptional
    Possible values
    - ply
  - units
    stringoptional
    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
  objectoptional
  Object
  - coords
    objectoptional
    Object
    - forward
      objectoptional
      Object
      - axis
        stringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - direction
        stringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
    - up
      objectoptional
      Object
      - axis
        stringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - direction
        stringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
  - type
    stringoptional
    Possible values
    - step
- stl
  objectoptional
  Object
  - coords
    objectoptional
    Object
    - forward
      objectoptional
      Object
      - axis
        stringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - direction
        stringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
    - up
      objectoptional
      Object
      - axis
        stringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - direction
        stringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
  - selection
    oneOfoptional
    One of
    - default_scene
      objectoptional
      Object
      - type
        stringoptional
        Possible values
        default_scene
    - scene_by_index
      objectoptional
      Object
      - index
        integeroptional
      - type
        stringoptional
        Possible values
        scene_by_index
    - scene_by_name
      objectoptional
      Object
      - name
        stringoptional
      - type
        stringoptional
        Possible values
        scene_by_name
    - mesh_by_index
      objectoptional
      Object
      - index
        integeroptional
      - type
        stringoptional
        Possible values
        mesh_by_index
    - mesh_by_name
      objectoptional
      Object
      - name
        stringoptional
      - type
        stringoptional
        Possible values
        mesh_by_name
  - storage
    stringoptional
    Possible values
    - ascii: Plaintext encoding.
    - binary: Binary STL encoding. This is the default setting.
  - type
    stringoptional
    Possible values
    - stl
  - units
    stringoptional
    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
objectoptional
src_format
stringoptional
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
oneOfoptional
One of
- fbx
  objectoptional
  Object
  - type
    stringoptional
    Possible values
    - fbx
- gltf
  objectoptional
  Object
  - type
    stringoptional
    Possible values
    - gltf
- obj
  objectoptional
  Object
  - coords
    objectoptional
    Object
    - forward
      objectoptional
      Object
      - axis
        stringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - direction
        stringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
    - up
      objectoptional
      Object
      - axis
        stringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - direction
        stringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
  - type
    stringoptional
    Possible values
    - obj
  - units
    stringoptional
    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
  objectoptional
  Object
  - coords
    objectoptional
    Object
    - forward
      objectoptional
      Object
      - axis
        stringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - direction
        stringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
    - up
      objectoptional
      Object
      - axis
        stringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - direction
        stringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
  - type
    stringoptional
    Possible values
    - ply
  - units
    stringoptional
    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
  objectoptional
  Object
  - type
    stringoptional
    Possible values
    - sldprt
- step
  objectoptional
  Object
  - type
    stringoptional
    Possible values
    - step
- stl
  objectoptional
  Object
  - coords
    objectoptional
    Object
    - forward
      objectoptional
      Object
      - axis
        stringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - direction
        stringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
    - up
      objectoptional
      Object
      - axis
        stringoptional
        Possible values
        y: 'Y' axis.
        z: 'Z' axis.
      - direction
        stringoptional
        Possible values
        positive: Increasing numbers.
        negative: Decreasing numbers.
  - type
    stringoptional
    Possible values
    - stl
  - units
    stringoptional
    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
stringISO-8601optional
status
stringoptional
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
stringISO-8601optional
user_id
stringUUIDoptional

post/file/conversion/{src_format}/{output_format}

$ curl -X POST "https://api.kittycad.io/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": "2023-11-29T01:32:47.505Z",
  "created_at": "2023-11-29T01:32:47.505Z",
  "error": "50leUHGVk84c9UFouXqTT9peai",
  "id": "040d9592-85ed-4828-ad4e-e45916ee33bb",
  "output_format": "ply",
  "output_format_options": {
    "storage": "ascii",
    "type": "fbx"
  },
  "outputs": {},
  "src_format": "gltf",
  "src_format_options": {
    "type": "gltf"
  },
  "started_at": "2023-11-29T01:32:47.505Z",
  "status": "uploaded",
  "updated_at": "2023-11-29T01:32:47.505Z",
  "user_id": "363a7a75-b41d-4b51-a886-4fae4d19d6d0"
}

API → File → Convert CAD file with defaults

Possible values

Possible values

201 Created

Object

Possible values

One of

Object

Possible values

Possible values

Object

Possible values

Possible values

Possible values

Object

Object

Object

Possible values

Possible values

Object

Possible values

Possible values

Possible values

Possible values

Object

Object

Object

Possible values

Possible values

Object

Possible values

Possible values

One of

Object

Possible values

Object

Possible values

Object

Possible values

Object

Possible values

Object

Possible values

Possible values

Possible values

Possible values

Object

Object

Object

Possible values

Possible values

Object

Possible values

Possible values

Possible values

Object

Object

Object

Possible values

Possible values

Object

Possible values

Possible values

One of

Object

Possible values

Object

Possible values

Object

Possible values