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

The Classify API from Edge Impulse — 10 operation(s) for classify.

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

This API exposes 10 operations across 10 paths, and defines 59 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.

10 operations 10 paths 59 schemas 6 GET4 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 Classify 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 10

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

Classify 10
GET
/api/{projectId}/classify/{sampleId}
Classify sample (deprecated)
classifySample 4 params → 200
POST
/api/{projectId}/classify/v2/{sampleId}
Classify sample
classifySampleV2 5 params → 200
POST
/api/{projectId}/classify/v2/{sampleId}/variants
Classify sample for the given set of variants
classifySampleForVariants 5 params → 200
GET
/api/{projectId}/classify/v2/{sampleId}/raw-data/{windowIndex}
Get a window of raw sample features from cache, after a live classification job…
getSampleWindowFromCache 4 params → 200
GET
/api/{projectId}/classify/all/result
Classify job result
getClassifyJobResult 4 params → 200
GET
/api/{projectId}/classify/all/result/page
Single page of a classify job result
getClassifyJobResultPage 5 params → 200
GET
/api/{projectId}/classify/all/metrics
Get metrics for all available model variants
getClassifyMetricsAllVariants 2 params → 200
GET
/api/{projectId}/classify/anomaly-gmm/{blockId}/{sampleId}
Classify sample by learn block
classifySampleByLearnBlock 3 params → 200
POST
/api/{projectId}/classify/anomaly-gmm/v2/{blockId}/{sampleId}
Classify sample by learn block
classifySampleByLearnBlockV2 4 params → 200
POST
/api/{projectId}/classify/image
Classify an image
classifyImage 2 params body → 200

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are Sample_2 (46 properties), Sample (41 properties), ClassifySampleResponseClassification_2 (16 properties), ModelPrediction_2 (10 properties). Each schema is shown below with its type and property counts.

AnomalyResult
object
4 properties
StartJobResponse
BoundingBoxWithScore
object
This has the ratio for x/y/w/h (so 0..1)
6 properties 6 required
UploadImageRequest
object
1 property 1 required
LearnBlockType
string
The type of learning block (anomaly, keras, keras-transfer-image, keras-transfer-kws, keras-object-detection, keras-regression). Each behaves differently.
AdditionalMetric
object
5 properties 3 required
Sensor
object
2 properties 2 required
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
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
Sample
object
41 properties 25 required
GenericApiResponse
object
2 properties 1 required
ClassifySampleResponse
ClassifyJobResponsePage
ClassifySampleResponseMultipleVariants
ClassifySampleResponseClassification
object
8 properties 4 required
ModelPrediction
object
8 properties 4 required
ClassifySampleResponseVariantResults
object
2 properties 2 required
ImpulseLearnBlock
object
8 properties 6 required
StructuredClassifyResult
object
8 properties 6 required
MetricsForModelVariant
object
2 properties 1 required
KerasModelVariantEnum
string
ObjectDetectionLastLayer
string
ClassifyJobResponse
ModelResult
object
3 properties 3 required
GetSampleResponse
TestPretrainedModelResponse
MetricsAllVariantsResponse
ClassifySampleResponseClassificationDetails
object
5 properties
LearnBlockType_2
string
The type of learning block (anomaly, keras, keras-transfer-image, keras-transfer-kws, keras-object-detection, keras-regression, keras-freeform). Each behaves d…
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
BlockThreshold
object
Configurable threshold for this block (e.g. minimum score before tagging as an anomaly, or the min. score to save bounding boxes)
7 properties 4 required
Sample_2
object
46 properties 26 required
GetSampleDspResponse
RawSampleDataStreamPayloads
object
1 property 1 required
LastUpdatedByUser
object
The user who last updated a sample.
2 properties 2 required
SampleDatastream
object
8 properties 7 required
ClassifySampleResponse_2
ClassifyJobResponsePage_2
ClassifySampleResponseMultipleVariants_2
ClassifySampleResponseClassification_2
object
16 properties 8 required
ModelPrediction_2
object
10 properties 4 required
LastUpdatedByDatasetVersionRestore
object
The dataset restore that last updated a sample.
4 properties 3 required
RawSampleDataWithDataStreamPayloads
LastUpdatedByProjectApiKey
object
The project API key that last updated a sample.
2 properties 2 required
ImpulseLearnBlock_2
object
8 properties 5 required
ExperimentalImpulseSpecificGpuTrainingProcessor
string
EXPERIMENTAL: Training processor for the impulse-specific-gpu rollout. This field is currently gated by a project experiment and may change in future API versi…
SampleKeyValueLabels
object
2 properties 2 required
ObjectDetectionLastLayer_2
string
ClassifyJobResponse_2
RawDataCategory
string
TestPretrainedModelResponse_2
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-classify-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 Deployment API
Edge Impulse Devices API
Edge Impulse DSP 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 Classify 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.