How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Edge Impulse Learn API

The Learn API from Edge Impulse — 21 operation(s) for learn.

Edge Impulse Learn API is one of 36 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 23 operations across 21 paths, and defines 63 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.

23 operations 21 paths 63 schemas 15 GET8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 Learn 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 23

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

Learn 23
GET
/api/{projectId}/training/{learnId}/x
Download data
getLearnXData 2 params → 200
GET
/api/{projectId}/training/{learnId}/y
Download labels
getLearnYData 2 params → 200
GET
/api/{projectId}/training/anomaly/{learnId}
Anomaly information
getAnomaly 2 params → 200
POST
/api/{projectId}/training/anomaly/{learnId}
Anomaly settings
setAnomaly 2 params body → 200
GET
/api/{projectId}/training/anomaly/{learnId}/metadata
Anomaly metadata
getAnomalyMetadata 2 params → 200
GET
/api/{projectId}/training/anomaly/{learnId}/gmm/metadata
Anomaly GMM metadata
getGmmMetadata 2 params → 200
GET
/api/{projectId}/training/keras/{learnId}
Keras information
getKeras 2 params → 200
POST
/api/{projectId}/training/keras/{learnId}
Keras settings
setKeras 2 params body → 200
GET
/api/{projectId}/training/keras/{learnId}/metadata
Keras metadata
getKerasMetadata 3 params → 200
GET
/api/{projectId}/training/keras/{learnId}/data-explorer/features
Get data explorer features
getKerasDataExplorerFeatures 2 params → 200
POST
/api/{projectId}/training/keras/{learnId}/files
Upload Keras files
uploadKerasFiles 2 params body → 200
POST
/api/{projectId}/training/keras/{learnId}/addFiles
Add Keras files
addKerasFiles 2 params body → 200
GET
/api/{projectId}/training/keras/{learnId}/download-export
Download Keras export
downloadKerasExport 2 params → 200
GET
/api/{projectId}/training/keras/{learnId}/download-data
Download Keras data export
downloadKerasData 2 params → 200
GET
/api/{projectId}/learn-data/{learnId}/model/{modelDownloadId}
Download trained model
downloadLearnModel 3 params → 200
GET
/api/{projectId}/training/anomaly/{learnId}/features/get-graph
Trained features
anomalyTrainedFeatures 4 params → 200
GET
/api/{projectId}/training/anomaly/{learnId}/features/get-graph/classification/{sampleId}
Trained features for sample
anomalyTrainedFeaturesPerSample 3 params → 200
GET
/api/{projectId}/pretrained-model
Get pretrained model
getPretrainedModelInfo 2 params → 200
POST
/api/{projectId}/pretrained-model/upload
Upload a pretrained model
uploadPretrainedModel 2 params body → 200
POST
/api/{projectId}/pretrained-model/save
Save parameters for pretrained model
savePretrainedModelParameters 2 params body → 200
POST
/api/{projectId}/pretrained-model/test
Test pretrained model
testPretrainedModel 2 params body → 200
POST
/api/{projectId}/pretrained-model/profile
Profile pretrained model
profilePretrainedModel 2 params → 200
GET
/api/{projectId}/pretrained-model/download/{pretrainedModelDownloadType}
Download pretrained model
downloadPretrainedModel 3 params → 200

Schemas 63

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

DependencyData
object
4 properties 4 required
AnomalyConfig
object
7 properties 6 required
ProfileModelTableMpu
object
4 properties 2 required
AnomalyTrainedFeaturesResponse
AnomalyGmmMetadata
object
3 properties 3 required
AdditionalMetric
object
5 properties 3 required
PretrainedModelTensor
object
5 properties 3 required
ObjectDetectionLastLayer
string
BlockParamsVisualAnomalyPatchcore
object
5 properties
KerasResponse
AddKerasFilesRequest
object
1 property 1 required
TransferLearningModel
object
20 properties 8 required
BlockDisplayCategory
string
Category to display this block in the UI.
KerasCustomMetric
object
2 properties 2 required
AugmentationPolicySpectrogram
object
5 properties 1 required
AkidaEdgeLearningConfig
object
3 properties 1 required
LearnBlockType
string
The type of learning block (anomaly, keras, keras-transfer-image, keras-transfer-kws, keras-object-detection, keras-regression). Each behaves differently.
KerasModelMetadataMetrics
object
13 properties 8 required
DeployPretrainedModelModelClassification
object
2 properties 2 required
KerasModelMetadataResponse
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…
TestPretrainedModelRequest
object
2 properties 2 required
KerasVisualLayerType
string
SavePretrainedModelRequest
object
2 properties 2 required
GetDataExplorerFeaturesResponse
DSPGroupItem
object
16 properties 7 required
DeployPretrainedModelInputAudio
object
2 properties 2 required
ProfileModelInfoMemoryDetails
object
3 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
KerasModelVariantEnum
string
ModelPrediction
object
8 properties 4 required
AnomalyConfigResponse
SetKerasParameterRequest
object
Only fields defined in this object are set
24 properties
BlockParamsVisualAnomalyGmm
object
1 property
BlockType
string
KerasModelMetadata
object
11 properties 10 required
AnomalyModelMetadata
object
10 properties 5 required
KerasModelLayer
object
2 properties 2 required
ProfileModelInfo
object
6 properties 3 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…
StartJobResponse
BoundingBoxWithScore
object
This has the ratio for x/y/w/h (so 0..1)
6 properties 6 required
GetPretrainedModelResponse
KerasVisualLayer
object
8 properties 1 required
ProfileModelTableMcu
object
5 properties 2 required
KerasModelTypeEnum
string
ModelEngineShortEnum
string
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…
UploadKerasFilesRequest
object
1 property 1 required
GenericApiResponse
object
2 properties 1 required
DeployPretrainedModelInputOther
object
1 property 1 required
DeployPretrainedModelInputImage
object
2 properties 1 required
DeployPretrainedModelInputTimeSeries
object
3 properties 3 required
UploadPretrainedModelRequest
object
5 properties 3 required
SetAnomalyParameterRequest
object
Only fields defined in this object are set
1 property
TestPretrainedModelResponse
DeployPretrainedModelModelRegression
object
1 property 1 required
ImpulseInputBlock
object
18 properties 5 required
KerasConfig
object
31 properties 18 required
DeployPretrainedModelModelObjectDetection
object
4 properties 4 required
AugmentationPolicyImageEnum
string
The data augmentation policy to use with image input
AnomalyGmmMetadataResponse
AnomalyModelMetadataResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edge-impulse-learn-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
Where this information came from

This is an independent, third-party profile of Edge Impulse Learn API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.