Get impulse

Get impulse

get

Retrieve the impulse for this project. If you specify impulseId then that impulse is returned, otherwise the default impulse is returned.

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

Path parameters

projectIdintegerRequired

Project ID

Query parameters

impulseIdintegerOptional

Impulse ID. If this is unset then the default impulse is used.

Responses

200

OK

application/json

Responseall of

get

HTTPcURLJavaScriptPython

GET /v1/api/{projectId}/impulse HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Accept: */*

200

OK

{
  "success": true,
  "error": "text",
  "impulse": {
    "id": 1,
    "name": "text",
    "inputBlocks": [
      {
        "id": 1,
        "type": "time-series",
        "name": "Time series",
        "title": "Time series",
        "windowSizeMs": 2004,
        "windowIncreaseMs": 1,
        "frequencyHz": 60,
        "classificationWindowIncreaseMs": 1,
        "padZeros": true,
        "imageWidth": 28,
        "imageHeight": 28,
        "resizeMode": "squash",
        "resizeMethod": "squash",
        "cropAnchor": "middle-center",
        "createdBy": "createImpulse",
        "createdAt": "2025-07-11T23:53:48.678Z",
        "datasetSubset": {
          "includePercentage": 1,
          "seed": 1
        }
      }
    ],
    "dspBlocks": [
      {
        "id": 1,
        "type": "spectral-analysis",
        "name": "Spectral features",
        "axes": [
          "accX"
        ],
        "title": "Spectral Analysis",
        "valuesPerAxis": 11,
        "input": 1,
        "createdBy": "createImpulse",
        "createdAt": "2025-07-11T23:53:48.678Z",
        "implementationVersion": 1,
        "organization": {
          "id": 1,
          "dspId": 1
        },
        "customUrl": "text",
        "namedAxes": [
          {
            "name": "text",
            "description": "text",
            "required": true,
            "selectedAxis": "text"
          }
        ]
      }
    ],
    "learnBlocks": [
      {
        "id": 1,
        "type": "anomaly",
        "name": "NN Classifier",
        "dsp": [
          27
        ],
        "title": "Classification (Keras)",
        "createdBy": "createImpulse",
        "createdAt": "2025-07-11T23:53:48.678Z"
      }
    ],
    "postProcessingBlocks": [
      {
        "id": 1,
        "type": "object-tracking",
        "name": "Object tracking",
        "title": "Object tracking",
        "createdBy": "createImpulse",
        "createdAt": "2025-07-11T23:53:48.678Z",
        "implementationVersion": 1
      }
    ]
  }
}