GET
/
api
/
{projectId}
/
dsp
/
{dspId}
/
metadata
Get metadata
curl --request GET \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/dsp/{dspId}/metadata \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "error": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "generated": true,
  "dspConfig": {},
  "labels": [
    "<string>"
  ],
  "featureLabels": [
    "<string>"
  ],
  "windowCount": 123,
  "featureCount": 123,
  "includedSamples": [
    {
      "id": 123,
      "windowCount": 123
    }
  ],
  "windowSizeMs": 123,
  "windowIncreaseMs": 123,
  "padZeros": true,
  "frequency": 123,
  "outputConfig": {
    "type": "image",
    "shape": {
      "width": 123,
      "height": 123,
      "channels": 123,
      "frames": 123
    }
  },
  "fftUsed": [
    123
  ],
  "resamplingAlgorithmVersion": 123,
  "featureExplorerJobId": 123,
  "featureExplorerJobFailed": true,
  "featureImportanceJobId": 123,
  "featureImportanceJobFailed": true
}

Authorizations

x-api-key
string
header
required

Path Parameters

projectId
integer
required

Project ID

dspId
integer
required

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

Query Parameters

excludeIncludedSamples
boolean

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

category
enum<string>

Which of the acquisition categories to get metadata from

Available options:
training,
testing,
all

Response

200 - application/json

OK

The response is of type object.