Get processed sample (from features array)

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

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

dspIdintegerrequired

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

Body

drawGraphsbooleanrequired

Whether to generate graphs (will take longer)

requestPerformancebooleanrequired

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

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]).

paramsobjectrequired

DSP parameters with values

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/dsp/{dspId}/run' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"drawGraphs":true,"requestPerformance":true,"features":[null],"params":{"scale-axes":"10"}}'

200

200

{
  "success": true,
  "error": "text",
  "state_string": "text",
  "performance": {
    "latency": 1,
    "ram": 1,
    "customDspString": "text"
  },
  "features": [
    1
  ],
  "graphs": [
    {
      "name": "Frequency domain",
      "image": "text",
      "imageMimeType": "text",
      "suggestedXMin": 1,
      "suggestedXMax": 1,
      "suggestedYMin": 1,
      "suggestedYMax": 1,
      "type": "text",
      "lineWidth": 1,
      "smoothing": true,
      "y": [
        0,
        0.5,
        1
      ],
      "X": {
        "accX": [
          3,
          5,
          7
        ],
        "accY": [
          2,
          1,
          5
        ]
      },
      "axisLabels": {
        "X": "text",
        "y": "text"
      },
      "highlights": {
        "ANY_ADDITIONAL_PROPERTY": [
          1
        ]
      }
    }
  ],
  "labels": [
    "text"
  ]
}

OK