Create impulse

Create impulse

post

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

Authorizations
Path parameters
projectIdintegerRequired

Project ID

Query parameters
impulseIdintegerOptional

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

Body
namestringOptional

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

Responses
200
OK
application/json
Responseall of
post
POST /v1/api/{projectId}/impulse HTTP/1.1
Host: studio.edgeimpulse.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 998

{
  "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-06-21T06:27:02.798Z",
      "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-06-21T06:27:02.798Z",
      "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-06-21T06:27:02.798Z"
    }
  ]
}
200

OK

{
  "success": true,
  "error": "text",
  "id": 1
}

Last updated

Was this helpful?