Get metadata

Get metadata

Retrieve the metadata from a generated DSP block.

get

/api/{projectId}/dsp/{dspId}/metadata

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

Path parameters

projectIdintegerrequired

Project ID

dspIdintegerrequired

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

Query parameters

excludeIncludedSamplesboolean

Whether to exclude 'includedSamples' in the response (as these can slow down requests significantly).

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/dsp/{dspId}/metadata' \
  --header 'x-api-key: YOUR_API_KEY'

200

200

{
  "success": true,
  "error": "text",
  "created": "2025-02-21T18:05:04.727Z",
  "windowCount": 1,
  "featureCount": 1,
  "windowSizeMs": 1,
  "windowIncreaseMs": 1,
  "padZeros": true,
  "frequency": 1,
  "resamplingAlgorithmVersion": 1,
  "dspConfig": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "labels": [
    "text"
  ],
  "featureLabels": [
    "text"
  ],
  "fftUsed": [
    1
  ],
  "includedSamples": [
    {
      "id": 1,
      "windowCount": 1
    }
  ],
  "outputConfig": {
    "type": "image",
    "shape": {
      "width": 1,
      "height": 1,
      "channels": 1,
      "frames": 1
    }
  }
}

OK