Create impulse

Create impulse

Sets the impulse for this project. If you specify impulseId then that impulse is created/updated, otherwise the default impulse is created/updated.

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

Path parameters

projectId*integer

Project ID

Query parameters

Body

application/json

namestring

Name for this impulse (optional). If no name is provided one is created based on your blocks.

inputBlocks*array of ImpulseInputBlock (object)

Input Blocks that are part of this impulse

dspBlocks*array of ImpulseDspBlock (object)

DSP Blocks that are part of this impulse

learnBlocks*array of ImpulseLearnBlock (object)

Learning Blocks that are part of this impulse

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

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

id*integer

ID of the new impulse

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/{projectId}/impulse', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "inputBlocks": [
        {
          "id": 0,
          "type": "time-series",
          "name": "Time series",
          "title": "Time series"
        }
      ],
      "dspBlocks": [
        {
          "id": 0,
          "type": "spectral-analysis",
          "name": "Spectral features",
          "axes": [
            "accX"
          ],
          "title": "Spectral Analysis",
          "implementationVersion": 0
        }
      ],
      "learnBlocks": [
        {
          "id": 0,
          "type": "anomaly",
          "name": "NN Classifier",
          "dsp": [
            27
          ],
          "title": "Classification (Keras)"
        }
      ]
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "error": "text",
  "id": 0
}