API → Modeling → Open a websocket which accepts modeling commandsbeta
beta
Parameters
Name
Type
Req.
Possible values
phosphor
ssao
noeffect
bodyapplication/json
oneOfoptionalOne of
trickle_ice
objectoptionalObject Properties
candidate
objectrequiredObject Properties
Possible values
trickle_ice
sdp_offer
objectoptionalObject Properties
offer
objectoptionalObject Properties
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.
Possible values
sdp_offer
modeling_cmd_req
objectoptionalObject Properties
cmd
oneOfoptionalOne of
engine_util_evaluate_path
objectoptionalstart_path
objectoptionalObject Properties
Possible values
start_path
extend_path
objectoptionalObject Properties
segment
oneOfoptionalOne of
arc
objectoptionalObject Properties
Possible values
arc
bezier
objectoptionalObject Properties
Possible values
bezier
tangential_arc
objectoptionaltangential_arc_to
objectoptionalObject Properties
angle_snap_increment
objectoptionalPossible values
tangential_arc_to
Possible values
extend_path
revolve
objectoptionalObject Properties
Possible values
revolve
solid3d_shell_face
objectoptionalObject Properties
Possible values
solid3d_shell_face
revolve_about_edge
objectoptionalObject Properties
Possible values
revolve_about_edge
loft
objectoptionalObject Properties
Possible values
loft
close_path
objectoptionalcamera_drag_start
objectoptionalObject Properties
Possible values
pan
: Camera panrotate
: Camera rotate (spherical camera revolve/orbit)rotatetrackball
: Camera rotate (trackball with 3 degrees of freedom)zoom
: Camera zoom (increase or decrease distance to reference point center)
Possible values
camera_drag_start
camera_drag_move
objectoptionalObject Properties
Possible values
pan
: Camera panrotate
: Camera rotate (spherical camera revolve/orbit)rotatetrackball
: Camera rotate (trackball with 3 degrees of freedom)zoom
: Camera zoom (increase or decrease distance to reference point center)
Possible values
camera_drag_move
camera_drag_end
objectoptionalObject Properties
Possible values
pan
: Camera panrotate
: Camera rotate (spherical camera revolve/orbit)rotatetrackball
: Camera rotate (trackball with 3 degrees of freedom)zoom
: Camera zoom (increase or decrease distance to reference point center)
Possible values
camera_drag_end
default_camera_get_settings
objectoptionalObject Properties
Possible values
default_camera_get_settings
default_camera_look_at
objectoptionalObject Properties
Possible values
default_camera_look_at
default_camera_perspective_settings
objectoptionalObject Properties
Possible values
default_camera_perspective_settings
default_camera_zoom
objectoptionalexport
objectoptionalObject Properties
format
oneOfoptionalOne of
gltf
objectoptionalObject Properties
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.
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.
Possible values
gltf
obj
objectoptionalObject Properties
coords
objectoptionalObject Properties
Possible values
obj
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
objectoptionalObject Properties
coords
objectoptionalObject Properties
selection
oneOfoptionalOne of
default_scene
objectoptionalObject Properties
Possible values
default_scene
scene_by_index
objectoptionalscene_by_name
objectoptionalmesh_by_index
objectoptionalmesh_by_name
objectoptional
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.
Possible values
ply
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>
stl
objectoptionalObject Properties
coords
objectoptionalObject Properties
selection
oneOfoptionalOne of
default_scene
objectoptionalObject Properties
Possible values
default_scene
scene_by_index
objectoptionalscene_by_name
objectoptionalmesh_by_index
objectoptionalmesh_by_name
objectoptional
Possible values
ascii
: Plaintext encoding.binary
: Binary STL encoding. This is the default setting.
Possible values
stl
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>
Possible values
export
entity_get_parent_id
objectoptionalentity_get_num_children
objectoptionalentity_get_child_uuid
objectoptionalObject Properties
Possible values
entity_get_child_uuid
entity_get_all_child_uuids
objectoptionalentity_get_sketch_paths
objectoptionalentity_get_distance
objectoptionalObject Properties
Possible values
entity_get_distance
entity_linear_pattern_transform
objectoptionalObject Properties
entity_linear_pattern
objectoptionalentity_circular_pattern
objectoptionalObject Properties
Possible values
entity_circular_pattern
entity_make_helix
objectoptionalObject Properties
start_angle
objectoptionalPossible values
entity_make_helix
entity_mirror_across_edge
objectoptionalselect_with_point
objectoptionalObject Properties
selected_at_window
objectoptionalPossible values
replace
: Replaces the selectionadd
: Adds to the selectionremove
: Removes from the selection
Possible values
select_with_point
select_add
objectoptionalselect_remove
objectoptionalscene_clear_all
objectoptionalObject Properties
Possible values
scene_clear_all
select_replace
objectoptionalhighlight_set_entity
objectoptionalObject Properties
selected_at_window
objectoptionalPossible values
highlight_set_entity
highlight_set_entities
objectoptionalnew_annotation
objectoptionalObject Properties
update_annotation
objectoptionalObject Properties
edge_lines_visible
objectoptionalobject_visible
objectoptionalobject_bring_to_front
objectoptionalobject_set_material_params_pbr
objectoptionalget_entity_type
objectoptionalsolid3d_get_all_edge_faces
objectoptionalsolid2d_add_hole
objectoptionalsolid3d_get_all_opposite_edges
objectoptionalsolid3d_get_opposite_edge
objectoptionalsolid3d_get_next_adjacent_edge
objectoptionalsolid3d_get_prev_adjacent_edge
objectoptionalsolid3d_get_common_edge
objectoptionalsolid3d_fillet_edge
objectoptionalface_is_planar
objectoptionalface_get_center
objectoptionalsend_object
objectoptionalentity_set_opacity
objectoptionalentity_fade
objectoptionalObject Properties
Possible values
entity_fade
make_plane
objectoptionalObject Properties
Possible values
make_plane
mouse_click
objectoptionalsketch_mode_disable
objectoptionalObject Properties
Possible values
sketch_mode_disable
get_sketch_mode_plane
objectoptionalObject Properties
Possible values
get_sketch_mode_plane
curve_set_constraint
objectoptionalObject Properties
Possible values
unconstrained
partially_constrained
fully_constrained
Possible values
unconstrained
vertical
horizontal
equal_length
parallel
angle_between
Possible values
curve_set_constraint
enable_sketch_mode
objectoptionalObject Properties
planar_normal
objectoptionalPossible values
enable_sketch_mode
enable_dry_run
objectoptionalObject Properties
Possible values
enable_dry_run
disable_dry_run
objectoptionalObject Properties
Possible values
disable_dry_run
curve_get_type
objectoptionalcurve_get_control_points
objectoptionaltake_snapshot
objectoptionalmake_axes_gizmo
objectoptionalObject Properties
Possible values
make_axes_gizmo
path_get_info
objectoptionalpath_get_curve_uuids_for_vertices
objectoptionalObject Properties
Possible values
path_get_curve_uuids_for_vertices
path_get_curve_uuid
objectoptionalpath_get_vertex_uuids
objectoptionalpath_get_sketch_target_uuid
objectoptionalhandle_mouse_drag_start
objectoptionalhandle_mouse_drag_end
objectoptionalremove_scene_objects
objectoptionalObject Properties
Possible values
remove_scene_objects
curve_get_end_points
objectoptionalimport_files
objectoptionalObject Properties
format
oneOfoptionalOne of
obj
objectoptionalObject Properties
coords
objectoptionalObject Properties
Possible values
obj
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
objectoptionalObject Properties
coords
objectoptionalObject Properties
Possible values
ply
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
objectoptionalObject Properties
Possible values
sldprt
step
objectoptionalObject Properties
Possible values
step
stl
objectoptionalObject Properties
coords
objectoptionalObject Properties
Possible values
stl
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>
Possible values
import_files
set_scene_units
objectoptionalObject Properties
Possible values
set_scene_units
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
objectoptionalObject Properties
Possible values
lb:ft3
: Pounds per cubic feet.kg:m3
: Kilograms per cubic meter.
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)>
Possible values
mass
density
objectoptionalObject Properties
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)>
Possible values
lb:ft3
: Pounds per cubic feet.kg:m3
: Kilograms per cubic meter.
Possible values
density
volume
objectoptionalObject Properties
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>
Possible values
volume
center_of_mass
objectoptionalObject Properties
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>
Possible values
center_of_mass
surface_area
objectoptionalObject Properties
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>
Possible values
surface_area
default_camera_focus_on
objectoptionalset_selection_type
objectoptionalObject Properties
Possible values
replace
: Replaces the selectionadd
: Adds to the selectionremove
: Removes from the selection
Possible values
set_selection_type
set_selection_filter
objectoptionaldefault_camera_set_orthographic
objectoptionalObject Properties
Possible values
default_camera_set_orthographic
default_camera_set_perspective
objectoptionalObject Properties
parameters
objectoptionalPossible values
default_camera_set_perspective
default_camera_center_to_selection
objectoptionalObject Properties
Possible values
vantage
: Adjusts the camera position during the camera operationnone
: Keeps the camera position in place
Possible values
default_camera_center_to_selection
default_camera_center_to_scene
objectoptionalObject Properties
Possible values
vantage
: Adjusts the camera position during the camera operationnone
: Keeps the camera position in place
Possible values
default_camera_center_to_scene
zoom_to_fit
objectoptionalObject Properties
Possible values
zoom_to_fit
view_isometric
objectoptionalsolid3d_get_extrusion_face_info
objectoptionalselect_clear
objectoptionalObject Properties
Possible values
select_clear
select_get
objectoptionalObject Properties
Possible values
select_get
get_num_objects
objectoptionalObject Properties
Possible values
get_num_objects
make_offset_path
objectoptional
Possible values
modeling_cmd_req
modeling_cmd_batch_req
objectoptionalObject Properties
requests
arrayoptionalArray of
cmd
oneOfoptionalOne of
engine_util_evaluate_path
objectoptionalstart_path
objectoptionalObject Properties
Possible values
start_path
extend_path
objectoptionalObject Properties
segment
oneOfoptionalOne of
arc
objectoptionalObject Properties
Possible values
arc
bezier
objectoptionalObject Properties
Possible values
bezier
tangential_arc
objectoptionaltangential_arc_to
objectoptionalObject Properties
angle_snap_increment
objectoptionalPossible values
tangential_arc_to
Possible values
extend_path
revolve
objectoptionalObject Properties
Possible values
revolve
solid3d_shell_face
objectoptionalObject Properties
Possible values
solid3d_shell_face
revolve_about_edge
objectoptionalObject Properties
Possible values
revolve_about_edge
loft
objectoptionalObject Properties
Possible values
loft
close_path
objectoptionalcamera_drag_start
objectoptionalObject Properties
Possible values
pan
: Camera panrotate
: Camera rotate (spherical camera revolve/orbit)rotatetrackball
: Camera rotate (trackball with 3 degrees of freedom)zoom
: Camera zoom (increase or decrease distance to reference point center)
Possible values
camera_drag_start
camera_drag_move
objectoptionalObject Properties
Possible values
pan
: Camera panrotate
: Camera rotate (spherical camera revolve/orbit)rotatetrackball
: Camera rotate (trackball with 3 degrees of freedom)zoom
: Camera zoom (increase or decrease distance to reference point center)
Possible values
camera_drag_move
camera_drag_end
objectoptionalObject Properties
Possible values
pan
: Camera panrotate
: Camera rotate (spherical camera revolve/orbit)rotatetrackball
: Camera rotate (trackball with 3 degrees of freedom)zoom
: Camera zoom (increase or decrease distance to reference point center)
Possible values
camera_drag_end
default_camera_get_settings
objectoptionalObject Properties
Possible values
default_camera_get_settings
default_camera_look_at
objectoptionalObject Properties
Possible values
default_camera_look_at
default_camera_perspective_settings
objectoptionalObject Properties
Possible values
default_camera_perspective_settings
default_camera_zoom
objectoptionalexport
objectoptionalObject Properties
format
oneOfoptionalOne of
gltf
objectoptionalObject Properties
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.
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.
Possible values
gltf
obj
objectoptionalObject Properties
coords
objectoptionalObject Properties
Possible values
obj
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
objectoptionalObject Properties
coords
objectoptionalObject Properties
selection
oneOfoptionalOne of
default_scene
objectoptionalObject Properties
Possible values
default_scene
scene_by_index
objectoptionalscene_by_name
objectoptionalmesh_by_index
objectoptionalmesh_by_name
objectoptional
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.
Possible values
ply
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>
stl
objectoptionalObject Properties
coords
objectoptionalObject Properties
selection
oneOfoptionalOne of
default_scene
objectoptionalObject Properties
Possible values
default_scene
scene_by_index
objectoptionalscene_by_name
objectoptionalmesh_by_index
objectoptionalmesh_by_name
objectoptional
Possible values
ascii
: Plaintext encoding.binary
: Binary STL encoding. This is the default setting.
Possible values
stl
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>
Possible values
export
entity_get_parent_id
objectoptionalentity_get_num_children
objectoptionalentity_get_child_uuid
objectoptionalObject Properties
Possible values
entity_get_child_uuid
entity_get_all_child_uuids
objectoptionalentity_get_sketch_paths
objectoptionalentity_get_distance
objectoptionalObject Properties
Possible values
entity_get_distance
entity_linear_pattern_transform
objectoptionalObject Properties
entity_linear_pattern
objectoptionalentity_circular_pattern
objectoptionalObject Properties
Possible values
entity_circular_pattern
entity_make_helix
objectoptionalObject Properties
start_angle
objectoptionalPossible values
entity_make_helix
entity_mirror_across_edge
objectoptionalselect_with_point
objectoptionalObject Properties
selected_at_window
objectoptionalPossible values
replace
: Replaces the selectionadd
: Adds to the selectionremove
: Removes from the selection
Possible values
select_with_point
select_add
objectoptionalselect_remove
objectoptionalscene_clear_all
objectoptionalObject Properties
Possible values
scene_clear_all
select_replace
objectoptionalhighlight_set_entity
objectoptionalObject Properties
selected_at_window
objectoptionalPossible values
highlight_set_entity
highlight_set_entities
objectoptionalnew_annotation
objectoptionalObject Properties
update_annotation
objectoptionalObject Properties
edge_lines_visible
objectoptionalobject_visible
objectoptionalobject_bring_to_front
objectoptionalobject_set_material_params_pbr
objectoptionalget_entity_type
objectoptionalsolid3d_get_all_edge_faces
objectoptionalsolid2d_add_hole
objectoptionalsolid3d_get_all_opposite_edges
objectoptionalsolid3d_get_opposite_edge
objectoptionalsolid3d_get_next_adjacent_edge
objectoptionalsolid3d_get_prev_adjacent_edge
objectoptionalsolid3d_get_common_edge
objectoptionalsolid3d_fillet_edge
objectoptionalface_is_planar
objectoptionalface_get_center
objectoptionalsend_object
objectoptionalentity_set_opacity
objectoptionalentity_fade
objectoptionalObject Properties
Possible values
entity_fade
make_plane
objectoptionalObject Properties
Possible values
make_plane
mouse_click
objectoptionalsketch_mode_disable
objectoptionalObject Properties
Possible values
sketch_mode_disable
get_sketch_mode_plane
objectoptionalObject Properties
Possible values
get_sketch_mode_plane
curve_set_constraint
objectoptionalObject Properties
Possible values
unconstrained
partially_constrained
fully_constrained
Possible values
unconstrained
vertical
horizontal
equal_length
parallel
angle_between
Possible values
curve_set_constraint
enable_sketch_mode
objectoptionalObject Properties
planar_normal
objectoptionalPossible values
enable_sketch_mode
enable_dry_run
objectoptionalObject Properties
Possible values
enable_dry_run
disable_dry_run
objectoptionalObject Properties
Possible values
disable_dry_run
curve_get_type
objectoptionalcurve_get_control_points
objectoptionaltake_snapshot
objectoptionalmake_axes_gizmo
objectoptionalObject Properties
Possible values
make_axes_gizmo
path_get_info
objectoptionalpath_get_curve_uuids_for_vertices
objectoptionalObject Properties
Possible values
path_get_curve_uuids_for_vertices
path_get_curve_uuid
objectoptionalpath_get_vertex_uuids
objectoptionalpath_get_sketch_target_uuid
objectoptionalhandle_mouse_drag_start
objectoptionalhandle_mouse_drag_end
objectoptionalremove_scene_objects
objectoptionalObject Properties
Possible values
remove_scene_objects
curve_get_end_points
objectoptionalimport_files
objectoptionalObject Properties
format
oneOfoptionalOne of
obj
objectoptionalObject Properties
coords
objectoptionalObject Properties
Possible values
obj
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
objectoptionalObject Properties
coords
objectoptionalObject Properties
Possible values
ply
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
objectoptionalObject Properties
Possible values
sldprt
step
objectoptionalObject Properties
Possible values
step
stl
objectoptionalObject Properties
coords
objectoptionalObject Properties
Possible values
stl
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>
Possible values
import_files
set_scene_units
objectoptionalObject Properties
Possible values
set_scene_units
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
objectoptionalObject Properties
Possible values
lb:ft3
: Pounds per cubic feet.kg:m3
: Kilograms per cubic meter.
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)>
Possible values
mass
density
objectoptionalObject Properties
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)>
Possible values
lb:ft3
: Pounds per cubic feet.kg:m3
: Kilograms per cubic meter.
Possible values
density
volume
objectoptionalObject Properties
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>
Possible values
volume
center_of_mass
objectoptionalObject Properties
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>
Possible values
center_of_mass
surface_area
objectoptionalObject Properties
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>
Possible values
surface_area
default_camera_focus_on
objectoptionalset_selection_type
objectoptionalObject Properties
Possible values
replace
: Replaces the selectionadd
: Adds to the selectionremove
: Removes from the selection
Possible values
set_selection_type
set_selection_filter
objectoptionaldefault_camera_set_orthographic
objectoptionalObject Properties
Possible values
default_camera_set_orthographic
default_camera_set_perspective
objectoptionalObject Properties
parameters
objectoptionalPossible values
default_camera_set_perspective
default_camera_center_to_selection
objectoptionalObject Properties
Possible values
vantage
: Adjusts the camera position during the camera operationnone
: Keeps the camera position in place
Possible values
default_camera_center_to_selection
default_camera_center_to_scene
objectoptionalObject Properties
Possible values
vantage
: Adjusts the camera position during the camera operationnone
: Keeps the camera position in place
Possible values
default_camera_center_to_scene
zoom_to_fit
objectoptionalObject Properties
Possible values
zoom_to_fit
view_isometric
objectoptionalsolid3d_get_extrusion_face_info
objectoptionalselect_clear
objectoptionalObject Properties
Possible values
select_clear
select_get
objectoptionalObject Properties
Possible values
select_get
get_num_objects
objectoptionalObject Properties
Possible values
get_num_objects
make_offset_path
objectoptional
Possible values
modeling_cmd_batch_req
metrics_response
objectoptionalObject Properties
metrics
objectoptionalObject Properties
Possible values
metrics_response
Returns
Websocket responses
Name
Type
Req.
body
objectoptionalObject Properties
resp
oneOfoptionalOne of
ice_server_info
objectoptionalObject Properties
data
objectoptionalObject Properties
ice_servers
arrayoptionalArray of
Possible values
ice_server_info
trickle_ice
objectoptionalObject Properties
sdp_answer
objectoptionalObject Properties
data
objectoptionalObject Properties
answer
objectoptionalObject Properties
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.
Possible values
sdp_answer
modeling
objectoptionalObject Properties
data
objectoptionalObject Properties
modeling_response
oneOfoptionalOne of
start_path
objectoptionalmove_path_pen
objectoptionalextend_path
objectoptionalsolid3d_shell_face
objectoptionalrevolve_about_edge
objectoptionalcamera_drag_start
objectoptionaldefault_camera_look_at
objectoptionaldefault_camera_perspective_settings
objectoptionalentity_make_helix
objectoptionalentity_mirror
objectoptionalentity_mirror_across_edge
objectoptionalselect_add
objectoptionalselect_remove
objectoptionalscene_clear_all
objectoptionalselect_replace
objectoptionalhighlight_set_entities
objectoptionalnew_annotation
objectoptionalupdate_annotation
objectoptionaledge_lines_visible
objectoptionalobject_visible
objectoptionalobject_bring_to_front
objectoptionalobject_set_material_params_pbr
objectoptionalsolid2d_add_hole
objectoptionalsolid3d_fillet_edge
objectoptionalsend_object
objectoptionalentity_set_opacity
objectoptionalentity_fade
objectoptionalmake_plane
objectoptionalplane_set_color
objectoptionalmouse_move
objectoptionalsketch_mode_disable
objectoptionalenable_dry_run
objectoptionaldisable_dry_run
objectoptionalcurve_set_constraint
objectoptionalenable_sketch_mode
objectoptionalset_background_color
objectoptionalset_current_tool_properties
objectoptionalset_default_system_properties
objectoptionalmake_axes_gizmo
objectoptionalhandle_mouse_drag_start
objectoptionalhandle_mouse_drag_move
objectoptionalhandle_mouse_drag_end
objectoptionalremove_scene_objects
objectoptionalreconfigure_stream
objectoptionalset_scene_units
objectoptionalset_selection_type
objectoptionalset_selection_filter
objectoptionaldefault_camera_set_orthographic
objectoptionaldefault_camera_set_perspective
objectoptionaldefault_camera_center_to_selection
objectoptionaldefault_camera_center_to_scene
objectoptionalselect_clear
objectoptionalselect_with_point
objectoptionalhighlight_set_entity
objectoptionalentity_get_child_uuid
objectoptionalentity_get_num_children
objectoptionalentity_get_parent_id
objectoptionalentity_get_all_child_uuids
objectoptionalObject Properties
data
objectoptionalObject Properties
Possible values
entity_get_all_child_uuids
entity_get_sketch_paths
objectoptionalObject Properties
data
objectoptionalObject Properties
Possible values
entity_get_sketch_paths
close_path
objectoptionalcamera_drag_move
objectoptionalObject Properties
data
objectoptionalObject Properties
settings
objectoptionalObject Properties
orientation
objectoptional
Possible values
camera_drag_move
camera_drag_end
objectoptionalObject Properties
data
objectoptionalObject Properties
settings
objectoptionalObject Properties
orientation
objectoptional
Possible values
camera_drag_end
default_camera_get_settings
objectoptionalObject Properties
data
objectoptionalObject Properties
settings
objectoptionalObject Properties
orientation
objectoptional
Possible values
default_camera_get_settings
default_camera_zoom
objectoptionalObject Properties
data
objectoptionalObject Properties
settings
objectoptionalObject Properties
orientation
objectoptional
Possible values
default_camera_zoom
zoom_to_fit
objectoptionalObject Properties
data
objectoptionalObject Properties
settings
objectoptionalObject Properties
orientation
objectoptional
Possible values
zoom_to_fit
view_isometric
objectoptionalObject Properties
data
objectoptionalObject Properties
settings
objectoptionalObject Properties
orientation
objectoptional
Possible values
view_isometric
get_num_objects
objectoptionalObject Properties
data
objectoptionalObject Properties
Possible values
get_num_objects
make_offset_path
objectoptionalObject Properties
data
objectoptionalObject Properties
Possible values
make_offset_path
default_camera_focus_on
objectoptionalselect_get
objectoptionalObject Properties
data
objectoptionalObject Properties
Possible values
select_get
solid3d_get_all_edge_faces
objectoptionalsolid3d_get_all_opposite_edges
objectoptionalsolid3d_get_opposite_edge
objectoptionalsolid3d_get_next_adjacent_edge
objectoptionalsolid3d_get_prev_adjacent_edge
objectoptionalsolid3d_get_common_edge
objectoptionalget_entity_type
objectoptionalObject Properties
data
objectoptionalObject Properties
Possible values
entity
object
path
curve
solid2d
solid3d
edge
face
plane
vertex
Possible values
get_entity_type
curve_get_control_points
objectoptionalcurve_get_type
objectoptionalObject Properties
data
objectoptionalObject Properties
Possible values
line
arc
nurbs
Possible values
curve_get_type
mouse_click
objectoptionalObject Properties
data
objectoptionalObject Properties
Possible values
mouse_click
take_snapshot
objectoptionalpath_get_info
objectoptionalpath_segment_info
objectoptionalObject Properties
data
objectoptionalObject Properties
Possible values
move_to
line_to
bez_curve_to
nurbs_curve_to
add_arc
Possible values
path_segment_info
path_get_curve_uuids_for_vertices
objectoptionalpath_get_curve_uuid
objectoptionalpath_get_vertex_uuids
objectoptionalObject Properties
data
objectoptionalObject Properties
Possible values
path_get_vertex_uuids
path_get_sketch_target_uuid
objectoptionalface_is_planar
objectoptionalObject Properties
data
objectoptionalObject Properties
Possible values
face_is_planar
face_get_gradient
objectoptionalObject Properties
Possible values
face_get_gradient
plane_intersect_and_project
objectoptionalObject Properties
data
objectoptionalObject Properties
plane_coordinates
objectoptional
Possible values
plane_intersect_and_project
import_files
objectoptionalimported_geometry
objectoptionalvolume
objectoptionalObject Properties
data
objectoptionalObject Properties
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>
Possible values
volume
surface_area
objectoptionalObject Properties
data
objectoptionalObject Properties
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>
Possible values
surface_area
center_of_mass
objectoptionalObject Properties
data
objectoptionalObject Properties
center_of_mass
objectoptionalPossible 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>
Possible values
center_of_mass
get_sketch_mode_plane
objectoptionalObject Properties
data
objectoptionalObject Properties
Possible values
get_sketch_mode_plane
entity_get_distance
objectoptionalObject Properties
data
objectoptionalObject Properties
Possible values
entity_get_distance
entity_linear_pattern_transform
objectoptionalObject Properties
data
objectoptionalObject Properties
Possible values
entity_linear_pattern_transform
entity_linear_pattern
objectoptionalObject Properties
data
objectoptionalObject Properties
Possible values
entity_linear_pattern
entity_circular_pattern
objectoptionalObject Properties
data
objectoptionalObject Properties
Possible values
entity_circular_pattern
solid3d_get_extrusion_face_info
objectoptionalObject Properties
Possible values
solid3d_get_extrusion_face_info
extrusion_face_info
objectoptional
Possible values
modeling
modeling_batch
objectoptionalmetrics_request
objectoptionalmodeling_session_data
objectoptionalObject Properties
get
/ws/modeling/commands$ curl "https://api.zoo.dev/ws/modeling/commands" \
--header "Authorization: Bearer $TOKEN" \
--header "Content-Type: application/json" \
--data '"{}"'