Skip to main content
POST
/
api
/
{projectId}
/
impulse
/
new
Create new empty impulse
curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/{projectId}/impulse/new \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "type": "default"
}
'
{
  "success": true,
  "id": 123,
  "redirectUrl": "<string>",
  "error": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
projectId
integer
required

Project ID

Body

application/json
​
type
enum<string>

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.

Available options:
default,
BYOM,
VLM

Response

200 - application/json

OK

​
success
boolean
required

Whether the operation succeeded

​
id
integer
required

ID of the new impulse

​
redirectUrl
string
required

Link to redirect the user to afterwards

​
error
string

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