API → Modeling → Open a websocket which accepts modeling commands
beta

Parameters

Name

Type

Req.

fps
integer
required
pool
string
optional
post_effect
string
required
Possible values
- phosphor
- ssao
- noeffect
unlocked_framerate
boolean
required
video_res_height
integer
required
video_res_width
integer
required
webrtc
boolean
required
bodyapplication/json
oneOf
optional
One of
- trickle_ice
  object
  optional
  Object Properties
  candidate
  object
  required
  Object Properties
  candidate
  string
  optional
  sdpMLineIndex
  integer
  optional
  sdpMid
  string
  optional
  usernameFragment
  string
  optional
  type
  string
  optional
  Possible values
  trickle_ice
- sdp_offer
  object
  optional
  Object Properties
  offer
  object
  optional
  Object Properties
  sdp
  string
  optional
  type
  string
  optional
  Possible values
  unspecified: Unspecified indicates that the type is unspecified.
  offer: indicates that a description MUST be treated as an SDP offer.
  pranswer: indicates that a description MUST be treated as an SDP answer, but not a final answer. A description used as an SDP pranswer may be applied as a response to an SDP offer, or an update to a previously sent SDP pranswer.
  answer: indicates that a description MUST be treated as an SDP final answer, and the offer-answer exchange MUST be considered complete. A description used as an SDP answer may be applied as a response to an SDP offer or as an update to a previously sent SDP pranswer.
  rollback: indicates that a description MUST be treated as canceling the current SDP negotiation and moving the SDP offer and answer back to what it was in the previous stable state. Note the local or remote SDP descriptions in the previous stable state could be null if there has not yet been a successful offer-answer negotiation.
  type
  string
  optional
  Possible values
  sdp_offer
- modeling_cmd_req
  object
  optional
  Object Properties
  cmd
  oneOf
  optional
  One of
  start_path
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  start_path
  move_path_pen
  object
  optional
  Object Properties
  path
  string / UUID
  optional
  to
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  move_path_pen
  extend_path
  object
  optional
  Object Properties
  path
  string / UUID
  optional
  segment
  oneOf
  optional
  One of
  line
  object
  optional
  Object Properties
  end
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  relative
  boolean
  optional
  type
  string
  optional
  Possible values
  line
  arc
  object
  optional
  Object Properties
  center
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  end
  object
  optional
  Object Properties
  unit
  string
  optional
  Possible values
  degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
  radians: Radians <https://en.wikipedia.org/wiki/Radian>
  value
  number
  optional
  radius
  number
  optional
  relative
  boolean
  optional
  start
  object
  optional
  Object Properties
  unit
  string
  optional
  Possible values
  degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
  radians: Radians <https://en.wikipedia.org/wiki/Radian>
  value
  number
  optional
  type
  string
  optional
  Possible values
  arc
  bezier
  object
  optional
  Object Properties
  control1
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  control2
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  end
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  relative
  boolean
  optional
  type
  string
  optional
  Possible values
  bezier
  tangential_arc
  object
  optional
  Object Properties
  offset
  object
  optional
  Object Properties
  unit
  string
  optional
  Possible values
  degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
  radians: Radians <https://en.wikipedia.org/wiki/Radian>
  value
  number
  optional
  radius
  number
  optional
  type
  string
  optional
  Possible values
  tangential_arc
  tangential_arc_to
  object
  optional
  Object Properties
  angle_snap_increment
  object
  optional
  Object Properties
  unit
  string
  optional
  Possible values
  degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
  radians: Radians <https://en.wikipedia.org/wiki/Radian>
  value
  number
  optional
  to
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  tangential_arc_to
  type
  string
  optional
  Possible values
  extend_path
  extrude
  object
  optional
  Object Properties
  cap
  boolean
  optional
  distance
  number
  optional
  target
  string / UUID
  optional
  type
  string
  optional
  Possible values
  extrude
  revolve
  object
  optional
  Object Properties
  angle
  object
  optional
  Object Properties
  unit
  string
  optional
  Possible values
  degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
  radians: Radians <https://en.wikipedia.org/wiki/Radian>
  value
  number
  optional
  axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  axis_is_2d
  boolean
  optional
  origin
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  target
  string / UUID
  optional
  tolerance
  number
  optional
  type
  string
  optional
  Possible values
  revolve
  revolve_about_edge
  object
  optional
  Object Properties
  angle
  object
  optional
  Object Properties
  unit
  string
  optional
  Possible values
  degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
  radians: Radians <https://en.wikipedia.org/wiki/Radian>
  value
  number
  optional
  edge_id
  string / UUID
  optional
  target
  string / UUID
  optional
  tolerance
  number
  optional
  type
  string
  optional
  Possible values
  revolve_about_edge
  close_path
  object
  optional
  Object Properties
  path_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  close_path
  camera_drag_start
  object
  optional
  Object Properties
  interaction
  string
  optional
  Possible values
  pan: Camera pan
  rotate: Camera rotate (revolve/orbit)
  zoom: Camera zoom (increase or decrease distance to reference point center)
  type
  string
  optional
  Possible values
  camera_drag_start
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  camera_drag_move
  object
  optional
  Object Properties
  interaction
  string
  optional
  Possible values
  pan: Camera pan
  rotate: Camera rotate (revolve/orbit)
  zoom: Camera zoom (increase or decrease distance to reference point center)
  sequence
  integer
  optional
  type
  string
  optional
  Possible values
  camera_drag_move
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  camera_drag_end
  object
  optional
  Object Properties
  interaction
  string
  optional
  Possible values
  pan: Camera pan
  rotate: Camera rotate (revolve/orbit)
  zoom: Camera zoom (increase or decrease distance to reference point center)
  type
  string
  optional
  Possible values
  camera_drag_end
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  default_camera_get_settings
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  default_camera_get_settings
  default_camera_look_at
  object
  optional
  Object Properties
  center
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  sequence
  integer
  optional
  type
  string
  optional
  Possible values
  default_camera_look_at
  up
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  vantage
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  default_camera_perspective_settings
  object
  optional
  Object Properties
  center
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  fov_y
  number
  optional
  sequence
  integer
  optional
  type
  string
  optional
  Possible values
  default_camera_perspective_settings
  up
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  vantage
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  z_far
  number
  optional
  z_near
  number
  optional
  default_camera_zoom
  object
  optional
  Object Properties
  magnitude
  number
  optional
  type
  string
  optional
  Possible values
  default_camera_zoom
  export
  object
  optional
  Object Properties
  entity_ids
  array
  optional
  format
  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>
  type
  string
  optional
  Possible values
  export
  entity_get_parent_id
  object
  optional
  Object Properties
  entity_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  entity_get_parent_id
  entity_get_num_children
  object
  optional
  Object Properties
  entity_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  entity_get_num_children
  entity_get_child_uuid
  object
  optional
  Object Properties
  child_index
  integer
  optional
  entity_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  entity_get_child_uuid
  entity_get_all_child_uuids
  object
  optional
  Object Properties
  entity_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  entity_get_all_child_uuids
  entity_get_distance
  object
  optional
  Object Properties
  distance_type
  oneOf
  optional
  One of
  euclidean
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  euclidean
  on_axis
  object
  optional
  Object Properties
  axis
  string
  optional
  Possible values
  x: The X axis
  y: The Y axis
  z: The Z axis
  type
  string
  optional
  Possible values
  on_axis
  entity_id1
  string / UUID
  optional
  entity_id2
  string / UUID
  optional
  type
  string
  optional
  Possible values
  entity_get_distance
  entity_linear_pattern
  object
  optional
  Object Properties
  axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  entity_id
  string / UUID
  optional
  num_repetitions
  integer
  optional
  spacing
  number
  optional
  type
  string
  optional
  Possible values
  entity_linear_pattern
  entity_circular_pattern
  object
  optional
  Object Properties
  arc_degrees
  number
  optional
  axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  center
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  entity_id
  string / UUID
  optional
  num_repetitions
  integer
  optional
  rotate_duplicates
  boolean
  optional
  type
  string
  optional
  Possible values
  entity_circular_pattern
  entity_make_helix
  object
  optional
  Object Properties
  cylinder_id
  string / UUID
  optional
  is_clockwise
  boolean
  optional
  length
  number
  optional
  revolutions
  number
  optional
  start_angle
  object
  optional
  Object Properties
  unit
  string
  optional
  Possible values
  degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
  radians: Radians <https://en.wikipedia.org/wiki/Radian>
  value
  number
  optional
  type
  string
  optional
  Possible values
  entity_make_helix
  entity_mirror
  object
  optional
  Object Properties
  axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  ids
  array
  optional
  point
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  entity_mirror
  edit_mode_enter
  object
  optional
  Object Properties
  target
  string / UUID
  optional
  type
  string
  optional
  Possible values
  edit_mode_enter
  select_with_point
  object
  optional
  Object Properties
  selected_at_window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  selection_type
  string
  optional
  Possible values
  replace: Replaces the selection
  add: Adds to the selection
  remove: Removes from the selection
  type
  string
  optional
  Possible values
  select_with_point
  select_add
  object
  optional
  Object Properties
  entities
  array
  optional
  type
  string
  optional
  Possible values
  select_add
  select_remove
  object
  optional
  Object Properties
  entities
  array
  optional
  type
  string
  optional
  Possible values
  select_remove
  scene_clear_all
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  scene_clear_all
  select_replace
  object
  optional
  Object Properties
  entities
  array
  optional
  type
  string
  optional
  Possible values
  select_replace
  highlight_set_entity
  object
  optional
  Object Properties
  selected_at_window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  sequence
  integer
  optional
  type
  string
  optional
  Possible values
  highlight_set_entity
  highlight_set_entities
  object
  optional
  Object Properties
  entities
  array
  optional
  type
  string
  optional
  Possible values
  highlight_set_entities
  new_annotation
  object
  optional
  Object Properties
  annotation_type
  string
  optional
  Possible values
  t2d: 2D annotation type (screen or planar space)
  t3d: 3D annotation type
  clobber
  boolean
  optional
  options
  object
  optional
  Object Properties
  color
  object
  optional
  Object Properties
  a
  number
  optional
  b
  number
  optional
  g
  number
  optional
  r
  number
  optional
  line_ends
  object
  optional
  Object Properties
  end
  string
  optional
  Possible values
  none
  arrow
  start
  string
  optional
  Possible values
  none
  arrow
  line_width
  number
  optional
  position
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  text
  object
  required
  Object Properties
  point_size
  integer
  optional
  text
  string
  optional
  x
  string
  optional
  Possible values
  left
  center
  right
  y
  string
  optional
  Possible values
  bottom
  center
  top
  type
  string
  optional
  Possible values
  new_annotation
  update_annotation
  object
  optional
  Object Properties
  annotation_id
  string / UUID
  optional
  options
  object
  optional
  Object Properties
  color
  object
  optional
  Object Properties
  a
  number
  optional
  b
  number
  optional
  g
  number
  optional
  r
  number
  optional
  line_ends
  object
  optional
  Object Properties
  end
  string
  optional
  Possible values
  none
  arrow
  start
  string
  optional
  Possible values
  none
  arrow
  line_width
  number
  optional
  position
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  text
  object
  required
  Object Properties
  point_size
  integer
  optional
  text
  string
  optional
  x
  string
  optional
  Possible values
  left
  center
  right
  y
  string
  optional
  Possible values
  bottom
  center
  top
  type
  string
  optional
  Possible values
  update_annotation
  edge_lines_visible
  object
  optional
  Object Properties
  hidden
  boolean
  optional
  type
  string
  optional
  Possible values
  edge_lines_visible
  object_visible
  object
  optional
  Object Properties
  hidden
  boolean
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  object_visible
  object_bring_to_front
  object
  optional
  Object Properties
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  object_bring_to_front
  object_set_material_params_pbr
  object
  optional
  Object Properties
  ambient_occlusion
  number
  optional
  color
  object
  optional
  Object Properties
  a
  number
  optional
  b
  number
  optional
  g
  number
  optional
  r
  number
  optional
  metalness
  number
  optional
  object_id
  string / UUID
  optional
  roughness
  number
  optional
  type
  string
  optional
  Possible values
  object_set_material_params_pbr
  get_entity_type
  object
  optional
  Object Properties
  entity_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  get_entity_type
  solid3d_get_all_edge_faces
  object
  optional
  Object Properties
  edge_id
  string / UUID
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid3d_get_all_edge_faces
  solid2d_add_hole
  object
  optional
  Object Properties
  hole_id
  string / UUID
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid2d_add_hole
  solid3d_get_all_opposite_edges
  object
  optional
  Object Properties
  along_vector
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  edge_id
  string / UUID
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid3d_get_all_opposite_edges
  solid3d_get_opposite_edge
  object
  optional
  Object Properties
  edge_id
  string / UUID
  optional
  face_id
  string / UUID
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid3d_get_opposite_edge
  solid3d_get_next_adjacent_edge
  object
  optional
  Object Properties
  edge_id
  string / UUID
  optional
  face_id
  string / UUID
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid3d_get_next_adjacent_edge
  solid3d_get_prev_adjacent_edge
  object
  optional
  Object Properties
  edge_id
  string / UUID
  optional
  face_id
  string / UUID
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid3d_get_prev_adjacent_edge
  solid3d_fillet_edge
  object
  optional
  Object Properties
  edge_id
  string / UUID
  optional
  object_id
  string / UUID
  optional
  radius
  number
  optional
  tolerance
  number
  optional
  type
  string
  optional
  Possible values
  solid3d_fillet_edge
  face_is_planar
  object
  optional
  Object Properties
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  face_is_planar
  face_get_position
  object
  optional
  Object Properties
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  face_get_position
  uv
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  face_get_gradient
  object
  optional
  Object Properties
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  face_get_gradient
  uv
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  send_object
  object
  optional
  Object Properties
  front
  boolean
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  send_object
  entity_set_opacity
  object
  optional
  Object Properties
  entity_id
  string / UUID
  optional
  opacity
  number
  optional
  type
  string
  optional
  Possible values
  entity_set_opacity
  entity_fade
  object
  optional
  Object Properties
  duration_seconds
  number
  optional
  entity_id
  string / UUID
  optional
  fade_in
  boolean
  optional
  type
  string
  optional
  Possible values
  entity_fade
  make_plane
  object
  optional
  Object Properties
  clobber
  boolean
  optional
  hide
  boolean
  optional
  origin
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  size
  number
  optional
  type
  string
  optional
  Possible values
  make_plane
  x_axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  y_axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  plane_set_color
  object
  optional
  Object Properties
  color
  object
  optional
  Object Properties
  a
  number
  optional
  b
  number
  optional
  g
  number
  optional
  r
  number
  optional
  plane_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  plane_set_color
  set_tool
  object
  optional
  Object Properties
  tool
  string
  optional
  Possible values
  camera_revolve
  select
  move
  sketch_line
  sketch_tangential_arc
  sketch_curve
  sketch_curve_mod
  type
  string
  optional
  Possible values
  set_tool
  mouse_move
  object
  optional
  Object Properties
  sequence
  integer
  optional
  type
  string
  optional
  Possible values
  mouse_move
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  mouse_click
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  mouse_click
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  sketch_mode_disable
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  sketch_mode_disable
  get_sketch_mode_plane
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  get_sketch_mode_plane
  curve_set_constraint
  object
  optional
  Object Properties
  constraint_bound
  string
  optional
  Possible values
  unconstrained
  partially_constrained
  fully_constrained
  constraint_type
  string
  optional
  Possible values
  unconstrained
  vertical
  horizontal
  equal_length
  parallel
  angle_between
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  curve_set_constraint
  enable_sketch_mode
  object
  optional
  Object Properties
  adjust_camera
  boolean
  optional
  animated
  boolean
  optional
  entity_id
  string / UUID
  optional
  ortho
  boolean
  optional
  planar_normal
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  enable_sketch_mode
  set_background_color
  object
  optional
  Object Properties
  color
  object
  optional
  Object Properties
  a
  number
  optional
  b
  number
  optional
  g
  number
  optional
  r
  number
  optional
  type
  string
  optional
  Possible values
  set_background_color
  set_current_tool_properties
  object
  optional
  Object Properties
  color
  object
  optional
  Object Properties
  a
  number
  optional
  b
  number
  optional
  g
  number
  optional
  r
  number
  optional
  type
  string
  optional
  Possible values
  set_current_tool_properties
  set_default_system_properties
  object
  optional
  Object Properties
  color
  object
  optional
  Object Properties
  a
  number
  optional
  b
  number
  optional
  g
  number
  optional
  r
  number
  optional
  type
  string
  optional
  Possible values
  set_default_system_properties
  curve_get_type
  object
  optional
  Object Properties
  curve_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  curve_get_type
  curve_get_control_points
  object
  optional
  Object Properties
  curve_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  curve_get_control_points
  take_snapshot
  object
  optional
  Object Properties
  format
  string
  optional
  Possible values
  png: .png format
  jpeg: .jpeg format
  type
  string
  optional
  Possible values
  take_snapshot
  make_axes_gizmo
  object
  optional
  Object Properties
  clobber
  boolean
  optional
  gizmo_mode
  boolean
  optional
  type
  string
  optional
  Possible values
  make_axes_gizmo
  path_get_info
  object
  optional
  Object Properties
  path_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  path_get_info
  path_get_curve_uuids_for_vertices
  object
  optional
  Object Properties
  path_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  path_get_curve_uuids_for_vertices
  vertex_ids
  array
  optional
  path_get_vertex_uuids
  object
  optional
  Object Properties
  path_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  path_get_vertex_uuids
  handle_mouse_drag_start
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  handle_mouse_drag_start
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  handle_mouse_drag_move
  object
  optional
  Object Properties
  sequence
  integer
  optional
  type
  string
  optional
  Possible values
  handle_mouse_drag_move
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  handle_mouse_drag_end
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  handle_mouse_drag_end
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  remove_scene_objects
  object
  optional
  Object Properties
  object_ids
  array
  optional
  type
  string
  optional
  Possible values
  remove_scene_objects
  plane_intersect_and_project
  object
  optional
  Object Properties
  plane_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  plane_intersect_and_project
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  curve_get_end_points
  object
  optional
  Object Properties
  curve_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  curve_get_end_points
  reconfigure_stream
  object
  optional
  Object Properties
  fps
  integer
  optional
  height
  integer
  optional
  type
  string
  optional
  Possible values
  reconfigure_stream
  width
  integer
  optional
  import_files
  object
  optional
  Object Properties
  files
  array
  optional
  Array of
  data
  array
  optional
  path
  string
  optional
  format
  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>
  type
  string
  optional
  Possible values
  import_files
  set_scene_units
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  set_scene_units
  unit
  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>
  mass
  object
  optional
  Object Properties
  entity_ids
  array
  optional
  material_density
  number
  optional
  material_density_unit
  string
  optional
  Possible values
  lb:ft3: Pounds per cubic feet.
  kg:m3: Kilograms per cubic meter.
  output_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)>
  type
  string
  optional
  Possible values
  mass
  density
  object
  optional
  Object Properties
  entity_ids
  array
  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.
  type
  string
  optional
  Possible values
  density
  volume
  object
  optional
  Object Properties
  entity_ids
  array
  optional
  output_unit
  string
  optional
  Possible values
  cm3: Cubic centimeters (cc or cm³) <https://en.wikipedia.org/wiki/Cubic_centimeter>
  ft3: Cubic feet (ft³) <https://en.wikipedia.org/wiki/Cubic_foot>
  in3: Cubic inches (cu in or in³) <https://en.wikipedia.org/wiki/Cubic_inch>
  m3: Cubic meters (m³) <https://en.wikipedia.org/wiki/Cubic_meter>
  yd3: Cubic yards (yd³) <https://en.wikipedia.org/wiki/Cubic_yard>
  usfloz: US Fluid Ounces (fl oz) <https://en.wikipedia.org/wiki/Fluid_ounce>
  usgal: US Gallons (gal US) <https://en.wikipedia.org/wiki/Gallon>
  l: Liters (l) <https://en.wikipedia.org/wiki/Litre>
  ml: Milliliters (ml) <https://en.wikipedia.org/wiki/Litre>
  type
  string
  optional
  Possible values
  volume
  center_of_mass
  object
  optional
  Object Properties
  entity_ids
  array
  optional
  output_unit
  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>
  type
  string
  optional
  Possible values
  center_of_mass
  surface_area
  object
  optional
  Object Properties
  entity_ids
  array
  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>
  type
  string
  optional
  Possible values
  surface_area
  default_camera_focus_on
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  default_camera_focus_on
  uuid
  string / UUID
  optional
  set_selection_type
  object
  optional
  Object Properties
  selection_type
  string
  optional
  Possible values
  replace: Replaces the selection
  add: Adds to the selection
  remove: Removes from the selection
  type
  string
  optional
  Possible values
  set_selection_type
  set_selection_filter
  object
  optional
  Object Properties
  filter
  array
  optional
  type
  string
  optional
  Possible values
  set_selection_filter
  default_camera_set_orthographic
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  default_camera_set_orthographic
  default_camera_set_perspective
  object
  optional
  Object Properties
  parameters
  object
  optional
  Object Properties
  fov_y
  number
  optional
  z_far
  number
  optional
  z_near
  number
  optional
  type
  string
  optional
  Possible values
  default_camera_set_perspective
  zoom_to_fit
  object
  optional
  Object Properties
  object_ids
  array
  optional
  padding
  number
  optional
  type
  string
  optional
  Possible values
  zoom_to_fit
  solid3d_get_extrusion_face_info
  object
  optional
  Object Properties
  edge_id
  string / UUID
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid3d_get_extrusion_face_info
  edit_mode_exit
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  edit_mode_exit
  select_clear
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  select_clear
  select_get
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  select_get
  get_num_objects
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  get_num_objects
  cmd_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  modeling_cmd_req
- modeling_cmd_batch_req
  object
  optional
  Object Properties
  batch_id
  string / UUID
  optional
  requests
  array
  optional
  Array of
  cmd
  oneOf
  optional
  One of
  start_path
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  start_path
  move_path_pen
  object
  optional
  Object Properties
  path
  string / UUID
  optional
  to
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  move_path_pen
  extend_path
  object
  optional
  Object Properties
  path
  string / UUID
  optional
  segment
  oneOf
  optional
  One of
  line
  object
  optional
  Object Properties
  end
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  relative
  boolean
  optional
  type
  string
  optional
  Possible values
  line
  arc
  object
  optional
  Object Properties
  center
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  end
  object
  optional
  Object Properties
  unit
  string
  optional
  Possible values
  degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
  radians: Radians <https://en.wikipedia.org/wiki/Radian>
  value
  number
  optional
  radius
  number
  optional
  relative
  boolean
  optional
  start
  object
  optional
  Object Properties
  unit
  string
  optional
  Possible values
  degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
  radians: Radians <https://en.wikipedia.org/wiki/Radian>
  value
  number
  optional
  type
  string
  optional
  Possible values
  arc
  bezier
  object
  optional
  Object Properties
  control1
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  control2
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  end
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  relative
  boolean
  optional
  type
  string
  optional
  Possible values
  bezier
  tangential_arc
  object
  optional
  Object Properties
  offset
  object
  optional
  Object Properties
  unit
  string
  optional
  Possible values
  degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
  radians: Radians <https://en.wikipedia.org/wiki/Radian>
  value
  number
  optional
  radius
  number
  optional
  type
  string
  optional
  Possible values
  tangential_arc
  tangential_arc_to
  object
  optional
  Object Properties
  angle_snap_increment
  object
  optional
  Object Properties
  unit
  string
  optional
  Possible values
  degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
  radians: Radians <https://en.wikipedia.org/wiki/Radian>
  value
  number
  optional
  to
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  tangential_arc_to
  type
  string
  optional
  Possible values
  extend_path
  extrude
  object
  optional
  Object Properties
  cap
  boolean
  optional
  distance
  number
  optional
  target
  string / UUID
  optional
  type
  string
  optional
  Possible values
  extrude
  revolve
  object
  optional
  Object Properties
  angle
  object
  optional
  Object Properties
  unit
  string
  optional
  Possible values
  degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
  radians: Radians <https://en.wikipedia.org/wiki/Radian>
  value
  number
  optional
  axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  axis_is_2d
  boolean
  optional
  origin
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  target
  string / UUID
  optional
  tolerance
  number
  optional
  type
  string
  optional
  Possible values
  revolve
  revolve_about_edge
  object
  optional
  Object Properties
  angle
  object
  optional
  Object Properties
  unit
  string
  optional
  Possible values
  degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
  radians: Radians <https://en.wikipedia.org/wiki/Radian>
  value
  number
  optional
  edge_id
  string / UUID
  optional
  target
  string / UUID
  optional
  tolerance
  number
  optional
  type
  string
  optional
  Possible values
  revolve_about_edge
  close_path
  object
  optional
  Object Properties
  path_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  close_path
  camera_drag_start
  object
  optional
  Object Properties
  interaction
  string
  optional
  Possible values
  pan: Camera pan
  rotate: Camera rotate (revolve/orbit)
  zoom: Camera zoom (increase or decrease distance to reference point center)
  type
  string
  optional
  Possible values
  camera_drag_start
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  camera_drag_move
  object
  optional
  Object Properties
  interaction
  string
  optional
  Possible values
  pan: Camera pan
  rotate: Camera rotate (revolve/orbit)
  zoom: Camera zoom (increase or decrease distance to reference point center)
  sequence
  integer
  optional
  type
  string
  optional
  Possible values
  camera_drag_move
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  camera_drag_end
  object
  optional
  Object Properties
  interaction
  string
  optional
  Possible values
  pan: Camera pan
  rotate: Camera rotate (revolve/orbit)
  zoom: Camera zoom (increase or decrease distance to reference point center)
  type
  string
  optional
  Possible values
  camera_drag_end
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  default_camera_get_settings
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  default_camera_get_settings
  default_camera_look_at
  object
  optional
  Object Properties
  center
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  sequence
  integer
  optional
  type
  string
  optional
  Possible values
  default_camera_look_at
  up
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  vantage
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  default_camera_perspective_settings
  object
  optional
  Object Properties
  center
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  fov_y
  number
  optional
  sequence
  integer
  optional
  type
  string
  optional
  Possible values
  default_camera_perspective_settings
  up
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  vantage
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  z_far
  number
  optional
  z_near
  number
  optional
  default_camera_zoom
  object
  optional
  Object Properties
  magnitude
  number
  optional
  type
  string
  optional
  Possible values
  default_camera_zoom
  export
  object
  optional
  Object Properties
  entity_ids
  array
  optional
  format
  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>
  type
  string
  optional
  Possible values
  export
  entity_get_parent_id
  object
  optional
  Object Properties
  entity_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  entity_get_parent_id
  entity_get_num_children
  object
  optional
  Object Properties
  entity_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  entity_get_num_children
  entity_get_child_uuid
  object
  optional
  Object Properties
  child_index
  integer
  optional
  entity_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  entity_get_child_uuid
  entity_get_all_child_uuids
  object
  optional
  Object Properties
  entity_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  entity_get_all_child_uuids
  entity_get_distance
  object
  optional
  Object Properties
  distance_type
  oneOf
  optional
  One of
  euclidean
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  euclidean
  on_axis
  object
  optional
  Object Properties
  axis
  string
  optional
  Possible values
  x: The X axis
  y: The Y axis
  z: The Z axis
  type
  string
  optional
  Possible values
  on_axis
  entity_id1
  string / UUID
  optional
  entity_id2
  string / UUID
  optional
  type
  string
  optional
  Possible values
  entity_get_distance
  entity_linear_pattern
  object
  optional
  Object Properties
  axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  entity_id
  string / UUID
  optional
  num_repetitions
  integer
  optional
  spacing
  number
  optional
  type
  string
  optional
  Possible values
  entity_linear_pattern
  entity_circular_pattern
  object
  optional
  Object Properties
  arc_degrees
  number
  optional
  axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  center
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  entity_id
  string / UUID
  optional
  num_repetitions
  integer
  optional
  rotate_duplicates
  boolean
  optional
  type
  string
  optional
  Possible values
  entity_circular_pattern
  entity_make_helix
  object
  optional
  Object Properties
  cylinder_id
  string / UUID
  optional
  is_clockwise
  boolean
  optional
  length
  number
  optional
  revolutions
  number
  optional
  start_angle
  object
  optional
  Object Properties
  unit
  string
  optional
  Possible values
  degrees: Degrees <https://en.wikipedia.org/wiki/Degree_(angle)>
  radians: Radians <https://en.wikipedia.org/wiki/Radian>
  value
  number
  optional
  type
  string
  optional
  Possible values
  entity_make_helix
  entity_mirror
  object
  optional
  Object Properties
  axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  ids
  array
  optional
  point
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  entity_mirror
  edit_mode_enter
  object
  optional
  Object Properties
  target
  string / UUID
  optional
  type
  string
  optional
  Possible values
  edit_mode_enter
  select_with_point
  object
  optional
  Object Properties
  selected_at_window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  selection_type
  string
  optional
  Possible values
  replace: Replaces the selection
  add: Adds to the selection
  remove: Removes from the selection
  type
  string
  optional
  Possible values
  select_with_point
  select_add
  object
  optional
  Object Properties
  entities
  array
  optional
  type
  string
  optional
  Possible values
  select_add
  select_remove
  object
  optional
  Object Properties
  entities
  array
  optional
  type
  string
  optional
  Possible values
  select_remove
  scene_clear_all
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  scene_clear_all
  select_replace
  object
  optional
  Object Properties
  entities
  array
  optional
  type
  string
  optional
  Possible values
  select_replace
  highlight_set_entity
  object
  optional
  Object Properties
  selected_at_window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  sequence
  integer
  optional
  type
  string
  optional
  Possible values
  highlight_set_entity
  highlight_set_entities
  object
  optional
  Object Properties
  entities
  array
  optional
  type
  string
  optional
  Possible values
  highlight_set_entities
  new_annotation
  object
  optional
  Object Properties
  annotation_type
  string
  optional
  Possible values
  t2d: 2D annotation type (screen or planar space)
  t3d: 3D annotation type
  clobber
  boolean
  optional
  options
  object
  optional
  Object Properties
  color
  object
  optional
  Object Properties
  a
  number
  optional
  b
  number
  optional
  g
  number
  optional
  r
  number
  optional
  line_ends
  object
  optional
  Object Properties
  end
  string
  optional
  Possible values
  none
  arrow
  start
  string
  optional
  Possible values
  none
  arrow
  line_width
  number
  optional
  position
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  text
  object
  required
  Object Properties
  point_size
  integer
  optional
  text
  string
  optional
  x
  string
  optional
  Possible values
  left
  center
  right
  y
  string
  optional
  Possible values
  bottom
  center
  top
  type
  string
  optional
  Possible values
  new_annotation
  update_annotation
  object
  optional
  Object Properties
  annotation_id
  string / UUID
  optional
  options
  object
  optional
  Object Properties
  color
  object
  optional
  Object Properties
  a
  number
  optional
  b
  number
  optional
  g
  number
  optional
  r
  number
  optional
  line_ends
  object
  optional
  Object Properties
  end
  string
  optional
  Possible values
  none
  arrow
  start
  string
  optional
  Possible values
  none
  arrow
  line_width
  number
  optional
  position
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  text
  object
  required
  Object Properties
  point_size
  integer
  optional
  text
  string
  optional
  x
  string
  optional
  Possible values
  left
  center
  right
  y
  string
  optional
  Possible values
  bottom
  center
  top
  type
  string
  optional
  Possible values
  update_annotation
  edge_lines_visible
  object
  optional
  Object Properties
  hidden
  boolean
  optional
  type
  string
  optional
  Possible values
  edge_lines_visible
  object_visible
  object
  optional
  Object Properties
  hidden
  boolean
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  object_visible
  object_bring_to_front
  object
  optional
  Object Properties
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  object_bring_to_front
  object_set_material_params_pbr
  object
  optional
  Object Properties
  ambient_occlusion
  number
  optional
  color
  object
  optional
  Object Properties
  a
  number
  optional
  b
  number
  optional
  g
  number
  optional
  r
  number
  optional
  metalness
  number
  optional
  object_id
  string / UUID
  optional
  roughness
  number
  optional
  type
  string
  optional
  Possible values
  object_set_material_params_pbr
  get_entity_type
  object
  optional
  Object Properties
  entity_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  get_entity_type
  solid3d_get_all_edge_faces
  object
  optional
  Object Properties
  edge_id
  string / UUID
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid3d_get_all_edge_faces
  solid2d_add_hole
  object
  optional
  Object Properties
  hole_id
  string / UUID
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid2d_add_hole
  solid3d_get_all_opposite_edges
  object
  optional
  Object Properties
  along_vector
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  edge_id
  string / UUID
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid3d_get_all_opposite_edges
  solid3d_get_opposite_edge
  object
  optional
  Object Properties
  edge_id
  string / UUID
  optional
  face_id
  string / UUID
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid3d_get_opposite_edge
  solid3d_get_next_adjacent_edge
  object
  optional
  Object Properties
  edge_id
  string / UUID
  optional
  face_id
  string / UUID
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid3d_get_next_adjacent_edge
  solid3d_get_prev_adjacent_edge
  object
  optional
  Object Properties
  edge_id
  string / UUID
  optional
  face_id
  string / UUID
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid3d_get_prev_adjacent_edge
  solid3d_fillet_edge
  object
  optional
  Object Properties
  edge_id
  string / UUID
  optional
  object_id
  string / UUID
  optional
  radius
  number
  optional
  tolerance
  number
  optional
  type
  string
  optional
  Possible values
  solid3d_fillet_edge
  face_is_planar
  object
  optional
  Object Properties
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  face_is_planar
  face_get_position
  object
  optional
  Object Properties
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  face_get_position
  uv
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  face_get_gradient
  object
  optional
  Object Properties
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  face_get_gradient
  uv
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  send_object
  object
  optional
  Object Properties
  front
  boolean
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  send_object
  entity_set_opacity
  object
  optional
  Object Properties
  entity_id
  string / UUID
  optional
  opacity
  number
  optional
  type
  string
  optional
  Possible values
  entity_set_opacity
  entity_fade
  object
  optional
  Object Properties
  duration_seconds
  number
  optional
  entity_id
  string / UUID
  optional
  fade_in
  boolean
  optional
  type
  string
  optional
  Possible values
  entity_fade
  make_plane
  object
  optional
  Object Properties
  clobber
  boolean
  optional
  hide
  boolean
  optional
  origin
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  size
  number
  optional
  type
  string
  optional
  Possible values
  make_plane
  x_axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  y_axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  plane_set_color
  object
  optional
  Object Properties
  color
  object
  optional
  Object Properties
  a
  number
  optional
  b
  number
  optional
  g
  number
  optional
  r
  number
  optional
  plane_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  plane_set_color
  set_tool
  object
  optional
  Object Properties
  tool
  string
  optional
  Possible values
  camera_revolve
  select
  move
  sketch_line
  sketch_tangential_arc
  sketch_curve
  sketch_curve_mod
  type
  string
  optional
  Possible values
  set_tool
  mouse_move
  object
  optional
  Object Properties
  sequence
  integer
  optional
  type
  string
  optional
  Possible values
  mouse_move
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  mouse_click
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  mouse_click
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  sketch_mode_disable
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  sketch_mode_disable
  get_sketch_mode_plane
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  get_sketch_mode_plane
  curve_set_constraint
  object
  optional
  Object Properties
  constraint_bound
  string
  optional
  Possible values
  unconstrained
  partially_constrained
  fully_constrained
  constraint_type
  string
  optional
  Possible values
  unconstrained
  vertical
  horizontal
  equal_length
  parallel
  angle_between
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  curve_set_constraint
  enable_sketch_mode
  object
  optional
  Object Properties
  adjust_camera
  boolean
  optional
  animated
  boolean
  optional
  entity_id
  string / UUID
  optional
  ortho
  boolean
  optional
  planar_normal
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  enable_sketch_mode
  set_background_color
  object
  optional
  Object Properties
  color
  object
  optional
  Object Properties
  a
  number
  optional
  b
  number
  optional
  g
  number
  optional
  r
  number
  optional
  type
  string
  optional
  Possible values
  set_background_color
  set_current_tool_properties
  object
  optional
  Object Properties
  color
  object
  optional
  Object Properties
  a
  number
  optional
  b
  number
  optional
  g
  number
  optional
  r
  number
  optional
  type
  string
  optional
  Possible values
  set_current_tool_properties
  set_default_system_properties
  object
  optional
  Object Properties
  color
  object
  optional
  Object Properties
  a
  number
  optional
  b
  number
  optional
  g
  number
  optional
  r
  number
  optional
  type
  string
  optional
  Possible values
  set_default_system_properties
  curve_get_type
  object
  optional
  Object Properties
  curve_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  curve_get_type
  curve_get_control_points
  object
  optional
  Object Properties
  curve_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  curve_get_control_points
  take_snapshot
  object
  optional
  Object Properties
  format
  string
  optional
  Possible values
  png: .png format
  jpeg: .jpeg format
  type
  string
  optional
  Possible values
  take_snapshot
  make_axes_gizmo
  object
  optional
  Object Properties
  clobber
  boolean
  optional
  gizmo_mode
  boolean
  optional
  type
  string
  optional
  Possible values
  make_axes_gizmo
  path_get_info
  object
  optional
  Object Properties
  path_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  path_get_info
  path_get_curve_uuids_for_vertices
  object
  optional
  Object Properties
  path_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  path_get_curve_uuids_for_vertices
  vertex_ids
  array
  optional
  path_get_vertex_uuids
  object
  optional
  Object Properties
  path_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  path_get_vertex_uuids
  handle_mouse_drag_start
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  handle_mouse_drag_start
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  handle_mouse_drag_move
  object
  optional
  Object Properties
  sequence
  integer
  optional
  type
  string
  optional
  Possible values
  handle_mouse_drag_move
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  handle_mouse_drag_end
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  handle_mouse_drag_end
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  remove_scene_objects
  object
  optional
  Object Properties
  object_ids
  array
  optional
  type
  string
  optional
  Possible values
  remove_scene_objects
  plane_intersect_and_project
  object
  optional
  Object Properties
  plane_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  plane_intersect_and_project
  window
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  curve_get_end_points
  object
  optional
  Object Properties
  curve_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  curve_get_end_points
  reconfigure_stream
  object
  optional
  Object Properties
  fps
  integer
  optional
  height
  integer
  optional
  type
  string
  optional
  Possible values
  reconfigure_stream
  width
  integer
  optional
  import_files
  object
  optional
  Object Properties
  files
  array
  optional
  Array of
  data
  array
  optional
  path
  string
  optional
  format
  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>
  type
  string
  optional
  Possible values
  import_files
  set_scene_units
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  set_scene_units
  unit
  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>
  mass
  object
  optional
  Object Properties
  entity_ids
  array
  optional
  material_density
  number
  optional
  material_density_unit
  string
  optional
  Possible values
  lb:ft3: Pounds per cubic feet.
  kg:m3: Kilograms per cubic meter.
  output_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)>
  type
  string
  optional
  Possible values
  mass
  density
  object
  optional
  Object Properties
  entity_ids
  array
  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.
  type
  string
  optional
  Possible values
  density
  volume
  object
  optional
  Object Properties
  entity_ids
  array
  optional
  output_unit
  string
  optional
  Possible values
  cm3: Cubic centimeters (cc or cm³) <https://en.wikipedia.org/wiki/Cubic_centimeter>
  ft3: Cubic feet (ft³) <https://en.wikipedia.org/wiki/Cubic_foot>
  in3: Cubic inches (cu in or in³) <https://en.wikipedia.org/wiki/Cubic_inch>
  m3: Cubic meters (m³) <https://en.wikipedia.org/wiki/Cubic_meter>
  yd3: Cubic yards (yd³) <https://en.wikipedia.org/wiki/Cubic_yard>
  usfloz: US Fluid Ounces (fl oz) <https://en.wikipedia.org/wiki/Fluid_ounce>
  usgal: US Gallons (gal US) <https://en.wikipedia.org/wiki/Gallon>
  l: Liters (l) <https://en.wikipedia.org/wiki/Litre>
  ml: Milliliters (ml) <https://en.wikipedia.org/wiki/Litre>
  type
  string
  optional
  Possible values
  volume
  center_of_mass
  object
  optional
  Object Properties
  entity_ids
  array
  optional
  output_unit
  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>
  type
  string
  optional
  Possible values
  center_of_mass
  surface_area
  object
  optional
  Object Properties
  entity_ids
  array
  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>
  type
  string
  optional
  Possible values
  surface_area
  default_camera_focus_on
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  default_camera_focus_on
  uuid
  string / UUID
  optional
  set_selection_type
  object
  optional
  Object Properties
  selection_type
  string
  optional
  Possible values
  replace: Replaces the selection
  add: Adds to the selection
  remove: Removes from the selection
  type
  string
  optional
  Possible values
  set_selection_type
  set_selection_filter
  object
  optional
  Object Properties
  filter
  array
  optional
  type
  string
  optional
  Possible values
  set_selection_filter
  default_camera_set_orthographic
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  default_camera_set_orthographic
  default_camera_set_perspective
  object
  optional
  Object Properties
  parameters
  object
  optional
  Object Properties
  fov_y
  number
  optional
  z_far
  number
  optional
  z_near
  number
  optional
  type
  string
  optional
  Possible values
  default_camera_set_perspective
  zoom_to_fit
  object
  optional
  Object Properties
  object_ids
  array
  optional
  padding
  number
  optional
  type
  string
  optional
  Possible values
  zoom_to_fit
  solid3d_get_extrusion_face_info
  object
  optional
  Object Properties
  edge_id
  string / UUID
  optional
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid3d_get_extrusion_face_info
  edit_mode_exit
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  edit_mode_exit
  select_clear
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  select_clear
  select_get
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  select_get
  get_num_objects
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  get_num_objects
  cmd_id
  string / UUID
  optional
  responses
  boolean
  optional
  type
  string
  optional
  Possible values
  modeling_cmd_batch_req
- ping
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  ping
- metrics_response
  object
  optional
  Object Properties
  metrics
  object
  optional
  Object Properties
  rtc_frames_decoded
  integer
  optional
  rtc_frames_dropped
  integer
  optional
  rtc_frames_per_second
  integer
  optional
  rtc_frames_received
  integer
  optional
  rtc_freeze_count
  integer
  optional
  rtc_jitter_sec
  number
  optional
  rtc_keyframes_decoded
  integer
  optional
  rtc_total_freezes_duration_sec
  number
  optional
  type
  string
  optional
  Possible values
  metrics_response
- headers
  object
  required
  Object Properties
  headers
  object
  optional
  type
  string
  optional
  Possible values
  headers

Returns

Websocket responses
Name
Type
Req.
body
object
optional
Object Properties
- request_id
  string / UUID
  optional
- resp
  oneOf
  optional
  One of
  ice_server_info
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  ice_servers
  array
  optional
  Array of
  credential
  string
  optional
  urls
  array
  optional
  username
  string
  optional
  type
  string
  optional
  Possible values
  ice_server_info
  trickle_ice
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  candidate
  object
  required
  Object Properties
  candidate
  string
  optional
  sdpMLineIndex
  integer
  optional
  sdpMid
  string
  optional
  usernameFragment
  string
  optional
  type
  string
  optional
  Possible values
  trickle_ice
  sdp_answer
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  answer
  object
  optional
  Object Properties
  sdp
  string
  optional
  type
  string
  optional
  Possible values
  unspecified: Unspecified indicates that the type is unspecified.
  offer: indicates that a description MUST be treated as an SDP offer.
  pranswer: indicates that a description MUST be treated as an SDP answer, but not a final answer. A description used as an SDP pranswer may be applied as a response to an SDP offer, or an update to a previously sent SDP pranswer.
  answer: indicates that a description MUST be treated as an SDP final answer, and the offer-answer exchange MUST be considered complete. A description used as an SDP answer may be applied as a response to an SDP offer or as an update to a previously sent SDP pranswer.
  rollback: indicates that a description MUST be treated as canceling the current SDP negotiation and moving the SDP offer and answer back to what it was in the previous stable state. Note the local or remote SDP descriptions in the previous stable state could be null if there has not yet been a successful offer-answer negotiation.
  type
  string
  optional
  Possible values
  sdp_answer
  modeling
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  modeling_response
  oneOf
  optional
  One of
  empty
  object
  optional
  Object Properties
  type
  string
  optional
  Possible values
  empty
  export
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  files
  array
  optional
  Array of
  contents
  string / BASE64
  optional
  name
  string
  optional
  type
  string
  optional
  Possible values
  export
  select_with_point
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  entity_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  select_with_point
  highlight_set_entity
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  entity_id
  string / UUID
  optional
  sequence
  integer
  optional
  type
  string
  optional
  Possible values
  highlight_set_entity
  entity_get_child_uuid
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  entity_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  entity_get_child_uuid
  entity_get_num_children
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  num
  integer
  optional
  type
  string
  optional
  Possible values
  entity_get_num_children
  entity_get_parent_id
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  entity_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  entity_get_parent_id
  entity_get_all_child_uuids
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  entity_ids
  array
  optional
  type
  string
  optional
  Possible values
  entity_get_all_child_uuids
  camera_drag_move
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  settings
  object
  optional
  Object Properties
  center
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  fov_y
  number
  optional
  ortho
  boolean
  optional
  ortho_scale
  number
  optional
  pos
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  up
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  camera_drag_move
  camera_drag_end
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  settings
  object
  optional
  Object Properties
  center
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  fov_y
  number
  optional
  ortho
  boolean
  optional
  ortho_scale
  number
  optional
  pos
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  up
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  camera_drag_end
  default_camera_get_settings
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  settings
  object
  optional
  Object Properties
  center
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  fov_y
  number
  optional
  ortho
  boolean
  optional
  ortho_scale
  number
  optional
  pos
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  up
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  default_camera_get_settings
  default_camera_zoom
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  settings
  object
  optional
  Object Properties
  center
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  fov_y
  number
  optional
  ortho
  boolean
  optional
  ortho_scale
  number
  optional
  pos
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  up
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  default_camera_zoom
  get_num_objects
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  num_objects
  integer
  optional
  type
  string
  optional
  Possible values
  get_num_objects
  default_camera_focus_on
  object
  optional
  Object Properties
  data
  object
  optional
  type
  string
  optional
  Possible values
  default_camera_focus_on
  select_get
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  entity_ids
  array
  optional
  type
  string
  optional
  Possible values
  select_get
  solid3d_get_all_edge_faces
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  faces
  array
  optional
  type
  string
  optional
  Possible values
  solid3d_get_all_edge_faces
  solid3d_get_all_opposite_edges
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  edges
  array
  optional
  type
  string
  optional
  Possible values
  solid3d_get_all_opposite_edges
  solid3d_get_opposite_edge
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  edge
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid3d_get_opposite_edge
  solid3d_get_next_adjacent_edge
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  edge
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid3d_get_next_adjacent_edge
  solid3d_get_prev_adjacent_edge
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  edge
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid3d_get_prev_adjacent_edge
  get_entity_type
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  entity_type
  string
  optional
  Possible values
  entity
  object
  path
  curve
  solid2d
  solid3d
  edge
  face
  plane
  vertex
  type
  string
  optional
  Possible values
  get_entity_type
  curve_get_control_points
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  control_points
  array
  optional
  Array of
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  curve_get_control_points
  curve_get_type
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  curve_type
  string
  optional
  Possible values
  line
  arc
  nurbs
  type
  string
  optional
  Possible values
  curve_get_type
  mouse_click
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  entities_modified
  array
  optional
  entities_selected
  array
  optional
  type
  string
  optional
  Possible values
  mouse_click
  take_snapshot
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  contents
  string / BASE64
  optional
  type
  string
  optional
  Possible values
  take_snapshot
  path_get_info
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  segments
  array
  optional
  Array of
  command
  string
  optional
  Possible values
  move_to
  line_to
  bez_curve_to
  nurbs_curve_to
  add_arc
  command_id
  string / UUID
  optional
  relative
  boolean
  optional
  type
  string
  optional
  Possible values
  path_get_info
  path_segment_info
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  command
  string
  optional
  Possible values
  move_to
  line_to
  bez_curve_to
  nurbs_curve_to
  add_arc
  command_id
  string / UUID
  optional
  relative
  boolean
  optional
  type
  string
  optional
  Possible values
  path_segment_info
  path_get_curve_uuids_for_vertices
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  curve_ids
  array
  optional
  type
  string
  optional
  Possible values
  path_get_curve_uuids_for_vertices
  path_get_vertex_uuids
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  vertex_ids
  array
  optional
  type
  string
  optional
  Possible values
  path_get_vertex_uuids
  curve_get_end_points
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  end
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  start
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  curve_get_end_points
  face_is_planar
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  origin
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  x_axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  y_axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  z_axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  face_is_planar
  face_get_position
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  pos
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  face_get_position
  face_get_gradient
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  df_du
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  df_dv
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  normal
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  face_get_gradient
  plane_intersect_and_project
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  plane_coordinates
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  type
  string
  optional
  Possible values
  plane_intersect_and_project
  import_files
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  object_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  import_files
  imported_geometry
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  id
  string / UUID
  optional
  value
  array
  optional
  type
  string
  optional
  Possible values
  imported_geometry
  mass
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  mass
  number
  optional
  output_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)>
  type
  string
  optional
  Possible values
  mass
  volume
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  output_unit
  string
  optional
  Possible values
  cm3: Cubic centimeters (cc or cm³) <https://en.wikipedia.org/wiki/Cubic_centimeter>
  ft3: Cubic feet (ft³) <https://en.wikipedia.org/wiki/Cubic_foot>
  in3: Cubic inches (cu in or in³) <https://en.wikipedia.org/wiki/Cubic_inch>
  m3: Cubic meters (m³) <https://en.wikipedia.org/wiki/Cubic_meter>
  yd3: Cubic yards (yd³) <https://en.wikipedia.org/wiki/Cubic_yard>
  usfloz: US Fluid Ounces (fl oz) <https://en.wikipedia.org/wiki/Fluid_ounce>
  usgal: US Gallons (gal US) <https://en.wikipedia.org/wiki/Gallon>
  l: Liters (l) <https://en.wikipedia.org/wiki/Litre>
  ml: Milliliters (ml) <https://en.wikipedia.org/wiki/Litre>
  volume
  number
  optional
  type
  string
  optional
  Possible values
  volume
  density
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  density
  number
  optional
  output_unit
  string
  optional
  Possible values
  lb:ft3: Pounds per cubic feet.
  kg:m3: Kilograms per cubic meter.
  type
  string
  optional
  Possible values
  density
  surface_area
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  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>
  surface_area
  number
  optional
  type
  string
  optional
  Possible values
  surface_area
  center_of_mass
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  center_of_mass
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  output_unit
  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>
  type
  string
  optional
  Possible values
  center_of_mass
  get_sketch_mode_plane
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  origin
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  x_axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  y_axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  z_axis
  object
  optional
  Object Properties
  x
  number
  optional
  y
  number
  optional
  z
  number
  optional
  type
  string
  optional
  Possible values
  get_sketch_mode_plane
  entity_get_distance
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  max_distance
  number
  optional
  min_distance
  number
  optional
  type
  string
  optional
  Possible values
  entity_get_distance
  entity_linear_pattern
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  entity_ids
  array
  optional
  type
  string
  optional
  Possible values
  entity_linear_pattern
  entity_circular_pattern
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  entity_ids
  array
  optional
  type
  string
  optional
  Possible values
  entity_circular_pattern
  solid3d_get_extrusion_face_info
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  faces
  array
  optional
  Array of
  cap
  string
  optional
  Possible values
  none: Uncapped.
  top: Capped on top.
  bottom: Capped below.
  curve_id
  string / UUID
  optional
  face_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  solid3d_get_extrusion_face_info
  extrusion_face_info
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  cap
  string
  optional
  Possible values
  none: Uncapped.
  top: Capped on top.
  bottom: Capped below.
  curve_id
  string / UUID
  optional
  face_id
  string / UUID
  optional
  type
  string
  optional
  Possible values
  extrusion_face_info
  type
  string
  optional
  Possible values
  modeling
  modeling_batch
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  responses
  object
  optional
  type
  string
  optional
  Possible values
  modeling_batch
  export
  object
  optional
  Object Properties
  data
  object
  optional
  Object Properties
  files
  array
  optional
  Array of
  contents
  array
  optional
  name
  string
  optional
  type
  string
  optional
  Possible values
  export
  metrics_request
  object
  optional
  Object Properties
  data
  object
  optional
  type
  string
  optional
  Possible values
  metrics_request
  pong
  object
  optional
  Object Properties
  data
  object
  optional
  type
  string
  optional
  Possible values
  pong
- success
  boolean
  optional

get

/ws/modeling/commands

$ curl "https://api.zoo.dev/ws/modeling/commands" \
	--header "Authorization: Bearer $TOKEN" \
	--header "Content-Type: application/json" \
	--data '"{}"'

API → Modeling → Open a websocket which accepts modeling commandsbeta

Possible values

bodyapplication/json

One of

Object Properties

Object Properties

Possible values

Object Properties

Object Properties

Possible values

Possible values

Object Properties

One of

Object Properties

Possible values

Object Properties

Object Properties

Possible values

Object Properties

One of

Object Properties

Object Properties

Possible values

Object Properties

Object Properties

Object Properties

Possible values

Object Properties

Possible values

Possible values

Object Properties

Object Properties

Object Properties

Object Properties

Possible values

Object Properties

Object Properties

Possible values

Possible values

Object Properties

Object Properties

Possible values

Object Properties

Possible values

Possible values

Object Properties

Possible values

Object Properties

Object Properties

Possible values

Object Properties

API → Modeling → Open a websocket which accepts modeling commands
beta