Get impulse

Retrieve the impulse for this project. If you specify impulseId then that impulse is returned, otherwise the default impulse is returned.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/impulse

Path parameters

projectId*integer

Project ID

Query parameters

impulseIdinteger

Impulse ID. If this is unset then the default impulse is used.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

impulseImpulse (object)

id*integer

ID for this impulse.

name*string

Name for this impulse.

inputBlocks*array of ImpulseInputBlock (object)

Input Blocks that are part of this impulse

id*integer

Identifier for this block. Make sure to up this number when creating a new block, and don't re-use identifiers. If the block hasn't changed, keep the ID as-is. ID must be unique across the project and greather than zero (>0).

type*enum

Block type (either time-series, image or features)

Example: "time-series"

time-seriesimagefeatures

name*string

Block name, will be used in menus

Example: "Time series"

title*string

Block title, used in the impulse UI

Example: "Time series"

windowSizeMsinteger

Size of the sliding window in milliseconds

Example: 2004

windowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.

frequencyHznumber

(Input only) Frequency of the input data in Hz

Example: 60

classificationWindowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step in classification mode.

padZerosboolean

Whether to zero pad data when a data item is too short

imageWidthinteger

Width all images are resized to before training

Example: 28

imageHeightinteger

Width all images are resized to before training

Example: 28

resizeModeenum

How to resize images before training

Example: "squash"

squashfit-shortfit-longcrop

resizeMethodenum

Resize method to use when resizing images

Example: "squash"

lanczos3nearest

cropAnchorenum

If images are resized using a crop, choose where to anchor the crop

Example: "middle-center"

top-lefttop-centertop-rightmiddle-leftmiddle-centermiddle-rightbottom-leftbottom-centerbottom-right

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

createdBystring

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example: "createImpulse"

createdAtstring (date-time)

The datetime that the block version was created. Cannot be set via API.

datasetSubsetobject

Only generate features for samples where (sample_id + datasetSubsetSeed) % datasetSubset) == 0

subsetModulonumber

subsetSeednumber

dspBlocks*array of ImpulseDspBlock (object)

DSP Blocks that are part of this impulse

id*integer

type*string

Block type

Example: "spectral-analysis"

name*string

Block name, will be used in menus

Example: "Spectral features"

axes*array of string

Input axes, identified by the name in the name of the axis

itemsstring

Example: "accX"

title*string

Block title, used in the impulse UI

Example: "Spectral Analysis"

valuesPerAxisinteger

Number of features this DSP block outputs per axis. This is only set when the DSP block is configured.

Example: 11

inputinteger

The ID of the Input block a DSP block is connected to

Example: 1

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

createdBystring

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example: "createImpulse"

createdAtstring (date-time)

The datetime that the block version was created. Cannot be set via API.

implementationVersion*integer

Implementation version of the block

organizationobject

id*integer

dspId*integer

customUrlstring

Required for type 'custom'

namedAxesarray of object

Named axes for the block

name*string

Name of the axis

descriptionstring

Description of the axis

requiredboolean

Whether the axis is required

selectedAxisstring

The selected axis for the block

learnBlocks*array of ImpulseLearnBlock (object)

Learning Blocks that are part of this impulse

id*integer

type*LearnBlockType (enum)

The type of learning block (anomaly, keras, keras-transfer-image, keras-transfer-kws, keras-object-detection, keras-regression). Each behaves differently.

anomalyanomaly-gmmkeraskeras-transfer-imagekeras-transfer-kwskeras-object-detectionkeras-regressionkeras-akidakeras-akida-transfer-imagekeras-akida-object-detectionkeras-visual-anomaly

name*string

Block name, will be used in menus. If a block has a baseBlockId, this field is ignored and the base block's name is used instead.

Example: "NN Classifier"

dsp*array of integer

DSP dependencies, identified by DSP block ID

itemsinteger

Example: 27

title*string

Block title, used in the impulse UI

Example: "Classification (Keras)"

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

createdBystring

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example: "createImpulse"

createdAtstring (date-time)

The datetime that the block version was created. Cannot be set via API.

Request

Response

Get impulse

Retrieve the impulse for this project. If you specify impulseId then that impulse is returned, otherwise the default impulse is returned.

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/impulse

Path parameters

projectId*integer

Project ID

Query parameters

impulseIdinteger

Impulse ID. If this is unset then the default impulse is used.

Response

Body

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

impulseImpulse (object)

id*integer

ID for this impulse.

name*string

Name for this impulse.

inputBlocks*array of ImpulseInputBlock (object)

Input Blocks that are part of this impulse

id*integer

type*enum

Block type (either time-series, image or features)

Example: "time-series"

time-seriesimagefeatures

name*string

Block name, will be used in menus

Example: "Time series"

title*string

Block title, used in the impulse UI

Example: "Time series"

windowSizeMsinteger

Size of the sliding window in milliseconds

Example: 2004

windowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step.

frequencyHznumber

(Input only) Frequency of the input data in Hz

Example: 60

classificationWindowIncreaseMsinteger

We use a sliding window to go over the raw data. How many milliseconds to increase the sliding window with for each step in classification mode.

padZerosboolean

Whether to zero pad data when a data item is too short

imageWidthinteger

Width all images are resized to before training

Example: 28

imageHeightinteger

Width all images are resized to before training

Example: 28

resizeModeenum

How to resize images before training

Example: "squash"

squashfit-shortfit-longcrop

resizeMethodenum

Resize method to use when resizing images

Example: "squash"

lanczos3nearest

cropAnchorenum

If images are resized using a crop, choose where to anchor the crop

Example: "middle-center"

top-lefttop-centertop-rightmiddle-leftmiddle-centermiddle-rightbottom-leftbottom-centerbottom-right

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

createdBystring

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example: "createImpulse"

createdAtstring (date-time)

The datetime that the block version was created. Cannot be set via API.

datasetSubsetobject

Only generate features for samples where (sample_id + datasetSubsetSeed) % datasetSubset) == 0

subsetModulonumber

subsetSeednumber

dspBlocks*array of ImpulseDspBlock (object)

DSP Blocks that are part of this impulse

id*integer

type*string

Block type

Example: "spectral-analysis"

name*string

Block name, will be used in menus

Example: "Spectral features"

axes*array of string

Input axes, identified by the name in the name of the axis

itemsstring

Example: "accX"

title*string

Block title, used in the impulse UI

Example: "Spectral Analysis"

valuesPerAxisinteger

Number of features this DSP block outputs per axis. This is only set when the DSP block is configured.

Example: 11

inputinteger

The ID of the Input block a DSP block is connected to

Example: 1

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

createdBystring

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example: "createImpulse"

createdAtstring (date-time)

The datetime that the block version was created. Cannot be set via API.

implementationVersion*integer

Implementation version of the block

organizationobject

id*integer

dspId*integer

customUrlstring

Required for type 'custom'

namedAxesarray of object

Named axes for the block

name*string

Name of the axis

descriptionstring

Description of the axis

requiredboolean

Whether the axis is required

selectedAxisstring

The selected axis for the block

learnBlocks*array of ImpulseLearnBlock (object)

Learning Blocks that are part of this impulse

id*integer

type*LearnBlockType (enum)

The type of learning block (anomaly, keras, keras-transfer-image, keras-transfer-kws, keras-object-detection, keras-regression). Each behaves differently.

anomalyanomaly-gmmkeraskeras-transfer-imagekeras-transfer-kwskeras-object-detectionkeras-regressionkeras-akidakeras-akida-transfer-imagekeras-akida-object-detectionkeras-visual-anomaly

name*string

Block name, will be used in menus. If a block has a baseBlockId, this field is ignored and the base block's name is used instead.

Example: "NN Classifier"

dsp*array of integer

DSP dependencies, identified by DSP block ID

itemsinteger

Example: 27

title*string

Block title, used in the impulse UI

Example: "Classification (Keras)"

descriptionstring

A short description of the block version, displayed in the block versioning UI

Example: "Reduced learning rate and more layers"

createdBystring

The system component that created the block version (createImpulse | clone | tuner). Cannot be set via API.

Example: "createImpulse"

createdAtstring (date-time)

The datetime that the block version was created. Cannot be set via API.

Request

Response

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/impulse', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "success": false,
  "error": "text",
  "impulse": {
    "name": "text",
    "inputBlocks": [
      {
        "type": "time-series",
        "name": "Time series",
        "title": "Time series",
        "windowSizeMs": 2004,
        "frequencyHz": 60,
        "padZeros": false,
        "imageWidth": 28,
        "imageHeight": 28,
        "resizeMode": "squash",
        "resizeMethod": "squash",
        "cropAnchor": "middle-center",
        "description": "Reduced learning rate and more layers",
        "createdBy": "createImpulse",
        "createdAt": "2024-11-23T08:02:31.323Z",
        "datasetSubset": {
          "subsetModulo": 0,
          "subsetSeed": 0
        }
      }
    ],
    "dspBlocks": [
      {
        "type": "spectral-analysis",
        "name": "Spectral features",
        "axes": [
          "accX"
        ],
        "title": "Spectral Analysis",
        "valuesPerAxis": 11,
        "input": 1,
        "description": "Reduced learning rate and more layers",
        "createdBy": "createImpulse",
        "createdAt": "2024-11-23T08:02:31.323Z",
        "organization": {},
        "customUrl": "text",
        "namedAxes": [
          {
            "name": "text",
            "description": "text",
            "required": false,
            "selectedAxis": "text"
          }
        ]
      }
    ],
    "learnBlocks": [
      {
        "type": "anomaly",
        "name": "NN Classifier",
        "dsp": [
          27
        ],
        "title": "Classification (Keras)",
        "description": "Reduced learning rate and more layers",
        "createdBy": "createImpulse",
        "createdAt": "2024-11-23T08:02:31.323Z"
      }
    ]
  }
}