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

The Optimization API from Edge Impulse — 15 operation(s) for optimization.

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

This API exposes 17 operations across 15 paths, and defines 39 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.

17 operations 15 paths 39 schemas 1 DELETE11 GET5 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 Optimization 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 17

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

Optimization 17
GET
/api/{projectId}/optimize/runs
List all tuner runs
listTunerRuns 1 param → 200
GET
/api/{projectId}/optimize/config
Get config
getConfig 1 param → 200
POST
/api/{projectId}/optimize/config
Update config
updateConfig 1 param body → 200
GET
/api/{projectId}/optimize/all-learn-blocks
Get all available learn blocks
getAllLearnBlocks 1 param → 200
GET
/api/{projectId}/optimize/window-settings
Get window settings
getWindowSettings 1 param → 200
POST
/api/{projectId}/optimize/score-trial
Score trial
scoreTrial 1 param body → 200
POST
/api/{projectId}/optimize/{jobId}/create-trial
Create trial
createTrial 2 params body → 200
POST
/api/{projectId}/optimize/{jobId}/complete-search
Complete EON tuner run
completeSearch 2 params body → 200
GET
/api/{projectId}/optimize/space
Search space
getSpace 1 param → 200
GET
/api/{projectId}/optimize/state
Retrieves the EON tuner state
getState 1 param → 200
DELETE
/api/{projectId}/optimize/state
Delete EON tuner state
deleteState 1 param → 200
GET
/api/{projectId}/optimize/dsp-parameters
Retrieves DSP block parameters
getDspParameters 3 params → 200
GET
/api/{projectId}/optimize/transfer-learning-models
Retrieves available transfer learning models
getTransferLearningModels 1 param → 200
GET
/api/{projectId}/optimize/trial/{trialId}/stdout
Get trial logs
getTrialLogs 2 params → 200
GET
/api/{projectId}/optimize//{jobId}/trial/{trialId}/end-trial
End EON tuner trial
endTrial 3 params → 200
GET
/api/{projectId}/optimize/{tunerCoordinatorJobId}/state
Retrieves EON tuner state for a run.
getTunerRunState 2 params → 200
POST
/api/{projectId}/optimize/{tunerCoordinatorJobId}
Update EON tuner state
updateTunerRun 2 params body → 200

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are OptimizeConfig (36 properties), TransferLearningModel (20 properties), TunerTrial (20 properties), DSPGroupItem (16 properties). Each schema is shown below with its type and property counts.

TunerCreateTrialLearnBlock
object
OptimizeStateResponse
BlockDisplayCategory
string
Category to display this block in the UI.
AdditionalMetric
object
5 properties 3 required
TransferLearningModel
object
20 properties 8 required
KerasCustomMetric
object
2 properties 2 required
LogStdoutResponse
LearnBlockType
string
The type of learning block (anomaly, keras, keras-transfer-image, keras-transfer-kws, keras-object-detection, keras-regression). Each behaves differently.
TunerCreateTrialImpulse
object
7 properties 3 required
WindowSettings
object
7 properties 7 required
KerasModelMetadataMetrics
object
13 properties 8 required
OptimizeConfigResponse
TunerRun
object
8 properties 5 required
DSPGroupItem
object
16 properties 7 required
TunerSpaceInputBlock
object
AllLearnBlocksResponse
TunerCompleteSearch
object
1 property 1 required
TunerCreateTrialInputBlock
object
ModelPrediction
object
8 properties 4 required
BlockType
string
OptimizeTransferLearningModelsResponse
TunerSpaceImpulse
object
4 properties 3 required
WindowSettingsResponse
TunerCreateTrialDSPBlock
object
OptimizeConfig
object
36 properties 2 required
OptimizeDSPParametersResponse
TunerTrialImpulse
object
3 properties 3 required
UpdateTunerRunRequest
object
1 property
TunerTrial
object
20 properties 5 required
ListTunerRunsResponse
OptimizeSpaceResponse
JobStatus
string
TunerSpaceDSPBlock
object
KerasModelTypeEnum
string
GenericApiResponse
object
2 properties 1 required
PublicProjectTierAvailability
string
For public blocks, this indicates the project tiers for which this block is available.
TunerSpaceLearnBlock
object
ScoreTrialResponse
KerasVisualLayerType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edge-impulse-optimization-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 Optimization 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.