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

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

Edge Impulse DSP API is one of 38 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 51 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.

19 operations 18 paths 51 schemas 14 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, OAuth 2.0
Resource Areas
1

Authentication & Security 4

Edge Impulse DSP API declares 4 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). It supports OAuth 2.0 (OAuth2) using the authorizationCode, implicit, password and clientCredentials flows, exposing 3 scopes.

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 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are Sample_2 (46 properties), Sample (41 properties), DSPGroupItem_2 (22 properties), DSPMetadata_2 (19 properties). Each schema is shown below with its type and property counts.

DspPerformance
object
3 properties 2 required
StartJobResponse
DspAutotunerResults
DSPConfigResponse
DSPGroup
object
2 properties 2 required
Sensor
object
2 properties 2 required
DspSampleFeaturesResponse
RawSampleData
object
3 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
DspRunRequestWithFeatures
object
4 properties 4 required
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
RawSamplePayload
object
Sensor readings and metadata
6 properties 3 required
DspFeatureImportanceResponse
DSPMetadataResponse
Sample
object
41 properties 25 required
DspTrainedFeaturesResponse
DSPMetadata
object
14 properties 11 required
GenericApiResponse
object
2 properties 1 required
DspRunRequestWithoutFeatures
object
2 properties 2 required
DSPConfigRequest
object
1 property 1 required
DSPConfig
object
3 properties 1 required
DSPGroupItem
object
16 properties 7 required
DspFeatureLabelsResponse
DspRunResponseWithSample
DspRunRequestWithoutFeaturesReadOnly
object
1 property 1 required
DspRunGraph
object
14 properties 2 required
DSPInfo
object
15 properties 10 required
GetSampleResponse
DspRunResponse
DspPerformanceAllVariantsResponse
SampleLabelMapLabels
Structured sample labels in the form of a key-value map. This property is optional and only defined for samples with key-value labels.
Sensor_2
object
3 properties 3 required
RawSampleData_2
object
3 properties 3 required
StructuredLabel_2
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'…
4 properties 3 required
ProjectLabelingMethod
string
RawSamplePayload_2
object
Sensor readings and metadata
8 properties 5 required
Sample_2
object
46 properties 26 required
DspTrainedFeaturesResponse_2
GetSampleDspResponse
DSPMetadata_2
object
19 properties 12 required
LastUpdatedByUser
object
The user who last updated a sample.
2 properties 2 required
SampleDatastream
object
8 properties 7 required
DSPGroupItem_2
object
22 properties 8 required
DspRunResponseWithSample_2
LastUpdatedByDatasetVersionRestore
object
The dataset restore that last updated a sample.
4 properties 3 required
LastUpdatedByProjectApiKey
object
The project API key that last updated a sample.
2 properties 2 required
DSPInfo_2
object
17 properties 12 required
SampleKeyValueLabels
object
2 properties 2 required
DSPNormalizeData
string
RawDataCategory
string
LastUpdatedByOAuthClient
object
The OAuth client that last updated a sample, and the user it is acting on behalf of.
3 properties 2 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 Export API
Edge Impulse Health API
Edge Impulse API
Edge Impulse Jobs API
Edge Impulse Learn API
Where this information came from

This is an independent, third-party profile of Edge Impulse DSP 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.