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

The DSP API from Edge Impulse — 18 operation(s) for dsp.

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

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

19 operations 18 paths 30 schemas 14 GET5 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 DSP 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 19

Across 18 paths, the API surfaces 19 operations — 14 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

DSP 19
GET
/api/{projectId}/dsp/{dspId}
Get config
getDspConfig 2 params → 200
POST
/api/{projectId}/dsp/{dspId}
Set config
setDspConfig 2 params body → 200
POST
/api/{projectId}/dsp/{dspId}/clear
Clear DSP block
clearDspBlock 2 params → 200
GET
/api/{projectId}/dsp/{dspId}/metadata
Get metadata
getDspMetadata 3 params → 200
GET
/api/{projectId}/dsp/{dspId}/raw-data/{sampleId}
Get raw sample
getDspRawSample 4 params → 200
GET
/api/{projectId}/dsp/{dspId}/raw-data/{sampleId}/slice
Get raw sample (slice)
getDspSampleSlice 5 params → 200
POST
/api/{projectId}/dsp/{dspId}/raw-data/{sampleId}/slice/run
Get processed sample (slice)
runDspSampleSlice 5 params body → 200
GET
/api/{projectId}/dsp/{dspId}/raw-data/{sampleId}/slice/run/readonly
Get processed sample (slice)
runDspSampleSliceReadOnly 5 params → 200
GET
/api/{projectId}/dsp/{dspId}/features/labels
Feature labels
getDspFeatureLabels 2 params → 200
GET
/api/{projectId}/dsp/{dspId}/features/get-graph/{category}
Sample of trained features
dspSampleTrainedFeatures 6 params → 200
GET
/api/{projectId}/dsp/{dspId}/features/get-graph/classification/{sampleId}
Features for sample
dspGetFeaturesForSample 3 params → 200
GET
/api/{projectId}/dsp/{dspId}/features/importance
Feature importance
getDspFeatureImportance 2 params → 200
GET
/api/{projectId}/dsp-data/{dspId}/x/{category}
Download DSP data
downloadDspData 4 params → 200
GET
/api/{projectId}/dsp-data/{dspId}/y/{category}
Download DSP labels
downloadDspLabels 3 params → 200
GET
/api/{projectId}/dsp/{dspId}/get-autotuner-results
Get results from DSP autotuner
getAutotunerResults 2 params → 200
GET
/api/{projectId}/dsp-data/{dspId}/artifact/{key}
Download a DSP artifact
downloadDspArtifact 3 params → 200
POST
/api/{projectId}/dsp/{dspId}/profile
Profile custom DSP block
startProfileCustomDspBlock 2 params body → 200
GET
/api/{projectId}/dsp/{dspId}/performance
Get DSP block performance for all latency devices
getPerformanceAllVariants 2 params → 200
POST
/api/{projectId}/dsp/{dspId}/run
Get processed sample (from features array)
runDspOnFeaturesArray 2 params body → 200

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are Sample (41 properties), DSPGroupItem (16 properties), DSPInfo (15 properties), DspRunGraph (14 properties). Each schema is shown below with its type and property counts.

StartJobResponse
DSPConfigRequest
object
1 property 1 required
DspRunRequestWithFeatures
object
4 properties 4 required
DspFeatureImportanceResponse
DspRunRequestWithoutFeatures
object
2 properties 2 required
DSPConfig
object
3 properties 1 required
GetSampleResponse
DSPMetadata
object
14 properties 11 required
DspPerformanceAllVariantsResponse
Sensor
object
2 properties 2 required
DspRunResponse
DspRunResponseWithSample
BoundingBox
object
This has the absolute values for x/y/w/h (so 0..x (where x is the w/h of the image))
5 properties 5 required
RawSampleData
object
3 properties 3 required
DSPGroup
object
2 properties 2 required
DspTrainedFeaturesResponse
DspPerformance
object
3 properties 2 required
DspFeatureLabelsResponse
DSPMetadataResponse
DspRunGraph
object
14 properties 2 required
DSPInfo
object
15 properties 10 required
DspRunRequestWithoutFeaturesReadOnly
object
1 property 1 required
DSPGroupItem
object
16 properties 7 required
DSPConfigResponse
RawSamplePayload
object
Sensor readings and metadata
6 properties 3 required
StructuredLabel
object
A structured label contains a label, and the range for which this label is valid. endIndex is inclusive. E.g. { startIndex: 10, endIndex: 13, label: 'running'…
3 properties 3 required
Sample
object
41 properties 25 required
DspAutotunerResults
DspSampleFeaturesResponse
GenericApiResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

edge-impulse-dsp-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 EmailVerification API
Edge Impulse Export API
Edge Impulse FeatureFlags API
Edge Impulse Health API
Edge Impulse Impulse API