Get impulse

Get impulse

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

GEThttps://studio.edgeimpulse.com/v1/api/{projectId}/impulse

Path parameters

projectId*integer

Project ID

Query parameters

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

impulseImpulse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/impulse', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "error": "text",
  "impulse": {
    "id": 0,
    "name": "text",
    "inputBlocks": [
      {
        "id": 0,
        "type": "time-series",
        "name": "Time series",
        "title": "Time series",
        "windowSizeMs": 2004,
        "windowIncreaseMs": 0,
        "frequencyHz": 60,
        "classificationWindowIncreaseMs": 0,
        "padZeros": false,
        "imageWidth": 28,
        "imageHeight": 28,
        "resizeMode": "squash",
        "resizeMethod": "squash",
        "cropAnchor": "middle-center",
        "description": "Reduced learning rate and more layers",
        "createdBy": "createImpulse",
        "createdAt": "2024-12-21T12:12:43.335Z",
        "datasetSubset": {
          "subsetModulo": 0,
          "subsetSeed": 0
        }
      }
    ],
    "dspBlocks": [
      {
        "id": 0,
        "type": "spectral-analysis",
        "name": "Spectral features",
        "axes": [
          "accX"
        ],
        "title": "Spectral Analysis",
        "valuesPerAxis": 11,
        "input": 1,
        "description": "Reduced learning rate and more layers",
        "createdBy": "createImpulse",
        "createdAt": "2024-12-21T12:12:43.335Z",
        "implementationVersion": 0,
        "organization": {
          "id": 0,
          "dspId": 0
        },
        "customUrl": "text",
        "namedAxes": [
          {
            "name": "text",
            "description": "text",
            "required": false,
            "selectedAxis": "text"
          }
        ]
      }
    ],
    "learnBlocks": [
      {
        "id": 0,
        "type": "anomaly",
        "name": "NN Classifier",
        "dsp": [
          27
        ],
        "title": "Classification (Keras)",
        "description": "Reduced learning rate and more layers",
        "createdBy": "createImpulse",
        "createdAt": "2024-12-21T12:12:43.335Z"
      }
    ]
  }
}