Edge Impulse Learn API is one of 38 APIs that Edge Impulse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Learn. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
26 operations
across 24 paths,
and defines 103 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://studio.edgeimpulse.com/v1.
The identity and technical contract details declared by the specification.
BlockParamsVisualAnomalyGmm
object
1 property
TransferLearningModel
object
20 properties
8 required
AnomalyModelMetadataResponse
BoundingBoxWithScore
object
This has the ratio for x/y/w/h (so 0..1)
6 properties
6 required
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…
AnomalyConfig
object
7 properties
6 required
GetDataExplorerFeaturesResponse
LearnBlockType
string
The type of learning block (anomaly, keras, keras-transfer-image, keras-transfer-kws, keras-object-detection, keras-regression). Each behaves differently.
KerasVisualLayerType
string
DeployPretrainedModelModelRegression
object
1 property
1 required
AdditionalMetric
object
5 properties
3 required
ProfileModelTableMpu
object
4 properties
2 required
KerasModelLayer
object
2 properties
2 required
KerasModelMetadata
object
11 properties
10 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…
DeployPretrainedModelInputOther
object
1 property
1 required
ModelEngineShortEnum
string
SetAnomalyParameterRequest
object
Only fields defined in this object are set
1 property
AnomalyGmmMetadata
object
3 properties
3 required
UploadKerasFilesRequest
object
1 property
1 required
AugmentationPolicySpectrogram
object
5 properties
1 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…
DeployPretrainedModelModelObjectDetection
object
4 properties
4 required
KerasConfig
object
31 properties
18 required
DeployPretrainedModelInputAudio
object
2 properties
2 required
AnomalyGmmMetadataResponse
GenericApiResponse
object
2 properties
1 required
TestPretrainedModelRequest
object
2 properties
2 required
KerasModelTypeEnum
string
GetPretrainedModelResponse
DeployPretrainedModelModelClassification
object
2 properties
2 required
DependencyData
object
4 properties
4 required
DSPGroupItem
object
16 properties
7 required
KerasVisualLayer
object
8 properties
1 required
UploadPretrainedModelRequest
object
5 properties
3 required
ProfileModelTable
object
Performance for a range of device types. Note that MPU is referred to as CPU in Studio, as MPU and CPU are treated equivalent for performance estimation.
6 properties
6 required
AugmentationPolicyImageEnum
string
The data augmentation policy to use with image input
ModelPrediction
object
8 properties
4 required
ProfileModelTableMcu
object
5 properties
2 required
KerasCustomMetric
object
2 properties
2 required
ImpulseInputBlock
object
18 properties
5 required
ProfileModelInfo
object
6 properties
3 required
SetKerasParameterRequest
object
Only fields defined in this object are set
24 properties
AkidaEdgeLearningConfig
object
3 properties
1 required
KerasModelVariantEnum
string
ObjectDetectionLastLayer
string
KerasModelMetadataResponse
KerasModelMetadataMetrics
object
13 properties
8 required
PretrainedModelTensor
object
5 properties
3 required
AnomalyTrainedFeaturesResponse
ProfileModelInfoMemoryDetails
object
3 properties
3 required
BlockDisplayCategory
string
Category to display this block in the UI.
DeployPretrainedModelInputTimeSeries
object
3 properties
3 required
AddKerasFilesRequest
object
1 property
1 required
BlockParamsVisualAnomalyPatchcore
object
5 properties
DeployPretrainedModelInputImage
object
2 properties
1 required
AnomalyModelMetadata
object
10 properties
5 required
SavePretrainedModelRequest
object
2 properties
2 required
TestPretrainedModelResponse
GetDataExplorerFeaturesResponse_2
ImageInputResizeMode
string
Input images are resized automatically before training and testing, to match the impulse input shape. This determines the resize mode used when the aspect rati…
KerasModelMetadataGraphSeries
object
2 properties
2 required
KerasModelMetadataGraph
object
6 properties
2 required
KerasConfig_2
object
31 properties
19 required
DependencyData_2
object
5 properties
5 required
ModelPrediction_2
object
10 properties
4 required
ImpulseInputBlock_2
object
19 properties
4 required
ThresholdValue
Current value of the threshold
ImpulseInputBlockDatasetSubset
object
Only generate features for samples where (sampleid + datasetSubsetSeed) % datasetSubset) == 0
2 properties
1 required
DeployPretrainedModelModelVisualAnomaly
object
2 properties
1 required
AnomalyModelMetadata_2
object
11 properties
7 required
AnomalyConfig_2
object
8 properties
7 required
KerasModelMetadata_2
object
13 properties
11 required
DeployPretrainedModelModelAnomaly
object
1 property
1 required
TestPretrainedModelImagesRequest
object
3 properties
3 required
DSPGroupItem_2
object
22 properties
8 required
ProfileModelInfo_2
object
10 properties
6 required
DeployPretrainedModelInputImage_2
object
3 properties
1 required
SavePretrainedModelRequest_2
object
2 properties
2 required
TransferLearningModel_2
object
23 properties
10 required
BlockThreshold
object
Configurable threshold for this block (e.g. minimum score before tagging as an anomaly, or the min. score to save bounding boxes)
7 properties
4 required
DeployPretrainedModelModelObjectDetection_2
object
5 properties
4 required
TestPretrainedModelRequest_2
object
2 properties
2 required
GetPretrainedModelResponse_2
ExperimentalImpulseSpecificGpuTrainingProcessor
string
EXPERIMENTAL: Training processor for the impulse-specific-gpu rollout. This field is currently gated by a project experiment and may change in future API versi…
BlockDisplayCategory_2
string
Category to display this block in the UI.
TestPretrainedModelResponse_2
LearnBlockType_2
string
The type of learning block (anomaly, keras, keras-transfer-image, keras-transfer-kws, keras-object-detection, keras-regression, keras-freeform). Each behaves d…
SetAnomalyParameterRequest_2
object
Only fields defined in this object are set
1 property
UploadPretrainedModelRequest_2
object
6 properties
3 required
SetKerasParameterRequest_2
object
Only fields defined in this object are set
25 properties
ObjectDetectionLastLayer_2
string
KerasModelMetadataMetrics_2
object
13 properties
8 required
DeployPretrainedModelModelFreeform
object
1 property
1 required
AnomalyResult
object
4 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Edge Impulse publishes across the network.
