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

The PerformanceCalibration API from Edge Impulse — 9 operation(s) for performancecalibration.

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

This API exposes 11 operations across 9 paths, and defines 18 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.

11 operations 9 paths 18 schemas 1 DELETE7 GET3 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 PerformanceCalibration 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 11

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

PerformanceCalibration 11
GET
/api/{projectId}/performance-calibration/status
Get status
getPerformanceCalibrationStatus 2 params → 200
GET
/api/{projectId}/performance-calibration/ground-truth
Get ground truth
getPerformanceCalibrationGroundTruth 2 params → 200
GET
/api/{projectId}/performance-calibration/raw-result
Get raw result
getPerformanceCalibrationRawResult 2 params → 200
GET
/api/{projectId}/performance-calibration/parameter-sets
Get parameter sets
getPerformanceCalibrationParameterSets 2 params → 200
GET
/api/{projectId}/performance-calibration/parameters
Get parameters
getPerformanceCalibrationSavedParameters 2 params → 200
POST
/api/{projectId}/performance-calibration/parameters
Save performance calibration parameters
setPerformanceCalibrationSavedParameters 2 params body → 200
DELETE
/api/{projectId}/performance-calibration/parameters
Clear performance calibration parameters
deletePerformanceCalibrationSavedParameters 2 params → 200
GET
/api/{projectId}/performance-calibration/wav
Get WAV file
getWavFile 2 params → 200
POST
/api/{projectId}/performance-calibration/files
Upload Performance Calibration Audio files
uploadLabeledAudio 2 params body → 200
POST
/api/{projectId}/performance-calibration/clear
Clear Performance Calibration state
clearPerformanceCalibrationState 2 params → 200
GET
/api/{projectId}/post-processing/results
Get post processing results
getPostProcessingResults 2 params → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are PerformanceCalibrationParameterSet (7 properties), PerformanceCalibrationGroundTruth (6 properties), PerformanceCalibrationFalsePositive (5 properties), StartPerformanceCalibrationRequest (4 properties). Each schema is shown below with its type and property counts.

GetPerformanceCalibrationRawResultResponse
PerformanceCalibrationGroundTruth
object
6 properties 5 required
PerformanceCalibrationDetection
object
2 properties 2 required
PerformanceCalibrationRawDetection
object
3 properties 3 required
PerformanceCalibrationParameterSet
object
7 properties 7 required
PerformanceCalibrationParameters
object
3 properties 2 required
PerformanceCalibrationUploadLabeledAudioRequest
object
1 property 1 required
StartPerformanceCalibrationRequest
object
4 properties 1 required
PerformanceCalibrationParametersStandard
object
3 properties 3 required
GetPerformanceCalibrationParameterSetsResponse
GetPostProcessingResultsResponse
PerformanceCalibrationFalsePositive
object
5 properties 2 required
PerformanceCalibrationSaveParameterSetRequest
object
1 property 1 required
GetPerformanceCalibrationGroundTruthResponse
PerformanceCalibrationUploadLabeledAudioResponse
GetPerformanceCalibrationStatusResponse
GetPerformanceCalibrationParametersResponse
GenericApiResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edge-impulse-performancecalibration-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