Core API

This page references the loaders and entrypoints registered by the Core plugin.

Loaders

mesh

Can load the following formats: off, stl, ply, obj.

This loader does not support loading binary data using ‘upload-model’.

---

mhd-volume

Can load the following formats: mhd.

This loader does not support loading binary data using ‘upload-model’.

---

raw-volume

Can load the following formats: raw.

This loader supports loading binary data using ‘upload-model’.

type	object
properties
data_type	Volume byte data type
	type	string
	enum	unsinged_char, short, unsigned_short, half_float, float, double
dimensions	Volume grid size XYZ
	type	array
	items	type	integer
		minimum	0
	maxItems	3
	minItems	3
spacing	Volume grid cell spacing XYZ
	type	array
	items	type	number
	maxItems	3
	minItems	3
additionalProperties	False

Entrypoints

add-bounded-planes

Adds a list of axis-aligned bound limited planes.

Params:

type	array
items	GeometryWithColor
	type	object
	properties
	color	Geometry color
		type	array
		items	type	number
		maxItems	4
		minItems	4
	geometry	BoundedPlane
		Geometry data
		type	object
		properties
		bounds	Box
			Axis-aligned bounds to limit the plane geometry
			type	object
			properties
			max	Top front right corner XYZ
				type	array
				items	type	number
				maxItems	3
				minItems	3
			min	Bottom back left corner XYZ
				type	array
				items	type	number
				maxItems	3
				minItems	3
			additionalProperties	False
		coefficients	Equation coefficients ABCD from Ax + By + Cz + D = 0
			type	array
			items	type	number
			maxItems	4
			minItems	4
		additionalProperties	False
	additionalProperties	False

Result:

type	object
properties
bounds	Bounds
	Model bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
info	ModelInfo
	Model-specific info
	type	object
	properties
	base_transform	Transform
		Model transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	load_info	LoadInfo
		Model load info
		type	object
		properties
		load_parameters	Loader settings
		loader_name	Loader name
			type	string
		path	File path in case of file load type
			type	string
		source	Model load source
			type	string
			enum	from_file, from_blob, none
		additionalProperties	False
	metadata	Model-specific metadata
		type	object
		additionalProperties	type	string
	additionalProperties	False
is_visible	Wether the model is being rendered or not
	type	boolean
model_id	Model ID
	type	integer
	minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

add-boxes

Adds a list of boxes to the scene.

Params:

type	array
items	GeometryWithColor
	type	object
	properties
	color	Geometry color
		type	array
		items	type	number
		maxItems	4
		minItems	4
	geometry	Box
		Geometry data
		type	object
		properties
		max	Top front right corner XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		min	Bottom back left corner XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	additionalProperties	False

Result:

type	object
properties
bounds	Bounds
	Model bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
info	ModelInfo
	Model-specific info
	type	object
	properties
	base_transform	Transform
		Model transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	load_info	LoadInfo
		Model load info
		type	object
		properties
		load_parameters	Loader settings
		loader_name	Loader name
			type	string
		path	File path in case of file load type
			type	string
		source	Model load source
			type	string
			enum	from_file, from_blob, none
		additionalProperties	False
	metadata	Model-specific metadata
		type	object
		additionalProperties	type	string
	additionalProperties	False
is_visible	Wether the model is being rendered or not
	type	boolean
model_id	Model ID
	type	integer
	minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

add-capsules

Adds a list of capsules to the scene.

Params:

type	array
items	GeometryWithColor
	type	object
	properties
	color	Geometry color
		type	array
		items	type	number
		maxItems	4
		minItems	4
	geometry	Capsule
		Geometry data
		type	object
		properties
		p0	Start point of the capsule XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		p1	End point of the capsule XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		r0	Capsule radius at p0
			type	number
		r1	Capsule radius at p1
			type	number
		additionalProperties	False
	additionalProperties	False

Result:

type	object
properties
bounds	Bounds
	Model bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
info	ModelInfo
	Model-specific info
	type	object
	properties
	base_transform	Transform
		Model transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	load_info	LoadInfo
		Model load info
		type	object
		properties
		load_parameters	Loader settings
		loader_name	Loader name
			type	string
		path	File path in case of file load type
			type	string
		source	Model load source
			type	string
			enum	from_file, from_blob, none
		additionalProperties	False
	metadata	Model-specific metadata
		type	object
		additionalProperties	type	string
	additionalProperties	False
is_visible	Wether the model is being rendered or not
	type	boolean
model_id	Model ID
	type	integer
	minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

add-clipping-bounded-planes

Add a list of axis-aligned bound limited clipping planes.

Params:

type	object
properties
invert_normals	Switches clipping side
	type	boolean
	default	False
primitives	Clipping primitive list
	type	array
	items	BoundedPlane
		type	object
		properties
		bounds	Box
			Axis-aligned bounds to limit the plane geometry
			type	object
			properties
			max	Top front right corner XYZ
				type	array
				items	type	number
				maxItems	3
				minItems	3
			min	Bottom back left corner XYZ
				type	array
				items	type	number
				maxItems	3
				minItems	3
			additionalProperties	False
		coefficients	Equation coefficients ABCD from Ax + By + Cz + D = 0
			type	array
			items	type	number
			maxItems	4
			minItems	4
		additionalProperties	False
additionalProperties	False

Result:

type	object
properties
bounds	Bounds
	Model bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
info	ModelInfo
	Model-specific info
	type	object
	properties
	base_transform	Transform
		Model transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	load_info	LoadInfo
		Model load info
		type	object
		properties
		load_parameters	Loader settings
		loader_name	Loader name
			type	string
		path	File path in case of file load type
			type	string
		source	Model load source
			type	string
			enum	from_file, from_blob, none
		additionalProperties	False
	metadata	Model-specific metadata
		type	object
		additionalProperties	type	string
	additionalProperties	False
is_visible	Wether the model is being rendered or not
	type	boolean
model_id	Model ID
	type	integer
	minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

add-clipping-boxes

Add a list of clipping boxes to the scene.

Params:

type	object
properties
invert_normals	Switches clipping side
	type	boolean
	default	False
primitives	Clipping primitive list
	type	array
	items	Box
		type	object
		properties
		max	Top front right corner XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		min	Bottom back left corner XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
additionalProperties	False

Result:

type	object
properties
bounds	Bounds
	Model bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
info	ModelInfo
	Model-specific info
	type	object
	properties
	base_transform	Transform
		Model transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	load_info	LoadInfo
		Model load info
		type	object
		properties
		load_parameters	Loader settings
		loader_name	Loader name
			type	string
		path	File path in case of file load type
			type	string
		source	Model load source
			type	string
			enum	from_file, from_blob, none
		additionalProperties	False
	metadata	Model-specific metadata
		type	object
		additionalProperties	type	string
	additionalProperties	False
is_visible	Wether the model is being rendered or not
	type	boolean
model_id	Model ID
	type	integer
	minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

add-clipping-capsules

Add a list of clipping capsules to the scene.

Params:

type	object
properties
invert_normals	Switches clipping side
	type	boolean
	default	False
primitives	Clipping primitive list
	type	array
	items	Capsule
		type	object
		properties
		p0	Start point of the capsule XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		p1	End point of the capsule XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		r0	Capsule radius at p0
			type	number
		r1	Capsule radius at p1
			type	number
		additionalProperties	False
additionalProperties	False

Result:

type	object
properties
bounds	Bounds
	Model bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
info	ModelInfo
	Model-specific info
	type	object
	properties
	base_transform	Transform
		Model transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	load_info	LoadInfo
		Model load info
		type	object
		properties
		load_parameters	Loader settings
		loader_name	Loader name
			type	string
		path	File path in case of file load type
			type	string
		source	Model load source
			type	string
			enum	from_file, from_blob, none
		additionalProperties	False
	metadata	Model-specific metadata
		type	object
		additionalProperties	type	string
	additionalProperties	False
is_visible	Wether the model is being rendered or not
	type	boolean
model_id	Model ID
	type	integer
	minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

add-clipping-planes

Add a list of clipping planes to the scene.

Params:

type	object
properties
invert_normals	Switches clipping side
	type	boolean
	default	False
primitives	Clipping primitive list
	type	array
	items	Plane
		type	object
		properties
		coefficients	Equation coefficients ABCD from Ax + By + Cz + D = 0
			type	array
			items	type	number
			maxItems	4
			minItems	4
		additionalProperties	False
additionalProperties	False

Result:

type	object
properties
bounds	Bounds
	Model bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
info	ModelInfo
	Model-specific info
	type	object
	properties
	base_transform	Transform
		Model transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	load_info	LoadInfo
		Model load info
		type	object
		properties
		load_parameters	Loader settings
		loader_name	Loader name
			type	string
		path	File path in case of file load type
			type	string
		source	Model load source
			type	string
			enum	from_file, from_blob, none
		additionalProperties	False
	metadata	Model-specific metadata
		type	object
		additionalProperties	type	string
	additionalProperties	False
is_visible	Wether the model is being rendered or not
	type	boolean
model_id	Model ID
	type	integer
	minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

add-clipping-spheres

Add a list of clipping spheres to the scene.

Params:

type	object
properties
invert_normals	Switches clipping side
	type	boolean
	default	False
primitives	Clipping primitive list
	type	array
	items	Sphere
		type	object
		properties
		center	Sphere center XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		radius	Sphere radius
			type	number
		additionalProperties	False
additionalProperties	False

Result:

type	object
properties
bounds	Bounds
	Model bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
info	ModelInfo
	Model-specific info
	type	object
	properties
	base_transform	Transform
		Model transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	load_info	LoadInfo
		Model load info
		type	object
		properties
		load_parameters	Loader settings
		loader_name	Loader name
			type	string
		path	File path in case of file load type
			type	string
		source	Model load source
			type	string
			enum	from_file, from_blob, none
		additionalProperties	False
	metadata	Model-specific metadata
		type	object
		additionalProperties	type	string
	additionalProperties	False
is_visible	Wether the model is being rendered or not
	type	boolean
model_id	Model ID
	type	integer
	minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

add-light-ambient

Adds an ambient light which iluminates the scene from all directions.

Params:

type	object
properties
color	Light color RGB normalized
	type	array
	default	1
		1
		1
	items	type	number
	maxItems	3
	minItems	3
intensity	Light intensity
	type	number
	minimum	0
	default	1
additionalProperties	False

Result:

type	object
properties
bounds	Bounds
	Model bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
info	ModelInfo
	Model-specific info
	type	object
	properties
	base_transform	Transform
		Model transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	load_info	LoadInfo
		Model load info
		type	object
		properties
		load_parameters	Loader settings
		loader_name	Loader name
			type	string
		path	File path in case of file load type
			type	string
		source	Model load source
			type	string
			enum	from_file, from_blob, none
		additionalProperties	False
	metadata	Model-specific metadata
		type	object
		additionalProperties	type	string
	additionalProperties	False
is_visible	Wether the model is being rendered or not
	type	boolean
model_id	Model ID
	type	integer
	minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

add-light-directional

Adds a directional light which iluminates the scene from a given direction.

Params:

type	object
properties
color	Light color RGB normalized
	type	array
	default	1
		1
		1
	items	type	number
	maxItems	3
	minItems	3
direction	Light direction XYZ
	type	array
	default	-1
		-1
		0
	items	type	number
	maxItems	3
	minItems	3
intensity	Light intensity
	type	number
	minimum	0
	default	1
additionalProperties	False

Result:

type	object
properties
bounds	Bounds
	Model bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
info	ModelInfo
	Model-specific info
	type	object
	properties
	base_transform	Transform
		Model transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	load_info	LoadInfo
		Model load info
		type	object
		properties
		load_parameters	Loader settings
		loader_name	Loader name
			type	string
		path	File path in case of file load type
			type	string
		source	Model load source
			type	string
			enum	from_file, from_blob, none
		additionalProperties	False
	metadata	Model-specific metadata
		type	object
		additionalProperties	type	string
	additionalProperties	False
is_visible	Wether the model is being rendered or not
	type	boolean
model_id	Model ID
	type	integer
	minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

add-light-quad

Add a quad light which iluminates the scene on a specific area.

Params:

type	object
properties
color	Light color RGB normalized
	type	array
	default	1
		1
		1
	items	type	number
	maxItems	3
	minItems	3
edge1	Edge 1 XYZ
	type	array
	default	1
		0
		0
	items	type	number
	maxItems	3
	minItems	3
edge2	Edge 2 XYZ
	type	array
	default	0
		0
		1
	items	type	number
	maxItems	3
	minItems	3
intensity	Light intensity
	type	number
	minimum	0
	default	1
position	Light base corner position XYZ
	type	array
	default	0
		0
		0
	items	type	number
	maxItems	3
	minItems	3
additionalProperties	False

Result:

type	object
properties
bounds	Bounds
	Model bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
info	ModelInfo
	Model-specific info
	type	object
	properties
	base_transform	Transform
		Model transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	load_info	LoadInfo
		Model load info
		type	object
		properties
		load_parameters	Loader settings
		loader_name	Loader name
			type	string
		path	File path in case of file load type
			type	string
		source	Model load source
			type	string
			enum	from_file, from_blob, none
		additionalProperties	False
	metadata	Model-specific metadata
		type	object
		additionalProperties	type	string
	additionalProperties	False
is_visible	Wether the model is being rendered or not
	type	boolean
model_id	Model ID
	type	integer
	minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

add-light-sphere

Add a sphere or a point light (radius = 0).

Params:

type	object
properties
color	Light color RGB normalized
	type	array
	default	1
		1
		1
	items	type	number
	maxItems	3
	minItems	3
intensity	Light intensity
	type	number
	minimum	0
	default	1
position	Light position XYZ
	type	array
	default	0
		0
		0
	items	type	number
	maxItems	3
	minItems	3
radius	Sphere radius
	type	number
	default	0
additionalProperties	False

Result:

type	object
properties
bounds	Bounds
	Model bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
info	ModelInfo
	Model-specific info
	type	object
	properties
	base_transform	Transform
		Model transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	load_info	LoadInfo
		Model load info
		type	object
		properties
		load_parameters	Loader settings
		loader_name	Loader name
			type	string
		path	File path in case of file load type
			type	string
		source	Model load source
			type	string
			enum	from_file, from_blob, none
		additionalProperties	False
	metadata	Model-specific metadata
		type	object
		additionalProperties	type	string
	additionalProperties	False
is_visible	Wether the model is being rendered or not
	type	boolean
model_id	Model ID
	type	integer
	minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

add-model

Add model from path and return model descriptor on success.

This entrypoint is asynchronous, it means that it can take a long time and send progress notifications.

Params:

type	object
properties
loader_name	Name of the loader used to parse the model file
	type	string
loader_properties	Settings to configure the loading process
path	Path of the file to load
	type	string
additionalProperties	False

Result:

type	array
items	ModelInstance
	type	object
	properties
	bounds	Bounds
		Model bounds
		type	object
		properties
		max	Top front right corner XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		min	Bottom back left corner XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	info	ModelInfo
		Model-specific info
		type	object
		properties
		base_transform	Transform
			Model transform
			type	object
			properties
			rotation	Rotation XYZW
				type	array
				items	type	number
				maxItems	4
				minItems	4
			scale	Scale XYZ
				type	array
				items	type	number
				maxItems	3
				minItems	3
			translation	Translation XYZ
				type	array
				items	type	number
				maxItems	3
				minItems	3
			additionalProperties	False
		load_info	LoadInfo
			Model load info
			type	object
			properties
			load_parameters	Loader settings
			loader_name	Loader name
				type	string
			path	File path in case of file load type
				type	string
			source	Model load source
				type	string
				enum	from_file, from_blob, none
			additionalProperties	False
		metadata	Model-specific metadata
			type	object
			additionalProperties	type	string
		additionalProperties	False
	is_visible	Wether the model is being rendered or not
		type	boolean
	model_id	Model ID
		type	integer
		minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

add-planes

Adds a list of planes to the scene.

Params:

type	array
items	GeometryWithColor
	type	object
	properties
	color	Geometry color
		type	array
		items	type	number
		maxItems	4
		minItems	4
	geometry	Plane
		Geometry data
		type	object
		properties
		coefficients	Equation coefficients ABCD from Ax + By + Cz + D = 0
			type	array
			items	type	number
			maxItems	4
			minItems	4
		additionalProperties	False
	additionalProperties	False

Result:

type	object
properties
bounds	Bounds
	Model bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
info	ModelInfo
	Model-specific info
	type	object
	properties
	base_transform	Transform
		Model transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	load_info	LoadInfo
		Model load info
		type	object
		properties
		load_parameters	Loader settings
		loader_name	Loader name
			type	string
		path	File path in case of file load type
			type	string
		source	Model load source
			type	string
			enum	from_file, from_blob, none
		additionalProperties	False
	metadata	Model-specific metadata
		type	object
		additionalProperties	type	string
	additionalProperties	False
is_visible	Wether the model is being rendered or not
	type	boolean
model_id	Model ID
	type	integer
	minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

add-spheres

Adds a list of spheres to the scene.

Params:

type	array
items	GeometryWithColor
	type	object
	properties
	color	Geometry color
		type	array
		items	type	number
		maxItems	4
		minItems	4
	geometry	Sphere
		Geometry data
		type	object
		properties
		center	Sphere center XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		radius	Sphere radius
			type	number
		additionalProperties	False
	additionalProperties	False

Result:

type	object
properties
bounds	Bounds
	Model bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
info	ModelInfo
	Model-specific info
	type	object
	properties
	base_transform	Transform
		Model transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	load_info	LoadInfo
		Model load info
		type	object
		properties
		load_parameters	Loader settings
		loader_name	Loader name
			type	string
		path	File path in case of file load type
			type	string
		source	Model load source
			type	string
			enum	from_file, from_blob, none
		additionalProperties	False
	metadata	Model-specific metadata
		type	object
		additionalProperties	type	string
	additionalProperties	False
is_visible	Wether the model is being rendered or not
	type	boolean
model_id	Model ID
	type	integer
	minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

cancel

Cancel the task started by the request with the given ID.

Params:

type	object
properties
id	RequestId
	ID of the request to cancel
	oneOf	type	null
		type	integer
		type	string
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

clear-clip-planes

Old clear for clipping geometries, use ‘clear-clipping-geometries’ instead.

Attention

This entrypoint is DEPRECATED, it will be removed or renamed in the next major release.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

clear-clipping-geometries

Clear all clipping geometries in the scene.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

clear-lights

Clear all lights in the scene.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

clear-models

Clear all models in the scene.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

clear-renderables

Clear all renderable models in the scene.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

color-model

Applies the specified color method to the model with the given color input.

Params:

type	object
properties
id	ID of the model to color
	type	integer
	minimum	0
method	Coloring method
	type	string
values	Coloring parameters
	type	object
	additionalProperties	type	array
		items	type	number
		maxItems	4
		minItems	4
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

enable-simulation

A switch to enable or disable simulation on a model.

Params:

type	object
properties
enabled	Enable simulation if true
	type	boolean
model_id	ID of the model to color
	type	integer
	minimum	0
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

export-gbuffers

Renders and returns (or saves to disk) the Framebuffer G-Buffers.

This entrypoint is asynchronous, it means that it can take a long time and send progress notifications.

Params:

type	object
properties
camera	EngineObjectData
	Camera definition
	type	object
	properties
	name	Object type name
		type	string
	params	Object parameters
	additionalProperties	False
camera_near_clip	Camera near clipping distance
	type	number
camera_view	View
	Camera view
	type	object
	properties
	position	Camera position XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	target	Camera target XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	up	Camera up vector XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
channels	Framebuffer channels to export
	type	array
	items	type	string
		enum	color, depth, albedo, normal
file_path	Path to save the buffer as EXR, encoded data is returned if unset
	type	string
renderer	EngineObjectData
	Renderer
	type	object
	properties
	name	Object type name
		type	string
	params	Object parameters
	additionalProperties	False
resolution	Image resolution
	type	array
	items	type	integer
		minimum	0
	maxItems	2
	minItems	2
simulation_frame	Simulation frame to render
	type	integer
	minimum	0
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

get-application-parameters

Get the current state of the application parameters.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

type	object
properties
viewport	Framebuffer resolution in pixels
	type	array
	items	type	integer
		minimum	0
	maxItems	2
	minItems	2
additionalProperties	False

---

get-camera-near-clip

Retreive the current camera clipping distance.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

type	object
properties
distance	Camera near clipping distance
	type	number
additionalProperties	False

---

get-camera-orthographic

Returns the current camera as orthographic.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

type	object
properties
height	Height of the projection plane
	type	number
additionalProperties	False

---

get-camera-perspective

Returns the current camera as perspective.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

type	object
properties
aperture_radius	Lens aperture radius
	type	number
focus_distance	Camera focus distance
	type	number
fovy	Vertical field of view
	type	number
additionalProperties	False

---

get-camera-type

Returns the type of the current camera.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

type

string

---

get-camera-view

Returns the camera view settings.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

type	object
properties
position	Camera position XYZ
	type	array
	items	type	number
	maxItems	3
	minItems	3
target	Camera target XYZ
	type	array
	items	type	number
	maxItems	3
	minItems	3
up	Camera up vector XYZ
	type	array
	items	type	number
	maxItems	3
	minItems	3
additionalProperties	False

---

get-color-methods

Returns a list of available coloring methods for the model.

Params:

type	object
properties
id	Model ID
	type	integer
	minimum	0
additionalProperties	False

Result:

type	array
items	type	string

---

get-color-ramp

Get the color ramp of the given model.

Params:

type	object
properties
id	Model ID
	type	integer
	minimum	0
additionalProperties	False

Result:

type	object
properties
colors	RGBA colors
	type	array
	items	type	array
		items	type	number
		maxItems	4
		minItems	4
	maxItems	256
range	Value range
	type	array
	items	type	number
	maxItems	2
	minItems	2
additionalProperties	False

---

get-color-values

Returns a list of input variables for a given model and color method.

Params:

type	object
properties
id	ID of the model that will be colored
	type	integer
	minimum	0
method	Coloring method which values will be returned
	type	string
additionalProperties	False

Result:

type	array
items	type	string

---

get-loaders

Retreive the description of all available loaders.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

type	array
items	Loader
	type	object
	properties
	binary	True if loader supports loading binary data
		type	boolean
	extensions	Supported file formats / extensions
		type	array
		items	type	string
	input_parameters_schema	JsonSchema
		Loader params schema
		type	object
	name	Loader name
		type	string
	plugin	Plugin required to use the loader
		type	string
	additionalProperties	False

---

get-material-carpaint

Returns the material of the given model as a car paint material, if possible.

Params:

type	object
properties
id	Model ID
	type	integer
	minimum	0
additionalProperties	False

Result:

type	object
properties
flake_density	Metal flake density
	type	number
	maximum	1
	minimum	0
additionalProperties	False

---

get-material-emissive

Returns the material of the given model as a emissive material, if possible.

Params:

type	object
properties
id	Model ID
	type	integer
	minimum	0
additionalProperties	False

Result:

type	object
properties
color	Emission color
	type	array
	items	type	number
	maxItems	3
	minItems	3
intensity	Emission intensity
	type	number
	minimum	0
additionalProperties	False

---

get-material-glass

Returns the material of the given model as a glass material, if possible.

Params:

type	object
properties
id	Model ID
	type	integer
	minimum	0
additionalProperties	False

Result:

type	object
properties
index_of_refraction	Index of refraction of the glass
	type	number
additionalProperties	False

---

get-material-matte

Returns the material of the given model as a matte material, if possible.

Params:

type	object
properties
id	Model ID
	type	integer
	minimum	0
additionalProperties	False

Result:

type	object
properties
opacity	Surface opacity
	type	number
	maximum	1
	minimum	0
additionalProperties	False

---

get-material-metal

Returns the material of the given model as a metal material, if possible.

Params:

type	object
properties
id	Model ID
	type	integer
	minimum	0
additionalProperties	False

Result:

type	object
properties
roughness	Surface roughness
	type	number
	maximum	1
	minimum	0.01
additionalProperties	False

---

get-material-phong

Returns the material of the given model as a phong material, if possible.

Params:

type	object
properties
id	Model ID
	type	integer
	minimum	0
additionalProperties	False

Result:

type	object
properties
opacity	Surface opacity
	type	number
	maximum	1
	minimum	0
additionalProperties	False

---

get-material-plastic

Returns the material of the given model as a plastic material, if possible.

Params:

type	object
properties
id	Model ID
	type	integer
	minimum	0
additionalProperties	False

Result:

type	object
properties
opacity	Surface opacity
	type	number
	maximum	1
	minimum	0
additionalProperties	False

---

get-material-principled

Returns the material of the given model as a principled material, if possible.

Params:

type	object
properties
id	Model ID
	type	integer
	minimum	0
additionalProperties	False

Result:

type	object
properties
anisotropy	Specular anisotropy reflection weight (Specular highlights depends on surface type/shape)
	type	number
	maximum	1
	minimum	0
anisotropy_rotation	Rotation of the specular anisotropy reflection effect
	type	number
	maximum	1
	minimum	0
back_light	For thin objects, weight of reflection and transmission (1 = 50/50, 2 = only transmission)
	type	number
	maximum	2
	minimum	0
coat	Clear coat weight (thin lacquered/glossy layer on top of the surface)
	type	number
	maximum	1
	minimum	0
coat_color	Clear coat color
	type	array
	items	type	number
	maxItems	3
	minItems	3
coat_ior	Clear coat index of refraction
	type	number
coat_roughness	Clear coat diffuse/specular reflection roughness
	type	number
coat_thickness	Clear coat thickness
	type	number
diffuse	Diffuse reflection weight
	type	number
	maximum	1
	minimum	0
edge_color	Edge tint for metallic surfaces
	type	array
	items	type	number
	maxItems	3
	minItems	3
ior	Dielectric index of refraction
	type	number
	minimum	1
metallic	Alpha parameter between dielectric and metallic
	type	number
	maximum	1
	minimum	0
roughness	Diffuse and specular reflection roughness
	type	number
sheen	Sheen effect weight (fabric-like effect such as satin or velvet)
	type	number
sheen_color	Sheen color
	type	array
	items	type	number
	maxItems	3
	minItems	3
sheen_roughness	Sheen diffuse/specular reflection roughness
	type	number
sheen_tint	Strenght of sheen color (0 = white, 1 = sheen color)
	type	number
specular	Specular reflection/transmission weight
	type	number
	maximum	1
	minimum	0
thickness	Thickness of the object if thin = true
	type	number
thin	Specified wether the object is solid or thin (hollow)
	type	boolean
transmission	Specular transmission weight
	type	number
	maximum	1
	minimum	0
transmission_color	Transmission attenuation color
	type	array
	items	type	number
	maxItems	3
	minItems	3
transmission_depth	Distance from surface at which the color will equal transmission color
	type	number
additionalProperties	False

---

get-material-type

Returns the type of the material of a given model, if any.

Params:

type	object
properties
id	Model ID
	type	integer
	minimum	0
additionalProperties	False

Result:

type

string

---

get-model

Get all the information of the given model.

Params:

type	object
properties
id	Model ID
	type	integer
	minimum	0
additionalProperties	False

Result:

type	object
properties
bounds	Bounds
	Model bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
info	ModelInfo
	Model-specific info
	type	object
	properties
	base_transform	Transform
		Model transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	load_info	LoadInfo
		Model load info
		type	object
		properties
		load_parameters	Loader settings
		loader_name	Loader name
			type	string
		path	File path in case of file load type
			type	string
		source	Model load source
			type	string
			enum	from_file, from_blob, none
		additionalProperties	False
	metadata	Model-specific metadata
		type	object
		additionalProperties	type	string
	additionalProperties	False
is_visible	Wether the model is being rendered or not
	type	boolean
model_id	Model ID
	type	integer
	minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

get-renderer-interactive

Returns the current renderer as interactive renderer, if possible.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

type	object
properties
ao_samples	Ambient occlusion samples
	type	integer
	minimum	0
background_color	Background color
	type	array
	items	type	number
	maxItems	4
	minItems	4
enable_shadows	Enable casted shadows when rendering
	type	boolean
max_ray_bounces	Maximum ray bounces
	type	integer
	minimum	0
samples_per_pixel	Ray samples per pixel
	type	integer
	minimum	1
additionalProperties	False

---

get-renderer-production

Returns the current renderer as production renderer, if possible.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

type	object
properties
background_color	Background color
	type	array
	items	type	number
	maxItems	4
	minItems	4
max_ray_bounces	Maximum ray bounces
	type	integer
	minimum	0
samples_per_pixel	Ray samples per pixel
	type	integer
	minimum	1
additionalProperties	False

---

get-renderer-type

Returns the type of the renderer currently being used.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

type

string

---

get-scene

Get the current state of the scene.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

type	object
properties
bounds	Bounds
	Scene bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
models	Scene models
	type	array
	items	ModelInstance
		type	object
		properties
		bounds	Bounds
			Model bounds
			type	object
			properties
			max	Top front right corner XYZ
				type	array
				items	type	number
				maxItems	3
				minItems	3
			min	Bottom back left corner XYZ
				type	array
				items	type	number
				maxItems	3
				minItems	3
			additionalProperties	False
		info	ModelInfo
			Model-specific info
			type	object
			properties
			base_transform	Transform
				Model transform
				type	object
				properties
				rotation	Rotation XYZW
					type	array
					items	type	number
					maxItems	4
					minItems	4
				scale	Scale XYZ
					type	array
					items	type	number
					maxItems	3
					minItems	3
				translation	Translation XYZ
					type	array
					items	type	number
					maxItems	3
					minItems	3
				additionalProperties	False
			load_info	LoadInfo
				Model load info
				type	object
				properties
				load_parameters	Loader settings
				loader_name	Loader name
					type	string
				path	File path in case of file load type
					type	string
				source	Model load source
					type	string
					enum	from_file, from_blob, none
				additionalProperties	False
			metadata	Model-specific metadata
				type	object
				additionalProperties	type	string
			additionalProperties	False
		is_visible	Wether the model is being rendered or not
			type	boolean
		model_id	Model ID
type			integer
minimum			0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False
additionalProperties	False

---

get-simulation-parameters

Get the current state of the simulation parameters.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

type	object
properties
current	Current simulation frame index
	type	integer
	minimum	0
dt	Delta time between two frames
	type	number
end_frame	Final simulation frame index
	type	integer
	minimum	0
start_frame	Initial simulation frame index
	type	integer
	minimum	0
unit	Time unit
	type	string
additionalProperties	False

---

get-version

Get Brayns version.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

type	object
properties
copyright	Copyright statement
	type	string
major	Major version
	type	integer
minor	Minor version
	type	integer
patch	Patch version
	type	integer
pre_release	Pre-release
	type	integer
tag	Full tag major.minor.path[-preRelease]
	type	string
additionalProperties	False

---

inspect

Inspect the scene at x-y position.

Params:

type	object
properties
position	Normalized screen position XY
	type	array
	items	type	number
	maxItems	2
	minItems	2
additionalProperties	False

Result:

type	object
properties
hit	True if a model was at given position, otherwise the rest is invalid
	type	boolean
metadata	Extra attributes depending on the type of model hitted
model_id	ID of the model that was hit at given position
	type	integer
	minimum	0
position	World position XYZ where the model was hit
	type	array
	items	type	number
	maxItems	3
	minItems	3
additionalProperties	False

---

instantiate-model

Creates new instances of the given model. The underneath data is shared across all instances.

Params:

type	object
properties
model_id	ID of the model to instantiate
	type	integer
	minimum	0
transforms	Transformations to apply to the new instances
	type	array
	items	Transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
additionalProperties	False

Result:

type	array
items	ModelInstance
	type	object
	properties
	bounds	Bounds
		Model bounds
		type	object
		properties
		max	Top front right corner XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		min	Bottom back left corner XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	info	ModelInfo
		Model-specific info
		type	object
		properties
		base_transform	Transform
			Model transform
			type	object
			properties
			rotation	Rotation XYZW
				type	array
				items	type	number
				maxItems	4
				minItems	4
			scale	Scale XYZ
				type	array
				items	type	number
				maxItems	3
				minItems	3
			translation	Translation XYZ
				type	array
				items	type	number
				maxItems	3
				minItems	3
			additionalProperties	False
		load_info	LoadInfo
			Model load info
			type	object
			properties
			load_parameters	Loader settings
			loader_name	Loader name
				type	string
			path	File path in case of file load type
				type	string
			source	Model load source
				type	string
				enum	from_file, from_blob, none
			additionalProperties	False
		metadata	Model-specific metadata
			type	object
			additionalProperties	type	string
		additionalProperties	False
	is_visible	Wether the model is being rendered or not
		type	boolean
	model_id	Model ID
		type	integer
		minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

quit

Quit the application.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

registry

Retreive the names of all registered entrypoints.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

type	array
items	type	string

---

remove-model

Remove the model(s) from the ID list from the scene.

Params:

type	object
properties
ids	Model ID list
	type	array
	items	type	integer
		minimum	0
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

render-image

Render an image of the current context and retreive it according to given params.

Params:

type	object
properties
accumulate	Render all images until max accumulation
	type	boolean
	default	False
force	Send image even if nothing new was rendered
	type	boolean
	default	False
format	Encoding of returned image data (jpg or png)
	type	string
	default	jpg
jpeg_quality	Quality if using JPEG encoding
	type	integer
	maximum	100
	minimum	0
	default	100
render	Disable render if set to false (download only)
	type	boolean
	default	True
send	Send image once rendered
	type	boolean
	default	True
additionalProperties	False

Result:

type	object
properties
accumulation	Current frame accumulation
	type	integer
	minimum	0
max_accumulation	Maximum frame accumulation
	type	integer
	minimum	0
additionalProperties	False

---

schema

Get the JSON schema of the given entrypoint.

Params:

type	object
properties
endpoint	Name of the endpoint
	type	string
additionalProperties	False

Result:

type	object
properties
async	Check if the entrypoint is asynchronous (send progress and can be cancelled)
	type	boolean
deprecated	If true, the entrypoint will be removed / renamed in the next release
	type	boolean
description	Description of the entrypoint
	type	string
params	JsonSchema
	Input schema
	type	object
plugin	Name of the plugin that loads the entrypoint
	type	string
returns	JsonSchema
	Output schema
	type	object
title	Name of the entrypoint (method)
	type	string
additionalProperties	False

---

set-application-parameters

Set the current state of the application parameters.

Params:

type	object
properties
viewport	Framebuffer resolution in pixels
	type	array
	items	type	integer
		minimum	0
	maxItems	2
	minItems	2
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-camera-near-clip

Update the camera near clipping distance.

Params:

type	object
properties
distance	Camera near clipping distance
	type	number
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-camera-orthographic

Sets the current camera to an orthographic one, with the specified parameters.

Params:

type	object
properties
height	Height of the projection plane
	type	number
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-camera-perspective

Sets the current camera to a perspective one, with the specified parameters.

Params:

type	object
properties
aperture_radius	Lens aperture radius
	type	number
focus_distance	Camera focus distance
	type	number
fovy	Vertical field of view
	type	number
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-camera-view

Sets the camera view settings.

Params:

type	object
properties
position	Camera position XYZ
	type	array
	items	type	number
	maxItems	3
	minItems	3
target	Camera target XYZ
	type	array
	items	type	number
	maxItems	3
	minItems	3
up	Camera up vector XYZ
	type	array
	items	type	number
	maxItems	3
	minItems	3
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-color-ramp

Set the color ramp of the given model.

Params:

type	object
properties
color_ramp	ColorRamp
	Color ramp
	type	object
	properties
	colors	RGBA colors
		type	array
		items	type	array
			items	type	number
			maxItems	4
			minItems	4
		maxItems	256
	range	Value range
		type	array
		items	type	number
		maxItems	2
		minItems	2
	additionalProperties	False
id	Model ID
	type	integer
	minimum	0
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-framebuffer-progressive

Stablishes a progressive-resolution frame rendering on the engine.

Params:

type	object
properties
scale	Frame size reduction factor
	type	integer
	minimum	1
	default	4
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-framebuffer-static

Stablishes a static frame rendering on the engine.

Params:

This entrypoint has no params, the “params” field can hence be omitted or null.

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-material-carpaint

Updates the material of the given model to a car paint material. This material is only usable with the production renderer.

Params:

type	object
properties
material	CarPaint
	Material parameters
	type	object
	properties
	flake_density	Metal flake density
		type	number
		maximum	1
		minimum	0
	additionalProperties	False
model_id	ID of the model to apply the material
	type	integer
	minimum	0
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-material-emissive

Updates the material of the given model to an emisive material. This material is only usable with the production renderer.

Params:

type	object
properties
material	Emissive
	Material parameters
	type	object
	properties
	color	Emission color
		type	array
		items	type	number
		maxItems	3
		minItems	3
	intensity	Emission intensity
		type	number
		minimum	0
	additionalProperties	False
model_id	ID of the model to apply the material
	type	integer
	minimum	0
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-material-glass

Updates the material of the given model to a glass material. This material is only usable with the production renderer.

Params:

type	object
properties
material	Glass
	Material parameters
	type	object
	properties
	index_of_refraction	Index of refraction of the glass
		type	number
	additionalProperties	False
model_id	ID of the model to apply the material
	type	integer
	minimum	0
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-material-matte

Updates the material of the given model to a matte material. This material is only usable with the production renderer.

Params:

type	object
properties
material	Matte
	Material parameters
	type	object
	properties
	opacity	Surface opacity
		type	number
		maximum	1
		minimum	0
	additionalProperties	False
model_id	ID of the model to apply the material
	type	integer
	minimum	0
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-material-metal

Updates the material of the given model to a metal material. This material is only usable with the production renderer.

Params:

type	object
properties
material	Metal
	Material parameters
	type	object
	properties
	roughness	Surface roughness
		type	number
		maximum	1
		minimum	0.01
	additionalProperties	False
model_id	ID of the model to apply the material
	type	integer
	minimum	0
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-material-phong

Updates the material of the given model to the phong material. This material works with all renderers. It has a matte appearance..

Params:

type	object
properties
material	Phong
	Material parameters
	type	object
	properties
	opacity	Surface opacity
		type	number
		maximum	1
		minimum	0
	additionalProperties	False
model_id	ID of the model to apply the material
	type	integer
	minimum	0
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-material-plastic

Updates the material of the given model to a plastic material. This material is only usable with the production renderer.

Params:

type	object
properties
material	Plastic
	Material parameters
	type	object
	properties
	opacity	Surface opacity
		type	number
		maximum	1
		minimum	0
	additionalProperties	False
model_id	ID of the model to apply the material
	type	integer
	minimum	0
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-material-principled

Updates the material of the given model to a principled material. This material is only usable with the production renderer.

Params:

type	object
properties
material	Principled
	Material parameters
	type	object
	properties
	anisotropy	Specular anisotropy reflection weight (Specular highlights depends on surface type/shape)
		type	number
		maximum	1
		minimum	0
	anisotropy_rotation	Rotation of the specular anisotropy reflection effect
		type	number
		maximum	1
		minimum	0
	back_light	For thin objects, weight of reflection and transmission (1 = 50/50, 2 = only transmission)
		type	number
		maximum	2
		minimum	0
	coat	Clear coat weight (thin lacquered/glossy layer on top of the surface)
		type	number
		maximum	1
		minimum	0
	coat_color	Clear coat color
		type	array
		items	type	number
		maxItems	3
		minItems	3
	coat_ior	Clear coat index of refraction
		type	number
	coat_roughness	Clear coat diffuse/specular reflection roughness
		type	number
	coat_thickness	Clear coat thickness
		type	number
	diffuse	Diffuse reflection weight
		type	number
		maximum	1
		minimum	0
	edge_color	Edge tint for metallic surfaces
		type	array
		items	type	number
		maxItems	3
		minItems	3
	ior	Dielectric index of refraction
		type	number
		minimum	1
	metallic	Alpha parameter between dielectric and metallic
		type	number
		maximum	1
		minimum	0
	roughness	Diffuse and specular reflection roughness
		type	number
	sheen	Sheen effect weight (fabric-like effect such as satin or velvet)
		type	number
	sheen_color	Sheen color
		type	array
		items	type	number
		maxItems	3
		minItems	3
	sheen_roughness	Sheen diffuse/specular reflection roughness
		type	number
	sheen_tint	Strenght of sheen color (0 = white, 1 = sheen color)
		type	number
	specular	Specular reflection/transmission weight
		type	number
		maximum	1
		minimum	0
thickness	Thickness of the object if thin = true
	type	number
thin	Specified wether the object is solid or thin (hollow)
	type	boolean
transmission	Specular transmission weight
	type	number
	maximum	1
	minimum	0
transmission_color	Transmission attenuation color
	type	array
	items	type	number
	maxItems	3
	minItems	3
transmission_depth	Distance from surface at which the color will equal transmission color
	type	number
additionalProperties	False
model_id	ID of the model to apply the material
	type	integer
	minimum	0
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-renderer-interactive

Sets the system renderer to the interactive one.

Params:

type	object
properties
ao_samples	Ambient occlusion samples
	type	integer
	minimum	0
background_color	Background color
	type	array
	items	type	number
	maxItems	4
	minItems	4
enable_shadows	Enable casted shadows when rendering
	type	boolean
max_ray_bounces	Maximum ray bounces
	type	integer
	minimum	0
samples_per_pixel	Ray samples per pixel
	type	integer
	minimum	1
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-renderer-production

Sets the system renderer to the production one.

Params:

type	object
properties
background_color	Background color
	type	array
	items	type	number
	maxItems	4
	minItems	4
max_ray_bounces	Maximum ray bounces
	type	integer
	minimum	0
samples_per_pixel	Ray samples per pixel
	type	integer
	minimum	1
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

set-simulation-parameters

Set the current state of the simulation parameters.

Params:

type	object
properties
current	Current simulation frame index
	type	integer
	minimum	0
dt	Delta time between two frames
	type	number
end_frame	Final simulation frame index
	type	integer
	minimum	0
start_frame	Initial simulation frame index
	type	integer
	minimum	0
unit	Time unit
	type	string
additionalProperties	False

Result:

This entrypoint has no result, the “result” field is still present but is always null.

---

snapshot

Take a snapshot with given parameters.

This entrypoint is asynchronous, it means that it can take a long time and send progress notifications.

Params:

type	object
properties
camera	EngineObjectData
	Camera definition
	type	object
	properties
	name	Object type name
		type	string
	params	Object parameters
	additionalProperties	False
camera_near_clip	Camera near clipping distance
	type	number
camera_view	View
	Camera view
	type	object
	properties
	position	Camera position XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	target	Camera target XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	up	Camera up vector XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
file_path	Path to save image, raw encoded data will be returned if empty
	type	string
image_settings	ImageSettings
	Image settings
	type	object
	properties
	format	Image format (jpg or png)
		type	string
		default	png
	quality	Image quality (0 = lowest quality, 100 = highest quality
		type	integer
		minimum	0
		default	100
	size	Image width and height
		type	array
		items	type	integer
			minimum	0
		maxItems	2
		minItems	2
	additionalProperties	False
metadata	ImageMetadata
	Metadata information to embed into the image
	type	object
	properties
	description	Image description
		type	string
	keywords	List of keywords to describe the image contents
		type	array
		items	type	string
	title	Image title
		type	string
	where_used	Event (publication, website, panel, etc.) for what the image was created
		type	string
	additionalProperties	False
renderer	EngineObjectData
	Renderer definition
	type	object
	properties
	name	Object type name
		type	string
	params	Object parameters
	additionalProperties	False
simulation_frame	Simulation frame to render
	type	integer
	minimum	0
additionalProperties	False

Result:

type	object
properties
color_buffer	ColorBufferMessage
	Encoded snapshot color buffer
	type	object
	properties
	offset	Data offset in attached binary
		type	integer
		minimum	0
	size	Data size in attached binary
		type	integer
		minimum	0
	additionalProperties	False
additionalProperties	False

---

update-model

Update the model with the given values and return its new state.

Params:

type	object
properties
model	ModelInstance
	Model data to update
	type	object
	properties
	bounds	Bounds
		Model bounds
		type	object
		properties
		max	Top front right corner XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		min	Bottom back left corner XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	info	ModelInfo
		Model-specific info
		type	object
		properties
		base_transform	Transform
			Model transform
			type	object
			properties
			rotation	Rotation XYZW
				type	array
				items	type	number
				maxItems	4
				minItems	4
			scale	Scale XYZ
				type	array
				items	type	number
				maxItems	3
				minItems	3
			translation	Translation XYZ
				type	array
				items	type	number
				maxItems	3
				minItems	3
			additionalProperties	False
		load_info	LoadInfo
			Model load info
			type	object
			properties
			load_parameters	Loader settings
			loader_name	Loader name
				type	string
			path	File path in case of file load type
				type	string
			source	Model load source
				type	string
				enum	from_file, from_blob, none
			additionalProperties	False
		metadata	Model-specific metadata
			type	object
			additionalProperties	type	string
		additionalProperties	False
	is_visible	Wether the model is being rendered or not
		type	boolean
	model_id	Model ID
		type	integer
minimum		0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False
model_id	Model ID
	type	integer
	minimum	0
additionalProperties	False

Result:

type	object
properties
bounds	Bounds
	Model bounds
	type	object
	properties
	max	Top front right corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	min	Bottom back left corner XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
info	ModelInfo
	Model-specific info
	type	object
	properties
	base_transform	Transform
		Model transform
		type	object
		properties
		rotation	Rotation XYZW
			type	array
			items	type	number
			maxItems	4
			minItems	4
		scale	Scale XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		translation	Translation XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	load_info	LoadInfo
		Model load info
		type	object
		properties
		load_parameters	Loader settings
		loader_name	Loader name
			type	string
		path	File path in case of file load type
			type	string
		source	Model load source
			type	string
			enum	from_file, from_blob, none
		additionalProperties	False
	metadata	Model-specific metadata
		type	object
		additionalProperties	type	string
	additionalProperties	False
is_visible	Wether the model is being rendered or not
	type	boolean
model_id	Model ID
	type	integer
	minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False

---

upload-model

Upload a model from binary request data and return model descriptors on success.

This entrypoint is asynchronous, it means that it can take a long time and send progress notifications.

Params:

type	object
properties
loader_name	Loader name
	type	string
loader_properties	Loader properties
type	File extension
	type	string
additionalProperties	False

Result:

type	array
items	ModelInstance
	type	object
	properties
	bounds	Bounds
		Model bounds
		type	object
		properties
		max	Top front right corner XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		min	Bottom back left corner XYZ
			type	array
			items	type	number
			maxItems	3
			minItems	3
		additionalProperties	False
	info	ModelInfo
		Model-specific info
		type	object
		properties
		base_transform	Transform
			Model transform
			type	object
			properties
			rotation	Rotation XYZW
				type	array
				items	type	number
				maxItems	4
				minItems	4
			scale	Scale XYZ
				type	array
				items	type	number
				maxItems	3
				minItems	3
			translation	Translation XYZ
				type	array
				items	type	number
				maxItems	3
				minItems	3
			additionalProperties	False
		load_info	LoadInfo
			Model load info
			type	object
			properties
			load_parameters	Loader settings
			loader_name	Loader name
				type	string
			path	File path in case of file load type
				type	string
			source	Model load source
				type	string
				enum	from_file, from_blob, none
			additionalProperties	False
		metadata	Model-specific metadata
			type	object
			additionalProperties	type	string
		additionalProperties	False
	is_visible	Wether the model is being rendered or not
		type	boolean
	model_id	Model ID
		type	integer
		minimum	0
model_type	Model type
	type	string
transform	Transform
	Model transform
	type	object
	properties
	rotation	Rotation XYZW
		type	array
		items	type	number
		maxItems	4
		minItems	4
	scale	Scale XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	translation	Translation XYZ
		type	array
		items	type	number
		maxItems	3
		minItems	3
	additionalProperties	False
additionalProperties	False