EDedgeimpulse
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.

post/api/{projectId}/impulse

Request

Path parameters

projectIdinteger required

Project ID

Query parameters

impulseIdinteger

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

Request body

namestring

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

type'default' | 'BYOM' | 'VLM' | 'no_training_data'

Specifies the type of impulse. Options include: - default: Standard Edge Impulse pipeline. - BYOM: Impulse that includes a pretrained model. - VLM: Impulse created as part of a Vision Learning Model (VLM) workflow. - no_training_data: Model that trains without providing training data (e.g. model trained in simulation without external inputs)

datasetVersionIdinteger

EXPERIMENTAL. Lock an impulse to an immutable snapshot of a dataset. Feature generation, model training, and deployment from this impulse will always use that snapshot, ensuring reproducible results. If omitted, your current mutable dataset is used instead which doesn't provide the same reproducibility guarantees. This property is experimental, is only supported when the dataset versioning experiment is enabled, and may change in the future.

Example request

{
  "inputBlocks": [
    {
      "name": "Time series",
      "title": "Time series",
      "axes": [
        "accX"
      ],
      "windowSizeMs": 2004,
      "frequencyHz": 60,
      "imageWidth": 28,
      "imageHeight": 28,
      "resizeMode": "squash",
      "resizeMethod": "squash",
      "cropAnchor": "middle-center",
      "createdBy": "createImpulse"
    }
  ],
  "dspBlocks": [
    {
      "type": "spectral-analysis",
      "name": "Spectral features",
      "axes": [
        "accX"
      ],
      "title": "Spectral Analysis",
      "valuesPerAxis": 11,
      "input": 1,
      "createdBy": "createImpulse"
    }
  ],
  "learnBlocks": [
    {
      "name": "NN Classifier",
      "dsp": [
        27
      ],
      "title": "Classification (Keras)",
      "createdBy": "createImpulse"
    }
  ],
  "postProcessingBlocks": [
    {
      "name": "Object tracking",
      "title": "Object tracking",
      "createdBy": "createImpulse"
    }
  ]
}

Response

OK

successboolean required

Whether the operation succeeded

errorstring

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

idinteger required

ID of the new impulse

Changes

No recorded changes to this operation across all 1 revision of this API.