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

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthentication

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.

inputBlocksobject[]required

Input Blocks that are part of this impulse

dspBlocksobject[]required

DSP Blocks that are part of this impulse

learnBlocksobject[]required

Learning Blocks that are part of this impulse

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://studio.edgeimpulse.com/v1/api/{projectId}/impulse' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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",
        "description": "Reduced learning rate and more layers",
        "createdBy": "createImpulse",
        "createdAt": "2025-03-27T17:01:22.200Z",
        "datasetSubset": {
          "subsetModulo": 1,
          "subsetSeed": 1
        }
      }
    ],
    "dspBlocks": [
      {
        "id": 1,
        "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": "2025-03-27T17:01:22.200Z",
        "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)",
        "description": "Reduced learning rate and more layers",
        "createdBy": "createImpulse",
        "createdAt": "2025-03-27T17:01:22.200Z"
      }
    ]
  }'

200

200

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

OK