Get config

Retrieve the configuration parameters for the DSP block. Use the impulse functions to retrieve all DSP blocks.

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

Path parameters

projectId*integer

Project ID

dspId*integer

DSP Block ID, use the impulse functions to retrieve the ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

dspDSPInfo (object)

id*integer

Example: 1

name*string

Example: "Spectral features"

windowLength*integer

Example: 3000

type*string

Example: "spectral-analysis"

classes*array of string

itemsstring

features*object

generated*boolean

Whether this block has generated features

countinteger

Number of generated features

labelsarray of string

Names of the features

itemsstring

classesarray of string

Classes that the features were generated on

itemsstring

expectedWindowCount*integer

Expected number of windows that would be generated

inputAxes*array of string

Axes that this block depends on.

itemsstring

performanceobject

latency*integer

ram*integer

canCalculateFeatureImportance*boolean

calculateFeatureImportance*boolean

hasAutoTuneboolean

Whether this type of DSP block supports autotuning.

minimumVersionForAutotunenumber

For DSP blocks that support autotuning, this value specifies the minimum block implementation version for which autotuning is supported.

hasAutotunerResultsboolean

Whether autotune results exist for this DSP block.

usesStateboolean

Whether this DSP block uses state.

configarray of DSPGroup (object)

group*string

Example: "Scaling"

items*array of DSPGroupItem (object)

name*string

Example: "Scale axes"

valuestring

defaultValue*string

type*string

Example: "text"

helpstring

Example: "Divide axes by this number"

param*string

Example: "scale-axes"

selectOptionsarray of object

valuestring

selectedboolean

optionLabelstring

readonly*boolean

shouldShow*boolean

showIfobject

parameter*string

operator*enum

eqneq

value*string

invalidTextstring

sectionenum

Interface section to render parameter in.

advancedaugmentation

multilineboolean

Only valid for type "string". Will render a multiline text area.

required*boolean

hintstring

If set, shows a hint below the input.

placeholderstring

Sets the placeholder text on the input element (for types "string", "int", "float" and "secret")

configErrorstring

Request

Response

Get config

Retrieve the configuration parameters for the DSP block. Use the impulse functions to retrieve all DSP blocks.

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

Path parameters

projectId*integer

Project ID

dspId*integer

DSP Block ID, use the impulse functions to retrieve the ID

Response

Body

success*boolean

Whether the operation succeeded

errorstring

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

dspDSPInfo (object)

id*integer

Example: 1

name*string

Example: "Spectral features"

windowLength*integer

Example: 3000

type*string

Example: "spectral-analysis"

classes*array of string

itemsstring

features*object

generated*boolean

Whether this block has generated features

countinteger

Number of generated features

labelsarray of string

Names of the features

itemsstring

classesarray of string

Classes that the features were generated on

itemsstring

expectedWindowCount*integer

Expected number of windows that would be generated

inputAxes*array of string

Axes that this block depends on.

itemsstring

performanceobject

latency*integer

ram*integer

canCalculateFeatureImportance*boolean

calculateFeatureImportance*boolean

hasAutoTuneboolean

Whether this type of DSP block supports autotuning.

minimumVersionForAutotunenumber

For DSP blocks that support autotuning, this value specifies the minimum block implementation version for which autotuning is supported.

hasAutotunerResultsboolean

Whether autotune results exist for this DSP block.

usesStateboolean

Whether this DSP block uses state.

configarray of DSPGroup (object)

group*string

Example: "Scaling"

items*array of DSPGroupItem (object)

name*string

Example: "Scale axes"

valuestring

defaultValue*string

type*string

Example: "text"

helpstring

Example: "Divide axes by this number"

param*string

Example: "scale-axes"

selectOptionsarray of object

valuestring

selectedboolean

optionLabelstring

readonly*boolean

shouldShow*boolean

showIfobject

parameter*string

operator*enum

eqneq

value*string

invalidTextstring

sectionenum

Interface section to render parameter in.

advancedaugmentation

multilineboolean

Only valid for type "string". Will render a multiline text area.

required*boolean

hintstring

If set, shows a hint below the input.

placeholderstring

Sets the placeholder text on the input element (for types "string", "int", "float" and "secret")

configErrorstring

Request

Response

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

{
  "success": false,
  "error": "text",
  "dsp": {
    "id": 1,
    "name": "Spectral features",
    "windowLength": 3000,
    "type": "spectral-analysis",
    "classes": [
      "text"
    ],
    "features": {
      "generated": false,
      "labels": [
        "text"
      ],
      "classes": [
        "text"
      ]
    },
    "inputAxes": [
      "text"
    ],
    "performance": {},
    "canCalculateFeatureImportance": false,
    "calculateFeatureImportance": false,
    "hasAutoTune": false,
    "minimumVersionForAutotune": 0,
    "hasAutotunerResults": false,
    "usesState": false
  },
  "config": [
    {
      "group": "Scaling",
      "items": [
        {
          "name": "Scale axes",
          "value": "text",
          "defaultValue": "text",
          "type": "text",
          "help": "Divide axes by this number",
          "param": "scale-axes",
          "selectOptions": [
            {
              "value": "text",
              "selected": false,
              "optionLabel": "text"
            }
          ],
          "readonly": false,
          "shouldShow": false,
          "showIf": {
            "parameter": "text",
            "operator": "eq",
            "value": "text"
          },
          "invalidText": "text",
          "section": "advanced",
          "multiline": false,
          "required": false,
          "hint": "text",
          "placeholder": "text"
        }
      ]
    }
  ],
  "configError": "text"
}