Get metadata

Get metadata

get

Retrieve the metadata from a generated DSP block.

Authorizations
Path parameters
projectIdintegerRequired

Project ID

dspIdintegerRequired

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

Query parameters
excludeIncludedSamplesbooleanOptional

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

categorystring · enumOptional

Which of the acquisition categories to get metadata from

Possible values:
Responses
200
OK
application/json
Responseall of
get
GET /v1/api/{projectId}/dsp/{dspId}/metadata HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Accept: */*
200

OK

{
  "success": true,
  "error": "text",
  "created": "2025-07-04T02:29:47.774Z",
  "generated": true,
  "dspConfig": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "labels": [
    "text"
  ],
  "featureLabels": [
    "text"
  ],
  "windowCount": 1,
  "featureCount": 1,
  "includedSamples": [
    {
      "id": 1,
      "windowCount": 1
    }
  ],
  "windowSizeMs": 1,
  "windowIncreaseMs": 1,
  "padZeros": true,
  "frequency": 1,
  "outputConfig": {
    "type": "image",
    "shape": {
      "width": 1,
      "height": 1,
      "channels": 1,
      "frames": 1
    }
  },
  "fftUsed": [
    1
  ],
  "resamplingAlgorithmVersion": 1,
  "featureExplorerJobId": 1,
  "featureExplorerJobFailed": true,
  "featureImportanceJobId": 1,
  "featureImportanceJobFailed": true
}

Last updated

Was this helpful?