DSP

Get config

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

get/api/{projectId}/dsp/{dspId}

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/dsp/:dspId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

dspIdinteger required

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

Response

successboolean required

Whether the operation succeeded

errorstring

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

configErrorstring

Example response

{
  "dsp": {
    "id": 1,
    "name": "Spectral features",
    "windowLength": 3000,
    "type": "spectral-analysis"
  },
  "config": [
    {
      "group": "Scaling",
      "items": [
        {
          "name": "Scale axes",
          "type": "text",
          "help": "Divide axes by this number",
          "param": "scale-axes"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.