ExperimentalInterface schemas

Type-specific details of experimental interfaces: the point where hardware meets the animal or tissue, such as an implanted probe, a cranial window or an optic fiber.

Table of contents

1. How to use this family
2. Quick type map
3. Electrophysiology
   1. ECG
   2. ECoG
   3. EEG
   4. EMG
   5. Ground electrode
   6. Multi-electrode array (MEA)
   7. Nerve cuff
   8. Patch pipette
   9. Reference electrode
   10. Silicon probe
   11. Single wire electrode
   12. Tetrode
   13. Tungsten microelectrode
4. Physiological monitoring
   1. Blood-pressure sensor
   2. Respiratory sensor
5. Optical
   1. Cranial window
   2. GRIN lens
   3. Microscope objective
   4. Miniscope
   5. Optic fiber
   6. Prism
   7. Widefield macroscope
6. Assemblies
   1. Headcap
   2. Headpost
7. Behavioral and Environmental
   1. Camera
   2. Microphone
   3. Tracking system
8. Delivery
   1. Bath perfusion
   2. Catheter
   3. Drug delivery line
   4. Injection cannula
   5. Microperfusion line
   6. Osmotic pump
9. Stimulation
   1. Auditory stimulator
   2. LED array
   3. Olfactometer
   4. Stimulating electrode
   5. TMS coil
   6. Tactile stimulator
   7. Thermal probe
   8. Ultrasound transducer
   9. Visual stimulator
10. Generic
    1. Generic interface
11. Target specimens

How to use this family

• experimentalinterface: set type to a type code below and send its properties in details.
• experimentalinterfacetemplate: set type to a type code below and send its properties in details.
• Every version is published at https://www.brainstem.org/schemas/ExperimentalInterface/<Type>/<version>.json and never changes; https://www.brainstem.org/schemas/ExperimentalInterface/<Type>.json is the current version and https://www.brainstem.org/schemas/ExperimentalInterface/<Type>/ lists the versions. See Public schemas.
• Quantities are objects {"value": <number>, "unit": "<code>"}. Property paths with [] are inside a repeatable list of rows. The server sets the schema version field itself.

Quick type map

Type code	Title	Group	Version	Required properties	Schema
AuditoryStimulator	Auditory stimulator	Stimulation	1.0.3	none	1.0.3.json
BathPerfusion	Bath perfusion	Delivery	2.0.1	none	2.0.1.json
BloodPressureSensor	Blood-pressure sensor	Physiological monitoring	1.0.0	none	1.0.0.json
Camera	Camera	Behavioral and Environmental	2.0.1	none	2.0.1.json
Catheter	Catheter	Delivery	2.0.1	none	2.0.1.json
CranialWindow	Cranial window	Optical	2.0.1	none	2.0.1.json
DrugDeliveryLine	Drug delivery line	Delivery	2.0.1	none	2.0.1.json
ECG	ECG	Electrophysiology	1.0.2	none	1.0.2.json
ECoG	ECoG	Electrophysiology	1.0.0	none	1.0.0.json
EEG	EEG	Electrophysiology	1.0.2	none	1.0.2.json
EMG	EMG	Electrophysiology	1.0.2	none	1.0.2.json
GRINLens	GRIN lens	Optical	1.0.0	none	1.0.0.json
Generic	Generic interface	Generic	1.0.2	none	1.0.2.json
GroundElectrode	Ground electrode	Electrophysiology	2.0.1	none	2.0.1.json
Headcap	Headcap	Assemblies	2.0.1	none	2.0.1.json
Headpost	Headpost	Assemblies	1.0.0	none	1.0.0.json
InjectionCannula	Injection cannula	Delivery	2.0.1	none	2.0.1.json
LEDArray	LED array	Stimulation	2.0.1	none	2.0.1.json
MicroperfusionLine	Microperfusion line	Delivery	2.0.1	none	2.0.1.json
Microphone	Microphone	Behavioral and Environmental	2.0.1	none	2.0.1.json
MicroscopeObjective	Microscope objective	Optical	2.0.1	none	2.0.1.json
Miniscope	Miniscope	Optical	2.0.1	none	2.0.1.json
MultiElectrodeArray	Multi-electrode array (MEA)	Electrophysiology	2.0.1	none	2.0.1.json
NerveCuff	Nerve cuff	Electrophysiology	1.0.2	none	1.0.2.json
Olfactometer	Olfactometer	Stimulation	1.0.2	none	1.0.2.json
OpticFiber	Optic fiber	Optical	1.0.0	none	1.0.0.json
OsmoticPump	Osmotic pump	Delivery	2.0.1	none	2.0.1.json
PatchPipette	Patch pipette	Electrophysiology	2.0.1	none	2.0.1.json
Prism	Prism	Optical	1.0.0	none	1.0.0.json
ReferenceElectrode	Reference electrode	Electrophysiology	2.0.1	none	2.0.1.json
RespiratorySensor	Respiratory sensor	Physiological monitoring	1.0.0	none	1.0.0.json
SiliconProbe	Silicon probe	Electrophysiology	2.0.1	none	2.0.1.json
SingleWireElectrode	Single wire electrode	Electrophysiology	2.0.1	none	2.0.1.json
StimulatingElectrode	Stimulating electrode	Stimulation	2.0.1	none	2.0.1.json
TMSCoil	TMS coil	Stimulation	2.0.1	none	2.0.1.json
TactileStimulator	Tactile stimulator	Stimulation	1.0.3	none	1.0.3.json
TargetSpecimens	Target specimens (form only)		1.0.2	none	1.0.2.json
Tetrode	Tetrode	Electrophysiology	2.0.1	none	2.0.1.json
ThermalProbe	Thermal probe	Stimulation	2.0.1	none	2.0.1.json
TrackingSystem	Tracking system	Behavioral and Environmental	2.0.1	none	2.0.1.json
TungstenMicroelectrode	Tungsten microelectrode	Electrophysiology	2.0.1	none	2.0.1.json
UltrasoundTransducer	Ultrasound transducer	Stimulation	2.0.1	none	2.0.1.json
VisualStimulator	Visual stimulator	Stimulation	1.0.3	none	1.0.3.json
WidefieldMacroscope	Widefield macroscope	Optical	2.0.1	none	2.0.1.json

Electrophysiology

ECG

• type code ECG · version 1.0.2 · schema

Electrodes recording cardiac electrical activity.

Property	Title	Shape	Required	Allowed values	Meaning
leadConfiguration	Lead configuration	text			The arrangement and roles of the installed ECG leads.
electrodeLayout	Electrode layout	text (multi-line)			The spatial arrangement of electrodes in the installed interface.

Illustrative payload:

{
    "leadConfiguration": "text",
    "electrodeLayout": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
ElectrodeAssembly (Electrode assembly)	yes		ElectrodeComponent, SingleWireElectrode, ConsumableDevice	ElectrodeComponent, SingleWireElectrode, ConsumableDevice	yes
GroundElectrode (Ground electrode)			ElectrodeComponent, SingleWireElectrode	ElectrodeComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

ECoG

• type code ECoG · version 1.0.0 · schema

A grid or strip array of contacts installed on the dura, on the brain surface, or on thinned skull. Created by an ECoG implant procedure; the array’s design (contact count, pitch, substrate) lives on the ECoG array material row and its catalog entry.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
placementLayer	Placement layer	choice		one of epidural, subdural, epicranial	Which tissue layer the installed array rests on: the dura, the brain surface under an opened dura, or the bone.
referenceConfiguration	Reference configuration	text			How the array’s reference input is wired as installed: a skull screw, an on-array contact or a recording contact.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "placementLayer": "epidural"
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
EcogArray (ECoG array)	yes		EcogArray	EcogArrayDesign	yes
ReferenceElectrode (Reference electrode)			ElectrodeComponent, SingleWireElectrode	ElectrodeComponent, SingleWireElectrode	yes
GroundElectrode (Ground electrode)			ElectrodeComponent, SingleWireElectrode	ElectrodeComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
ShieldingMaterial (Shielding material)			ImplantMaterial, ConsumableDevice	ImplantMaterial, ConsumableDevice	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Fastener (Anchor screw, pin, or fastener)			FastenerAnchor	FastenerAnchor	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

EEG

• type code EEG · version 1.0.2 · schema

Electrodes recording large-scale activity on or beneath the skull.

Property	Title	Shape	Required	Allowed values	Meaning
electrodeLayout	Electrode layout	text (multi-line)			The spatial arrangement of electrodes in the installed interface.
channelCount	Channel count	integer		≥ 0	The number of channels configured and available on this installed interface.

Illustrative payload:

{
    "electrodeLayout": "text",
    "channelCount": 1
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
ElectrodeAssembly (Electrode assembly)	yes		ElectrodeComponent, SingleWireElectrode, ConsumableDevice	ElectrodeComponent, SingleWireElectrode, ConsumableDevice	yes
ReferenceElectrode (Reference electrode)			ElectrodeComponent, SingleWireElectrode	ElectrodeComponent, SingleWireElectrode	yes
GroundElectrode (Ground electrode)			ElectrodeComponent, SingleWireElectrode	ElectrodeComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
ShieldingMaterial (Shielding material)			ImplantMaterial, ConsumableDevice	ImplantMaterial, ConsumableDevice	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Fastener (Anchor screw, pin, or fastener)			FastenerAnchor	FastenerAnchor	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

EMG

• type code EMG · version 1.0.2 · schema

Electrodes in or on muscle.

Property	Title	Shape	Required	Allowed values	Meaning
muscle	Muscle	text			The muscle targeted by the installed EMG interface.
electrodeLayout	Electrode layout	text (multi-line)			The spatial arrangement of electrodes in the installed interface.

Illustrative payload:

{
    "muscle": "text",
    "electrodeLayout": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
ElectrodeAssembly (Electrode assembly)	yes		ElectrodeComponent, SingleWireElectrode, ConsumableDevice	ElectrodeComponent, SingleWireElectrode, ConsumableDevice	yes
ReferenceElectrode (Reference electrode)			ElectrodeComponent, SingleWireElectrode	ElectrodeComponent, SingleWireElectrode	yes
GroundElectrode (Ground electrode)			ElectrodeComponent, SingleWireElectrode	ElectrodeComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

Ground electrode

• type code GroundElectrode · version 2.0.1 · schema

Ties the preparation to circuit ground. Keep it separate from the reference electrode even when one screw serves both, and say so in Notes.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
groundSite	Ground site	text			The anatomical or apparatus site used for the ground electrode.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "groundSite": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
GroundElectrode (Ground electrode)	yes		ElectrodeComponent, SingleWireElectrode	ElectrodeComponent, SingleWireElectrode	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

Multi-electrode array (MEA)

• type code MultiElectrodeArray · version 2.0.1 · schema

A planar or grid array of electrodes, common for ex-vivo and surface recording.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
electrodeCount	Electrode count	integer		≥ 0	The number of electrodes present on the configured array.
electrodePitchUm	Electrode pitch (µm)	number		≥ 0	Centre-to-centre distance between adjacent electrodes.
electrodeDiameterUm	Electrode diameter (µm)	number		≥ 0	The electrode diameter in micrometres.
substrateType	Substrate type	text			The material or construction type of the electrode-array substrate.
referenceConfiguration	Reference configuration	text			The reference-channel or reference-electrode arrangement used by the interface.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "electrodeCount": 1
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
MultiElectrodeArray (Multi-electrode array)	yes		ConsumableDevice, ElectrodeComponent, SingleWireElectrode	ConsumableDevice, ElectrodeComponent, SingleWireElectrode	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

Nerve cuff

• type code NerveCuff · version 1.0.2 · schema

A cuff placed around a peripheral nerve to record or stimulate.

Property	Title	Shape	Required	Allowed values	Meaning
nerve	Nerve	text			The nerve enclosed or contacted by the installed cuff.
contactCount	Contact count	integer		≥ 0	The number of electrical contacts configured on the installed interface.
cuffSize	Cuff size	text			The cuff size fitted to the target nerve, including the sizing convention or units.

Illustrative payload:

{
    "nerve": "text",
    "contactCount": 1
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
NerveCuff (Nerve cuff)	yes		ConsumableDevice, ImplantMaterial, ElectrodeComponent	ConsumableDevice, ImplantMaterial, ElectrodeComponent	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
ReferenceElectrode (Reference electrode)			ElectrodeComponent, SingleWireElectrode	ElectrodeComponent, SingleWireElectrode	yes
GroundElectrode (Ground electrode)			ElectrodeComponent, SingleWireElectrode	ElectrodeComponent, SingleWireElectrode	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

Patch pipette

• type code PatchPipette · version 2.0.1 · schema

A glass pipette sealed to a cell for intracellular recording.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
patchType	Patch configuration	choice		one of whole_cell, cell_attached, perforated_patch, outside_out, inside_out, other	Patch-clamp recording configuration used.
resistance	Pipette resistance	quantity with unit		units kΩ, MΩ, GΩ; default {"unit": "MΩ"}	Pipette resistance in the bath before seal formation.
sealResistance	Seal resistance	quantity with unit		units kΩ, MΩ, GΩ; default {"unit": "GΩ"}	Gigaseal resistance achieved before break-in (whole-cell) or during recording (cell-attached).

Illustrative payload:

{
    "deviceIdentifier": "text",
    "patchType": "whole_cell"
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
PatchPipette (Patch pipette)	yes		ConsumableDevice	ConsumableDevice	yes
Buffer (Internal solution)			PhysiologicalSolution, ChemicalReagent	PhysiologicalSolution, ChemicalReagent	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
Other (Other material)					yes

Reference electrode

• type code ReferenceElectrode · version 2.0.1 · schema

Supplies the reference potential the recording channels are measured against.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
referenceSite	Reference site	text			The anatomical or apparatus site used for the reference electrode.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "referenceSite": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
ElectrodeAssembly (Electrode assembly)			ElectrodeComponent, SingleWireElectrode, ConsumableDevice	ElectrodeComponent, SingleWireElectrode, ConsumableDevice	yes
ReferenceElectrode (Reference electrode)	yes		ElectrodeComponent, SingleWireElectrode	ElectrodeComponent, SingleWireElectrode	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

Silicon probe

• type code SiliconProbe · version 2.0.1 · schema

A silicon-based probe carrying many recording sites, often on several shanks.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
channelCount	Active channel count	integer		≥ 0	The number of channels configured and available on this installed interface.
shankCount	Configured shank count	integer		≥ 0	The number of probe shanks configured for this installed interface.
referenceConfiguration	Reference configuration	text			The reference-channel or reference-electrode arrangement used by the interface.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "channelCount": 1
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
SiliconProbe (Silicon probe)	yes		SiliconProbe	SiliconProbeDesign	yes
FixedPositioningAssembly (Fixed probe carrier or shuttle)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
ManualMicrodrive (Manual probe microdrive)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
MotorizedMicrodrive (Motorized probe microdrive)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, SingleWireElectrode	ConsumableDevice, ImplantMaterial, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
Fastener (Anchor screw, pin, or fastener)			FastenerAnchor	FastenerAnchor	yes
Other (Other material)					yes

Single wire electrode

• type code SingleWireElectrode · version 2.0.1 · schema

One insulated wire electrode used for recording or stimulation.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
wireMaterial	Wire material	text			The conductor material of the installed electrode wire.
impedance	Impedance	text			The nominal or measured impedance of the installed electrode, including frequency context when known.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "wireMaterial": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
SingleWireElectrode (Single-wire electrode)	yes		SingleWireElectrode, ConsumableDevice	SingleWireElectrode, ConsumableDevice	yes
FixedPositioningAssembly (Fixed electrode carrier or shuttle)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
ManualMicrodrive (Manual electrode microdrive)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
MotorizedMicrodrive (Motorized electrode microdrive)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

Tetrode

• type code Tetrode · version 2.0.1 · schema

A four-wire bundle used to separate nearby single units.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
tetrodeCount	Tetrode count	integer		≥ 0	The number of tetrodes configured in the installed interface.
wireMaterial	Wire material	text			The conductor material of the installed electrode wire.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "tetrodeCount": 1
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
ElectrodeAssembly (Electrode assembly)	yes		SingleWireElectrode, ElectrodeComponent, ConsumableDevice	SingleWireElectrode, ElectrodeComponent, ConsumableDevice	yes
FixedPositioningAssembly (Fixed electrode carrier or shuttle)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
ManualMicrodrive (Manual electrode microdrive)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
MotorizedMicrodrive (Motorized electrode microdrive)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
ReferenceElectrode (Reference electrode)			ElectrodeComponent, SingleWireElectrode	ElectrodeComponent, SingleWireElectrode	yes
GroundElectrode (Ground electrode)			ElectrodeComponent, SingleWireElectrode	ElectrodeComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Fastener (Anchor screw, pin, or fastener)			FastenerAnchor	FastenerAnchor	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

Tungsten microelectrode

• type code TungstenMicroelectrode · version 2.0.1 · schema

A sharpened metal microelectrode, typically for acute single-unit recording.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
impedanceMohm	Impedance (MΩ)	number		≥ 0	Electrode impedance measured at 1 kHz.
tipDiameterUm	Tip diameter (µm)	number		≥ 0	The electrode-tip diameter in micrometres.
shaftDiameterUm	Shaft diameter (µm)	number		≥ 0	The electrode-shaft diameter in micrometres.
referenceConfiguration	Reference configuration	text			The reference-channel or reference-electrode arrangement used by the interface.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "impedanceMohm": 1.0
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
SingleWireElectrode (Single-wire electrode)	yes		ConsumableDevice, SingleWireElectrode	ConsumableDevice, SingleWireElectrode	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

Physiological monitoring

Blood-pressure sensor

• type code BloodPressureSensor · version 1.0.0 · schema

Represents a sensor that monitors the subject’s blood pressure, such as an implanted telemetry catheter or an arterial pressure transducer.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
BloodPressureSensor (Blood-pressure sensor)	yes		ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

Respiratory sensor

• type code RespiratorySensor · version 1.0.0 · schema

Represents a sensor that monitors the subject’s breathing, such as a nasal thermistor, thermocouple, pressure sensor or plethysmograph.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
RespiratorySensor (Respiratory sensor)	yes		ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

Optical

Cranial window

• type code CranialWindow · version 2.0.1 · schema

A transparent window giving optical access to the brain surface.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
windowMaterial	Window material	text			The material forming the transparent portion of the cranial window.
diameterMm	Diameter (mm)	number		≥ 0	The installed cranial-window diameter in millimetres.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "windowMaterial": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
CranialWindow (Cranial window)	yes		ConsumableDevice, ImplantMaterial, OpticalComponent	ConsumableDevice, ImplantMaterial, OpticalComponent	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Fastener (Anchor screw, pin, or fastener)			FastenerAnchor	FastenerAnchor	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
Other (Other material)					yes

GRIN lens

• type code GRINLens · version 1.0.0 · schema

A gradient-index lens giving optical access to deep tissue.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
protrusionAboveSkull	Protrusion above skull	quantity with unit		units µm, mm; default {"unit": "mm"}	Distance from the skull surface at the implant site to the top face of the lens; not the lens’s own length.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "protrusionAboveSkull": {
        "value": 1,
        "unit": "mm"
    }
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
GrinLens (GRIN lens)	yes		OpticalComponent, ConsumableDevice	OpticalComponent, ConsumableDevice	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Fastener (Anchor screw, pin, or fastener)			FastenerAnchor	FastenerAnchor	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

Microscope objective

• type code MicroscopeObjective · version 2.0.1 · schema

The objective through which the preparation is imaged, when it is worth recording as a target-facing interface.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
magnification	Magnification	text			The nominal magnification of the configured microscope objective.
numericalAperture	Numerical aperture	number		≥ 0	The numerical aperture of the configured microscope objective.
workingDistanceMm	Working distance (mm)	number		≥ 0	The objective working distance in millimetres.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "magnification": "text"
}

• Fields hidden by the web form for this type (leave empty): consumablestock, consumablestock_inventory.

Miniscope

• type code Miniscope · version 2.0.1 · schema

A head-mounted miniature microscope, usually imaging above a GRIN lens.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
fieldOfView	Field of view	text			The field of view provided by the configured miniscope.
frameRateHz	Frame rate (Hz)	number		≥ 0	The configured image frame rate in frames per second.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "fieldOfView": "text"
}

• Fields hidden by the web form for this type (leave empty): consumablestock, consumablestock_inventory.

Optic fiber

• type code OpticFiber · version 1.0.0 · schema

A fiber delivering or collecting light, typically for optogenetics.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
measuredOutputPower	Measured output power	quantity with unit		units µW, mW, W; default {"unit": "mW"}	Optical power measured from the finished assembly on the bench, before implantation.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "measuredOutputPower": {
        "value": 1,
        "unit": "mW"
    }
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
OpticFiber (Optic fiber)	yes		OpticFiber	OpticFiberDesign	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Fastener (Anchor screw, pin, or fastener)			FastenerAnchor	FastenerAnchor	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

Prism

• type code Prism · version 1.0.0 · schema

Redirects the optical path to reach a plane a straight lens cannot.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.

Illustrative payload:

{
    "deviceIdentifier": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
Prism (Prism)	yes		OpticalComponent, ConsumableDevice	OpticalComponent, ConsumableDevice	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

Widefield macroscope

• type code WidefieldMacroscope · version 2.0.1 · schema

A large field-of-view imaging path for cortex-wide imaging.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
objectiveMagnification	Objective magnification	text			The objective magnification used by the configured macroscope.
fieldOfViewMm	Field of view (mm)	text			Imaged area width × height in mm.
excitationWavelengthNm	Excitation wavelength (nm)	number		≥ 0	The configured fluorescence excitation wavelength in nanometres.
emissionWavelengthNm	Emission wavelength (nm)	number		≥ 0	The configured fluorescence emission wavelength in nanometres.
frameRateHz	Frame rate (Hz)	number		≥ 0	The configured image frame rate in frames per second.
indicator	Fluorescent indicator	text			The fluorescent indicator observed with the configured macroscope.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "objectiveMagnification": "text"
}

• Fields hidden by the web form for this type (leave empty): consumablestock, consumablestock_inventory.

Assemblies

Headcap

• type code Headcap · version 2.0.1 · schema

The assembled cap protecting cranial implants and carrying their connectors. It is the assembly rather than any single device, so its components are recorded as its materials.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
shape	Final shape or design	text			The final installed headcap shape or design.
shieldingConfiguration	Shielding configuration	text (multi-line)			The shielding arrangement incorporated into the installed headcap.
connectorConfiguration	Connector and port configuration	text (multi-line)			The connector types and port arrangement incorporated into the installed headcap.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "shape": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
HeadcapAssembly (Headcap assembly)	yes		ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
ShieldingMaterial (Shielding material)			ImplantMaterial, ConsumableDevice	ImplantMaterial, ConsumableDevice	yes
Fastener (Anchor screw, pin, or fastener)			FastenerAnchor	FastenerAnchor	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
Other (Other material)					yes

Headpost

• type code Headpost · version 1.0.0 · schema

Represents a headpost or head plate fixed to the skull for head fixation.

This type has no type-specific properties: send an empty object. Everything meaningful is recorded on the record itself or on its material usage rows.

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
Headpost (Headpost)	yes		ImplantMaterial, ConsumableDevice	ImplantMaterial, ConsumableDevice	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Fastener (Anchor screw, pin, or fastener)			FastenerAnchor	FastenerAnchor	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
Other (Other material)					yes

Behavioral and Environmental

Camera

• type code Camera · version 2.0.1 · schema

A camera trained on the subject or preparation as a fixed observation point.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
view	View	text			The field of view or viewing direction provided by the installed camera.
frameRateHz	Frame rate (Hz)	number		≥ 0	The configured image frame rate in frames per second.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "view": "text"
}

• Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas, consumablestock, consumablestock_inventory.

Microphone

• type code Microphone · version 2.0.1 · schema

A microphone positioned to capture sound from the preparation.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
placement	Placement	text			The installed position and orientation of the interface relative to its target.
sampleRateHz	Sample rate (Hz)	number		≥ 0	The configured microphone sampling rate in samples per second.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "placement": "text"
}

• Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas, consumablestock, consumablestock_inventory.

Tracking system

• type code TrackingSystem · version 2.0.1 · schema

A configured tracking arrangement observing the subject.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
trackingMethod	Tracking method	text			The sensing method used by the configured tracking system.
trackedMarkers	Tracked markers	text (multi-line)			The markers or features tracked by the configured system.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "trackingMethod": "text"
}

• Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas, consumablestock, consumablestock_inventory.

Delivery

Bath perfusion

• type code BathPerfusion · version 2.0.1 · schema

The bath that superfuses a preparation, normally on a specimen set.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
flowRate	Flow rate	quantity with unit		units mL/min, µL/min, mL/h, µL/h; default {"unit": "mL/min"}	Perfusion flow rate.
solution	Solution	text (multi-line)			Composition or name of the perfusion solution (e.g., aCSF, ACSF with TTX 1 µM).
temperature	Temperature	quantity with unit		units °C, K, °F; default {"unit": "°C"}	Temperature of the perfusion solution at the recording chamber.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "flowRate": {
        "value": 1,
        "unit": "mL/min"
    }
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
FluidDeliveryLine (Perfusion flow path)	yes		ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
ActiveAgent (Delivered agent)			PharmacologicalAgent, ChemicalReagent, PhysiologicalSolution	PharmacologicalAgent, ChemicalReagent, PhysiologicalSolution	yes
Other (Other material)					yes

Catheter

• type code Catheter · version 2.0.1 · schema

A tube in a vessel or cavity for delivery, sampling, or monitoring.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
route	Route	text			The anatomical or configured route followed by the installed line or catheter.
gauge	Gauge	text			The gauge designation of the installed catheter or cannula.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "route": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
Catheter (Catheter)	yes		ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
ActiveAgent (Delivered agent)			PharmacologicalAgent, ChemicalReagent, PhysiologicalSolution	PharmacologicalAgent, ChemicalReagent, PhysiologicalSolution	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

Drug delivery line

• type code DrugDeliveryLine · version 2.0.1 · schema

A line delivering an agent from an external source.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
route	Route	text			The anatomical or configured route followed by the installed line or catheter.
deadVolume	Dead volume	text			The internal volume retained by the configured delivery line.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "route": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
FluidDeliveryLine (Fluid-delivery line)	yes		ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
ActiveAgent (Delivered agent)			PharmacologicalAgent, ChemicalReagent, PhysiologicalSolution	PharmacologicalAgent, ChemicalReagent, PhysiologicalSolution	yes
Other (Other material)					yes

Injection cannula

• type code InjectionCannula · version 2.0.1 · schema

A cannula for delivering a substance to a defined site.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
gauge	Gauge	text			The gauge designation of the installed catheter or cannula.
deliveryTarget	Delivery target	text			The anatomical or experimental target reached by the installed cannula.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "gauge": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
Cannula (Cannula)	yes		ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
Obturator (Obturator)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Fastener (Anchor screw, pin, or fastener)			FastenerAnchor	FastenerAnchor	yes
ActiveAgent (Delivered agent)			PharmacologicalAgent, ChemicalReagent, PhysiologicalSolution	PharmacologicalAgent, ChemicalReagent, PhysiologicalSolution	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

Microperfusion line

• type code MicroperfusionLine · version 2.0.1 · schema

A fine line exchanging solution locally at the target.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
flowRate	Flow rate	text			The configured flow rate for the installed microperfusion line, including units.
solution	Solution	text (multi-line)			The solution intended to pass through the installed microperfusion line.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "flowRate": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
FluidDeliveryLine (Microperfusion line)	yes		ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
Cannula (Delivery cannula)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
MicrodialysisProbe (Microdialysis probe)			ConsumableDevice	ConsumableDevice	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
ActiveAgent (Delivered agent)			PharmacologicalAgent, ChemicalReagent, PhysiologicalSolution	PharmacologicalAgent, ChemicalReagent, PhysiologicalSolution	yes
Other (Other material)					yes

Osmotic pump

• type code OsmoticPump · version 2.0.1 · schema

An implanted pump delivering an agent continuously without external control.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
nominalFlowRate	Nominal flow rate	quantity with unit		units µL/h, µL/day, mL/h, mL/day; default {"unit": "µL/h"}	Manufacturer-specified nominal flow rate.
reservoirVolume	Reservoir volume	quantity with unit		units µL, mL, L; default {"unit": "µL"}	Total volume capacity of the osmotic pump reservoir.
duration	Delivery duration	quantity with unit		units h, days, weeks; default {"unit": "days"}	Expected delivery duration based on reservoir volume and flow rate.
deliveryAgent	Delivery agent / drug	text			Agent being delivered.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "nominalFlowRate": {
        "value": 1,
        "unit": "µL/h"
    }
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
OsmoticPump (Osmotic pump)	yes		ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
FluidDeliveryLine (Delivery line)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
Catheter (Delivery catheter)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
Other (Other material)					yes

Stimulation

Auditory stimulator

• type code AuditoryStimulator · version 1.0.3 · schema

The configured arrangement presenting sound to the subject.

Property	Title	Shape	Required	Allowed values	Meaning
stimulusTypes	Stimulus types	multi-select		one of tone, click, white_noise, pink_noise, frequency_sweep, amplitude_modulated, pulse_train, chirp, other; format select2	Types of auditory stimuli delivered through this interface. Select one or more.
deliveryMethod	Delivery method	choice		one of free_field_speaker, in_ear_speaker, bone_conduction, headphone, other	How the sound was delivered to the subject. Free-field speakers are most common in head-fixed setups.
stimulationContext	Stimulation context	choice		one of passive, behavioral_task, closed_loop, anesthetized, free_behavior	Experimental context in which auditory stimulation was delivered.
paradigmDescription	Paradigm description	text (multi-line)			Free-text description of the auditory stimulation paradigm: include stimulus timing, repetitions, device setup, etc.

Illustrative payload:

{
    "stimulusTypes": [
        "tone"
    ],
    "deliveryMethod": "free_field_speaker"
}

• Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas, consumablestock, consumablestock_inventory.

LED array

• type code LEDArray · version 2.0.1 · schema

An array of LEDs for patterned optical stimulation.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
wavelengthNm	Wavelength (nm)	number		≥ 0	Peak emission wavelength of the LEDs.
ledCount	LED count	integer		≥ 0	The number of LEDs present in the configured array.
pitchMm	LED pitch (mm)	number		≥ 0	Centre-to-centre distance between adjacent LEDs.
maxPowerMw	Max power per LED (mW)	number		≥ 0	The maximum optical power per LED in milliwatts.
opsin	Target opsin	text			Opsin targeted by this LED array.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "wavelengthNm": 1.0
}

• Fields hidden by the web form for this type (leave empty): consumablestock, consumablestock_inventory.

Olfactometer

• type code Olfactometer · version 1.0.2 · schema

The configured arrangement presenting odors.

Property	Title	Shape	Required	Allowed values	Meaning
deliveryMethod	Delivery method	choice		one of olfactometer, manually_pipetted, syringe_injection, headspace_exposure, cotton_swab, other	How the odor was delivered to the subject. Use ‘Olfactometer’ for computer-controlled systems.
stimulationContext	Stimulation context	choice		one of passive, behavioral_task, closed_loop, anesthetized, free_behavior	Experimental context in which odor stimulation occurred.
paradigmDescription	Paradigm description	text (multi-line)			Free-text description of the odor stimulation paradigm, including stimulus timing, delivery parameters, and experimental goals.

Illustrative payload:

{
    "deliveryMethod": "olfactometer",
    "stimulationContext": "passive"
}

• Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas, consumablestock, consumablestock_inventory.

Stimulating electrode

• type code StimulatingElectrode · version 2.0.1 · schema

An electrode used to deliver current rather than to record.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
contactCount	Active contact count	integer		≥ 0	The number of electrical contacts configured on the installed interface.
stimulationMode	Stimulation mode	text			The electrical stimulation mode supported by the configured electrode.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "contactCount": 1
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
StimulatingElectrode (Stimulating electrode)	yes		ConsumableDevice, SingleWireElectrode	ConsumableDevice, SingleWireElectrode	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

TMS coil

• type code TMSCoil · version 2.0.1 · schema

A coil inducing currents in tissue without contact.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
coilType	Coil type	text			The geometry or construction type of the configured TMS coil.
placement	Placement	text			The installed position and orientation of the interface relative to its target.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "coilType": "text"
}

• Fields hidden by the web form for this type (leave empty): consumablestock, consumablestock_inventory.

Tactile stimulator

• type code TactileStimulator · version 1.0.3 · schema

The configured arrangement applying mechanical stimuli.

Property	Title	Shape	Required	Allowed values	Meaning
stimulusTypes	Stimulation types	multi-select		one of whisker_poke, whisker_deflection, air_puff, brush, vibration, pressure_pad, cotton_swab, other; format select2	Select the types of tactile stimuli delivered through this interface. Multiple types can be listed if applicable.
stimulationSite	Stimulation site	text			The anatomical region where tactile stimuli were applied (e.g., ‘whisker pad’, ‘hindpaw’, ‘tail’).
deliveryMethod	Delivery method	choice		one of manual, piezo_actuator, solenoid_piston, air_puff, brush_probe, other	The method or device used to deliver the tactile stimulus to the subject.
stimulationContext	Stimulation context	choice		one of passive, behavioral_task, closed_loop, anesthetized, free_behavior	Experimental context in which tactile stimulation occurred.
paradigmDescription	Paradigm description	text (multi-line)			Free-text description of the tactile stimulation paradigm, including stimulus timing, frequency, devices used, and behavioral conditions.

Illustrative payload:

{
    "stimulusTypes": [
        "whisker_poke"
    ],
    "stimulationSite": "text"
}

• Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas, consumablestock, consumablestock_inventory.

Thermal probe

• type code ThermalProbe · version 2.0.1 · schema

A probe heating or cooling the target.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
temperatureRange	Temperature range	text			The operating or measurement temperature range of the configured thermal probe.
contactSite	Contact site	text			The anatomical or specimen site contacted by the thermal probe.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "temperatureRange": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
TemperatureSensor (Temperature probe or sensor)	yes		ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	ConsumableDevice, ImplantMaterial, OpticalComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

Ultrasound transducer

• type code UltrasoundTransducer · version 2.0.1 · schema

A transducer delivering focused ultrasound to the target.

Property	Title	Shape	Required	Allowed values	Meaning
deviceIdentifier	Device identifier	text			The device’s own identifier: the manufacturer’s serial number, or the code the lab marks on the hardware and writes on the cage card and the surgery sheet. This is not the name given to this record.
centerFrequencyMhz	Center frequency (MHz)	number		≥ 0	The transducer centre frequency in megahertz.
focus	Focus	text			The focal geometry or focal distance of the configured transducer.

Illustrative payload:

{
    "deviceIdentifier": "text",
    "centerFrequencyMhz": 1.0
}

• Fields hidden by the web form for this type (leave empty): consumablestock, consumablestock_inventory.

Visual stimulator

• type code VisualStimulator · version 1.0.3 · schema

The configured arrangement presenting visual stimuli.

Property	Title	Shape	Required	Allowed values	Meaning
stimulusTypes	Stimulus types	multi-select		one of gratings, natural_images, led_flashes, checkerboard, full_field_flashes, moving_bars, flicker, other; format select2	Select the visual stimulus types delivered through this interface. Multiple types may be selected.
presentationDevice	Presentation device	choice		one of monitor, led_panel, projector, head_mounted_display, fiber_coupled_light, other	Device or method used to present the visual stimuli to the subject.
stimulationPosition	Stimulus position	choice		one of contralateral, ipsilateral, bilateral, centered, surround, other, unknown	Relative visual field position where the stimulus was presented with respect to the subject.
stimulationContext	Stimulation context	choice		one of passive, behavioral_task, closed_loop, anesthetized, free_behavior	Experimental condition in which visual stimulation occurred.
paradigmDescription	Paradigm description	text (multi-line)			Free-text description of the visual stimulation paradigm, including stimulus sequence, timing, and behavioral relevance.

Illustrative payload:

{
    "stimulusTypes": [
        "gratings"
    ],
    "presentationDevice": "monitor"
}

• Fields hidden by the web form for this type (leave empty): coordinates, coordinates_json, target_regions, target_regions_atlas, consumablestock, consumablestock_inventory.

Generic

Generic interface

• type code Generic · version 1.0.2 · schema

Use this only when no specific type above applies. Describe what the interface is and how it contacts the target in the configuration notes, because the type name will tell another user nothing.

Property	Title	Shape	Required	Allowed values	Meaning
interfaceId	Interface ID	text			The identifier assigned to this interface configuration.
configurationNotes	Configuration notes	text (multi-line)			A concise description of configuration details not represented by structured fields.

Illustrative payload:

{
    "interfaceId": "text",
    "configurationNotes": "text"
}

Materials (material usage rows) allowed on this type:

Role (type)	Required	Max	From stock types	From catalog types	Manual	Complete when
GenericDevice (Other interface device)	yes		ConsumableDevice, EcogArray, ElectrodeComponent, ImplantMaterial, OpticFiber, OpticalComponent, SiliconProbe, SingleWireElectrode	ConsumableDevice, EcogArrayDesign, ElectrodeComponent, ImplantMaterial, OpticFiberDesign, OpticalComponent, SiliconProbeDesign, SingleWireElectrode	yes
FixedPositioningAssembly (Fixed implant carrier or shuttle)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
ManualMicrodrive (Manual microdrive)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
MotorizedMicrodrive (Motorized microdrive)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
OtherComponent (Other installed component)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
ReferenceElectrode (Reference electrode)			ElectrodeComponent, SingleWireElectrode	ElectrodeComponent, SingleWireElectrode	yes
GroundElectrode (Ground electrode)			ElectrodeComponent, SingleWireElectrode	ElectrodeComponent, SingleWireElectrode	yes
ConnectorComponent (Connector component)			ConnectorComponent	ConnectorComponent	yes
Obturator (Obturator)			ConsumableDevice, ImplantMaterial	ConsumableDevice, ImplantMaterial	yes
ShieldingMaterial (Shielding material)			ImplantMaterial, ConsumableDevice	ImplantMaterial, ConsumableDevice	yes
AdhesiveSealant (Adhesive, cement, or sealant)			AdhesiveCement	AdhesiveCement	yes
Fastener (Anchor screw, pin, or fastener)			FastenerAnchor	FastenerAnchor	yes
ActiveAgent (Delivered agent)			PharmacologicalAgent, ChemicalReagent, PhysiologicalSolution	PharmacologicalAgent, ChemicalReagent, PhysiologicalSolution	yes
Other (Other material)					yes
Coating (Coating)			TracerDye, ChemicalReagent	TracerDye, ChemicalReagent	yes

Target specimens

• type code TargetSpecimens · version 1.0.2 · schema

Property	Title	Shape	Required	Allowed values	Meaning
specimenId	Specimen ID	text			The identifier of the specimen targeted by this interface entry.
role	Role	text			The role of the specimen in relation to the interface.
notes	Notes	text (multi-line)			A concise clarification specific to this target-specimen association.

Illustrative payload:

[
    {
        "specimenId": "text",
        "role": "text"
    }
]