CreateExperimentOptions

@neurosity/sdk

---

@neurosity/sdk / CreateExperimentOptions

Type Alias: CreateExperimentOptions

CreateExperimentOptions = object

Defined in: types/experiment.ts:38

Options for creating a new experiment via Neurosity.createUserExperiment.

Properties

deviceId

deviceId: string

Defined in: types/experiment.ts:40

The device the experiment is associated with.

---

durationMs?

optional durationMs: number

Defined in: types/experiment.ts:50

Recording-only planned duration in ms. Defaults to 5 minutes.

---

kind?

optional kind: SessionKind

Defined in: types/experiment.ts:46

Session kind. Defaults to training.

---

labels?

optional labels: string[]

Defined in: types/experiment.ts:44

Initial classifier labels (e.g. ["leftHandPinch", "drop"]).

---

name?

optional name: string

Defined in: types/experiment.ts:42

Display name. Defaults to a timestamped name when omitted.

---

notes?

optional notes: string

Defined in: types/experiment.ts:52

Free-form notes.

---

protocol?

optional protocol: TrainingProtocol

Defined in: types/experiment.ts:48

Training-only classifier protocol. Defaults to kinesis.