DSP

Get processed sample (from features array)

Takes in a features array and runs it through the DSP block. This data should have the same frequency as set in the input block in your impulse.

post/api/{projectId}/dsp/{dspId}/run

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/run/post.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

Request body

featuresinteger[] required

Array of features. If you have multiple axes the data should be interleaved (e.g. [ax0_val0, ax1_val0, ax2_val0, ax0_val1, ax1_val1, ax2_val1]).

paramsobject required

DSP parameters with values

drawGraphsboolean required

Whether to generate graphs (will take longer)

requestPerformanceboolean required

Whether to request performance info (will take longer unless cached)

Example request

{
  "params": {
    "scale-axes": "10"
  }
}

Response

successboolean required

Whether the operation succeeded

errorstring

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

featuresnumber[] required

Array of processed features. Laid out according to the names in 'labels'

labelsstring[]

Labels of the feature axes

state_stringstring

String representation of the DSP state returned

Example response

{
  "graphs": [
    {
      "name": "Frequency domain",
      "X": {
        "accX": [
          3,
          5,
          7
        ],
        "accY": [
          2,
          1,
          5
        ]
      },
      "y": [
        0,
        0.5,
        1
      ]
    }
  ]
}

Changes

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