Get config

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

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

dspDSPInfo (object)

configarray of DSPGroup (object)

configErrorstring

Request

JavaScriptCurlPython

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

Response

200

{
  "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"
}