Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Edge Impulse Impulse API

The Impulse API from Edge Impulse — 13 operation(s) for impulse.

Edge Impulse Impulse API is one of 34 APIs that Edge Impulse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Impulse. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 15 operations across 13 paths, and defines 63 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://studio.edgeimpulse.com/v1.

15 operations 13 paths 63 schemas 1 DELETE6 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://studio.edgeimpulse.com/v1
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Edge Impulse Impulse API declares 3 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuthentication). An API key is passed in the cookie as jwt (JWTAuthentication). An API key is passed in the header as x-jwt-token (JWTHttpHeaderAuthentication). By default, every request must be authenticated.

Paths & Operations 15

Across 13 paths, the API surfaces 15 operations — 1 DELETE, 6 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Impulse 15
GET
/api/{projectId}/impulse
Get impulse
getImpulse 2 params → 200
POST
/api/{projectId}/impulse
Create impulse
createImpulse 2 params body → 200
DELETE
/api/{projectId}/impulse
Delete impulse
deleteImpulse 2 params → 200
POST
/api/{projectId}/impulse/new
Create new empty impulse
createNewEmptyImpulse 1 param → 200
POST
/api/{projectId}/impulse/update
Update impulse
updateImpulse 2 params body → 200
GET
/api/{projectId}/impulse/all
Get impulse including disabled blocks
getImpulseAll 2 params → 200
POST
/api/{projectId}/impulse/get-new-block-id
Get new block ID
getNewBlockId 1 param → 200
GET
/api/{projectId}/impulse/blocks
Get impulse blocks
getImpulseBlocks 1 param → 200
POST
/api/{projectId}/verify-dsp-block/url
Verify custom DSP block
verifyDspBlockUrl 1 param body → 200
GET
/api/{projectId}/impulses
Get all impulses
getAllImpulses 1 param → 200
GET
/api/{projectId}/impulses-detailed
Get all impulses (incl. metrics)
getAllDetailedImpulses 1 param → 200
GET
/api/{projectId}/download-impulses-detailed
Download all impulses (incl. metrics), as JSON or CSV.
downloadDetailedImpulses 2 params → 200
POST
/api/{projectId}/impulse/legacy-set-impulse
Set legacy impulse
setLegacyImpulseStateInternal 1 param body → 200
POST
/api/{projectId}/impulse/{impulseId}/clone/structure
Clone impulse (structure)
cloneImpulseStructure 2 params body → 200
POST
/api/{projectId}/impulse/{impulseId}/clone/complete
Clone impulse (complete)
cloneImpulseComplete 2 params body → 200

Schemas 63

The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are KerasConfig (31 properties), TransferLearningModel (20 properties), ImpulseInputBlock (18 properties), DSPGroupItem (16 properties). Each schema is shown below with its type and property counts.

VerifyDspBlockUrlRequest
object
1 property 1 required
BlockDisplayCategory
string
Category to display this block in the UI.
KerasModelVariantEnum
string
AnomalyGmmMetadata
object
3 properties 3 required
BlockType
string
LearnBlock
object
11 properties 7 required
SetLegacyImpulseStateInternalRequest
object
3 properties 3 required
StartJobResponse
ImpulseInputBlock
object
18 properties 5 required
DetailedImpulse
object
9 properties 7 required
AnomalyConfig
object
7 properties 6 required
Impulse
object
5 properties 5 required
BlockParameters
Training parameters specific to the type of the learn block. Parameters may be adjusted depending on the model defined in the visual layers. Used for our built…
DetailedImpulseMetricCategory
string
AnomalyCapacity
string
Capacity level for visual anomaly detection. Determines which set of default configurations to use. The higher capacity, the higher number of (Gaussian) compon…
DSPConfig
object
3 properties 1 required
DSPMetadata
object
14 properties 11 required
GetNewBlockIdResponse
KerasCustomMetric
object
2 properties 2 required
ImpulseDspBlock
object
14 properties 7 required
AdditionalMetric
object
5 properties 3 required
PublicProjectTierAvailability
string
For public blocks, this indicates the project tiers for which this block is available.
CreateNewEmptyImpulseResponse
DetailedImpulseMetric
object
9 properties 5 required
ImpulseLearnBlock
object
8 properties 6 required
ModelEngineShortEnum
string
GetImpulseBlocksResponse
CreateImpulseResponse
DependencyData
object
4 properties 4 required
AnomalyModelMetadata
object
10 properties 5 required
KerasVisualLayerType
string
DSPBlock
object
12 properties 9 required
ObjectDetectionLastLayer
string
DSPGroup
object
2 properties 2 required
DspPerformance
object
3 properties 2 required
KerasVisualLayer
object
8 properties 1 required
ImageInputScaling
string
Normalization that is applied to images. If this is not set then 0..1 is used. "0..1" gives you non-normalized pixels between 0 and 1. "-1..1" gives you non-no…
DSPInfo
object
15 properties 10 required
BlockParamsVisualAnomalyGmm
object
1 property
KerasConfig
object
31 properties 18 required
GetImpulseResponse
GetAllImpulsesResponse
InputBlock
object
7 properties 7 required
GetAllDetailedImpulsesResponse
TransferLearningModel
object
20 properties 8 required
UpdateImpulseRequest
object
2 properties
KerasModelMetadataMetrics
object
13 properties 8 required
CloneImpulseRequest
object
1 property 1 required
VerifyDspBlockUrlResponse
BlockParamsVisualAnomalyPatchcore
object
5 properties
DetailedImpulseMetricFilteringType
object
2 properties 2 required
DSPGroupItem
object
16 properties 7 required
ModelPrediction
object
8 properties 4 required
AkidaEdgeLearningConfig
object
3 properties 1 required
DSPNamedAxis
object
3 properties 3 required
CreateImpulseRequest
object
4 properties 3 required
AugmentationPolicySpectrogram
object
5 properties 1 required
KerasModelTypeEnum
string
KerasModelMetadata
object
11 properties 10 required
KerasModelLayer
object
2 properties 2 required
LearnBlockType
string
The type of learning block (anomaly, keras, keras-transfer-image, keras-transfer-kws, keras-object-detection, keras-regression). Each behaves differently.
GenericApiResponse
object
2 properties 1 required
AugmentationPolicyImageEnum
string
The data augmentation policy to use with image input

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edge-impulse-impulse-api-openapi.yml Raw ↑

Other APIs Edge Impulse publishes across the network.

Edge Impulse Admin API
Edge Impulse Auth API
Edge Impulse Canary API
Edge Impulse CDN API
Edge Impulse Classify API
Edge Impulse Deployment API
Edge Impulse Devices API
Edge Impulse DSP API
Edge Impulse EmailVerification API
Edge Impulse Export API
Edge Impulse FeatureFlags API
Edge Impulse Health API