Impulse

Update impulse

Update 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/update

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/:projectId/impulse/update/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

Project ID

Query parameters

impulseIdinteger

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

Request body

namestring

tagsstring[]

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)

Response

successboolean required

Whether the operation succeeded

errorstring

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

Changes

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