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 Jobs API

The Jobs API from Edge Impulse — 42 operation(s) for jobs.

Edge Impulse Jobs 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 Jobs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 43 operations across 42 paths, and defines 55 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.

43 operations 42 paths 55 schemas 10 GET33 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 Jobs 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 43

Across 42 paths, the API surfaces 43 operations — 10 GET, 33 POST. Each is listed below with its method, path, parameters, and response codes.

Jobs 43
POST
/api/{projectId}/jobs/post-processing
Post-processing
startPostProcessingJob 2 params body → 200
POST
/api/{projectId}/jobs/data-explorer-features
Generate data explorer features
generateDataExplorerFeatures 1 param → 200
POST
/api/{projectId}/jobs/data-quality-metrics
Calculate data quality metrics. Only available for EI staff.
calculateDataQualityMetrics 1 param body → 200
POST
/api/{projectId}/jobs/retry-migrate-impulse
Retry impulse migration
retryImpulseMigration 1 param → 200
POST
/api/{projectId}/jobs/synthetic-data
Create synthetic data
createSyntheticDataJob 1 param body → 200
POST
/api/{projectId}/jobs/ai-actions/{actionId}/preview
Create preview AI Actions job
createPreviewAIActionsJob 2 params body → 200
POST
/api/{projectId}/jobs/ai-actions/{actionId}
Create AI Actions job
createAIActionsJob 2 params → 200
POST
/api/{projectId}/jobs/optimize
Optimize model
optimizeJob 2 params → 200
POST
/api/{projectId}/jobs/set-tuner-primary-job
Sets EON tuner primary model
setTunerPrimaryJob 2 params body → 200
GET
/api/{projectId}/jobs
List active jobs
listActiveJobs 2 params → 200
GET
/api/{projectId}/jobs/history
List finished jobs
listFinishedJobs 6 params → 200
GET
/api/{projectId}/jobs/all
List all jobs
listAllJobs 8 params → 200
GET
/api/{projectId}/jobs/summary
Job summary
getJobsSummary 3 params → 200
GET
/api/{projectId}/jobs/impulse-migration/status
Get impulse migration status
getImpulseMigrationJobStatus 1 param → 200
GET
/api/{projectId}/jobs/impulse-migration/stdout
Get impulse migration logs
getImpulseMigrationJobsLogs 3 params → 200
POST
/api/{projectId}/jobs/{jobId}/update
Update job
updateJob 2 params body → 200
GET
/api/{projectId}/jobs/{jobId}/status
Get job status
getJobStatus 2 params → 200
GET
/api/{projectId}/jobs/{jobId}/stdout
Get logs
getJobsLogs 4 params → 200
GET
/api/{projectId}/jobs/{jobId}/stdout/download
Download logs
downloadJobsLogs 4 params → 200
POST
/api/{projectId}/jobs/{jobId}/cancel
Cancel job
cancelJob 3 params → 200
POST
/api/{projectId}/jobs/generate-features
Generate features
generateFeaturesJob 1 param body → 200
POST
/api/{projectId}/jobs/autotune-dsp
Autotune DSP parameters
autotuneDspJob 1 param body → 200
POST
/api/{projectId}/jobs/train/keras/{learnId}
Train model (Keras)
trainKerasJob 2 params body → 200
POST
/api/{projectId}/jobs/train/anomaly/{learnId}
Train model (Anomaly)
trainAnomalyJob 2 params body → 200
POST
/api/{projectId}/jobs/train/keras/{learnId}/export
Export Keras block
exportKerasBlock 2 params → 200
POST
/api/{projectId}/jobs/train/keras/{learnId}/data
Export Keras block data
exportKerasBlockData 2 params body → 200
POST
/api/{projectId}/jobs/build-ondevice-model
Build on-device model
buildOnDeviceModelJob 3 params body → 200
POST
/api/{projectId}/jobs/build-ondevice-model/organization
Build organizational on-device model
buildOrganizationOnDeviceModelJob 2 params body → 200
POST
/api/{projectId}/jobs/export/original
Export original data
startOriginalExportJob 1 param body → 200
POST
/api/{projectId}/jobs/export/wav
Export data as WAV
startWavExportJob 1 param body → 200
POST
/api/{projectId}/jobs/retrain
Retrain
startRetrainJob 2 params → 200
POST
/api/{projectId}/jobs/classify
Classify
startClassifyJob 2 params body → 200
POST
/api/{projectId}/jobs/performance-calibration
Performance Calibration
startPerformanceCalibrationJob 2 params body → 200
POST
/api/{projectId}/jobs/evaluate
Evaluate
startEvaluateJob 2 params → 200
POST
/api/{projectId}/jobs/version
Version project
startVersionJob 1 param body → 200
POST
/api/{projectId}/jobs/restore
Restore project to version
startRestoreJob 1 param body → 200
POST
/api/{projectId}/jobs/restore/from-public
Restore project to public version
startRestoreJobFromPublic 1 param body → 200
POST
/api/{projectId}/jobs/versions/{versionId}/make-public
Make a version public
startMakeVersionPublicJob 2 params → 200
POST
/api/{projectId}/jobs/keywords-noise
Add keywords and noise
startKeywordsNoiseJob 1 param → 200
POST
/api/{projectId}/jobs/profile-tflite
Profile TFLite model
startProfileTfliteJob 1 param body → 200
POST
/api/{projectId}/jobs/deploy-pretrained-model
Deploy pretrained model
startDeployPretrainedModelJob 2 params body → 200
GET
/api/{projectId}/jobs/profile-tflite/{jobId}/result
Get TFLite profile result (GET)
getProfileTfliteJobResult 2 params → 200
POST
/api/{projectId}/jobs/profile-tflite/{jobId}/result
Get TFLite profile result (POST)
getProfileTfliteJobResultViaPostRequest 2 params → 200

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are SetKerasParameterRequest (24 properties), Job (12 properties), StartPostProcessingRequest (9 properties), KerasVisualLayer (8 properties). Each schema is shown below with its type and property counts.

LogStdoutResponse
CalculateDataQualityMetricsRequest
object
1 property
ProjectVersionRequest
object
4 properties 2 required
KerasModelVariantEnum
string
BuildOnDeviceModelRequest
object
2 properties 1 required
CreateSyntheticDataRequest
object
2 properties 2 required
CreatePreviewAIActionsJobRequest
object
3 properties 3 required
RestoreProjectRequest
object
3 properties 3 required
StartJobResponse
DeployPretrainedModelInputImage
object
2 properties 1 required
ExportOriginalDataRequest
object
2 properties 2 required
ListJobsResponse
ExportKerasBlockDataRequest
object
1 property
GetJobResponse
StartClassifyJobRequest
object
1 property
UpdateJobRequest
object
1 property
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…
ExportWavDataRequest
object
1 property 1 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…
JobSummaryResponse
DeployPretrainedModelInputOther
object
1 property 1 required
DeployPretrainedModelModelClassification
object
2 properties 2 required
ProfileTfLiteResponse
StartPerformanceCalibrationRequest
object
4 properties 1 required
BuildOrganizationOnDeviceModelRequest
object
3 properties 2 required
DeployPretrainedModelRequest
object
8 properties 4 required
ModelEngineShortEnum
string
DeploymentTargetEngine
string
Job
object
12 properties 5 required
ProfileModelInfoMemoryDetails
object
3 properties 3 required
StartPostProcessingRequest
object
9 properties 4 required
ProfileTfLiteRequest
object
2 properties 2 required
KerasVisualLayerType
string
RestoreProjectFromPublicRequest
object
1 property 1 required
ObjectDetectionLastLayer
string
DeployPretrainedModelModelRegression
object
1 property 1 required
ProfileModelInfo
object
6 properties 3 required
KerasVisualLayer
object
8 properties 1 required
DeployPretrainedModelInputAudio
object
2 properties 2 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…
BlockParamsVisualAnomalyGmm
object
1 property
AutotuneDspRequest
object
1 property 1 required
StartTrainingRequestAnomaly
object
4 properties 2 required
AIActionsConfigStep
object
2 properties 2 required
BlockParamsVisualAnomalyPatchcore
object
5 properties
SetKerasParameterRequest
object
Only fields defined in this object are set
24 properties
AkidaEdgeLearningConfig
object
3 properties 1 required
GenerateFeaturesRequest
object
3 properties 1 required
AugmentationPolicySpectrogram
object
5 properties 1 required
KerasModelTypeEnum
string
DeployPretrainedModelModelObjectDetection
object
4 properties 4 required
DeployPretrainedModelInputTimeSeries
object
3 properties 3 required
SetTunerPrimaryJobRequest
object
1 property
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-jobs-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